Python中decorator使用实例


Posted in Python onApril 14, 2015

在我以前介绍 Python 2.4 特性的Blog中已经介绍过了decorator了,不过,那时是照猫画虎,现在再仔细描述一下它的使用。

关于decorator的详细介绍在 Python 2.4中的What's new中已经有介绍,大家可以看一下。

如何调用decorator

基本上调用decorator有两种形式

第一种:

@A

def f ():

这种形式是decorator不带参数的写法。最终 Python 会处理为:

f = A(f)

还可以扩展成:
@A

@B

@C

def f ():

   

最终 Python 会处理为:

f = A(B(C(f)))

注:文档上写的是@A @B @C的形式,但实际上是不行的,要写成多行。而且执行顺序是按函数调用顺序来的,先最下面的C,然后是B,然后是A。因此,如果decorator有顺序话,一定要注意:先要执行的放在最下面,最后执行的放在最上面。(应该不存在这种倒序的关系)

第二种:

@A(args)

def f ():

   

这种形式是decorator带参数的写法。那么 Python 会处理为:

def f(): 

_deco = A(args)

f = _deco(f)

可以看出, Python 会先执行A(args)得到一个decorator函数,然后再按与第一种一样的方式进行处理。

decorator函数的定义

每一个decorator都对应有相应的函数,它要对后面的函数进行处理,要么返回原来的函数对象,要么返回一个新的函数对象。请注意,decorator只用来处理函数和类方法。

第一种:
针对于第一种调用形式

def A(func):

    #处理func

    #如func.attr='decorated'

    return func

@A

def f(args):pass

上面是对func处理后,仍返回原函数对象。这个decorator函数的参数为要处理的函数。如果要返回一个新的函数,可以为:

def A(func):

    def new_func(args):

        #做一些额外的工作

        return func(args) #调用原函数继续进行处理

    return new_func

@A

def f(args):pass

要注意 new_func的定义形式要与待处理的函数相同,因此还可以写得通用一些,如:

def A(func):

    def new_func(*args, **argkw):

        #做一些额外的工作

        return func(*args, **argkw) #调用原函数继续进行处理

    return new_func

@A

def f(args):pass

可以看出,在A中定义了新的函数,然后A返回这个新的函数。在新函数中,先处理一些事情,比如对参数进行检查,或做一些其它的工作,然后再调原始的函数进行处理。这种模式可以看成,在调用函数前,通过使用decorator技术,可以在调用函数之前进行了一些处理。如果你想在调用函数之后进行一些处理,或者再进一步,在调用函数之后,根据函数的返回值进行一些处理可以写成这样:

def A(func):

    def new_func(*args, **argkw):

        result = func(*args, **argkw) #调用原函数继续进行处理

        if result:

            #做一些额外的工作

            return new_result

        else:

            return result

    return new_func

@A

def f(args):pass

第二种:
针对第二种调用形式

在文档上说,如果你的decorator在调用时使用了参数,那么你的decorator函数只会使用这些参数进行调用,因此你需要返回一个新的decorator函数,这样就与第一种形式一致了。

def A(arg):

    def _A(func):

        def new_func(args):

            #做一些额外的工作

            return func(args)

        return new_func

    return _A

@A(arg)

def f(args):pass

可以看出A(arg)返回了一个新的 decorator _A。

decorator的应用场景

不过我也一直在想,到底decorator的魔力是什么?适合在哪些场合呢?是否我需要使用它呢?

decorator的魔力就是它可以对所修饰的函数进行加工。那么这种加工是在不改变原来函数代码的情况下进行的。有点象我知道那么一点点的AOP(面向方面编程)的想法。

它适合的场合我能想到的列举出下:

1.象文档中所说,最初是为了使调用staticmethod和classmethod这样的方法更方便
2.在某些函数执行前做一些工作,如web开发中,许多函数在调用前需要先检查一下用户是否已经登录,然后才能调用
3.在某此函数执行后做一些工作,如调用完毕后,根据返回状态写日志
4.做参数检查

可能还有许多,你可以自由发挥想象

那么我需要用它吗?

我想那要看你了。不过,我想在某些情况下,使用decorator可以增加程序的灵活性,减少耦合度。比如前面所说的用户登录检查。的确可以写一个通用的登录检查函数,然后在每个函数中进行调用。但这样会造成函数不够灵活,而且增加了与其它函数之间的结合程度。如果用户登录检查功能有所修改,比如返回值的判断发生了变化,有可能每个用到它的函数都要修改。而使用decorator不会造成这一问题。同时使用decorator的语法也使得代码简单,清晰(一但你熟悉它的语法的话)。当然你不使用它是可以的。不过,这种函数之间相互结合的方式,更符合搭积木的要求,它可以把函数功能进一步分解,使得功能足够简单和单一。然后再通过decorator的机制灵活的把相关的函数串成一个串,这么一想,还真是不错。比如下面:

@A

@B

def account(args):pass

假设这是一个记帐处理函数,account只管记帐。但一个真正的记帐还有一些判断和处理,比如:B检查帐户状态,A记日志。这样的效果其实是先检查B、通过在A中的处理可以先执行account,然后再进行记日志的处理。象搭积木一样很方便,改起来也容易。甚至可以把account也写成decorator,而下面执行的函数是一个空函数。然后再通过配置文件等方法,将decorator的组合保存起来,就基本实现功能的组装化。是不是非常理想。

Python 带给人的创造力真是无穷啊!

Python 相关文章推荐
利用Python绘制MySQL数据图实现数据可视化
Mar 30 Python
详谈Python高阶函数与函数装饰器(推荐)
Sep 30 Python
python print 按逗号或空格分隔的方法
May 02 Python
python微信好友数据分析详解
Nov 19 Python
使用python3构建文件传输的方法
Feb 13 Python
Flask框架单例模式实现方法详解
Jul 31 Python
Flask项目中实现短信验证码和邮箱验证码功能
Dec 05 Python
Python如何省略括号方法详解
Mar 21 Python
python使用pyecharts库画地图数据可视化的实现
Mar 25 Python
Python+Kepler.gl轻松制作酷炫路径动画的实现示例
Jun 02 Python
Pytorch实现将模型的所有参数的梯度清0
Jun 24 Python
Python用Jira库来操作Jira
Dec 28 Python
用Python创建声明性迷你语言的教程
Apr 13 #Python
Python中的Numeric包和Numarray包使用教程
Apr 13 #Python
Python中一些自然语言工具的使用的入门教程
Apr 13 #Python
用Python的SimPy库简化复杂的编程模型的介绍
Apr 13 #Python
Python中用Decorator来简化元编程的教程
Apr 13 #Python
在Python的setuptools框架下生成egg的教程
Apr 13 #Python
简单介绍Python中的RSS处理
Apr 13 #Python
You might like
php ss7.5的数据调用 (笔记)
2010/03/08 PHP
PHP中获取变量的变量名的一段代码的bug分析
2011/07/07 PHP
如何判断php数组的维度
2013/06/10 PHP
php基于GD库画五星红旗的方法
2015/02/24 PHP
php获取网页上所有链接的方法
2015/04/03 PHP
深入解析PHP的Yii框架中的event事件机制
2016/03/17 PHP
深入理解PHP JSON数组与对象
2016/07/19 PHP
Zend Framework实现自定义过滤器的方法
2016/12/09 PHP
详解将数据从Laravel传送到vue的四种方式
2019/10/16 PHP
laravel5.6中的外键约束示例
2019/10/23 PHP
再谈javascript图片预加载技术(详细演示)
2011/03/12 Javascript
用nodejs访问ActiveX对象,以操作Access数据库为例。
2011/12/15 NodeJs
Vue.js路由组件vue-router使用方法详解
2016/12/02 Javascript
AngularJS Select(选择框)使用详解
2017/01/18 Javascript
js实现时间轴自动排列效果
2017/03/09 Javascript
利用vue组件自定义v-model实现一个Tab组件方法示例
2017/12/06 Javascript
Angular2实现组件交互的方法分析
2017/12/19 Javascript
浅谈react性能优化的方法
2018/09/05 Javascript
Vuejs中的watch实例详解(监听者)
2020/01/05 Javascript
python操作mysql中文显示乱码的解决方法
2014/10/11 Python
python sort、sorted高级排序技巧
2014/11/21 Python
python得到一个excel的全部sheet标签值方法
2018/12/10 Python
python 多线程对post请求服务器测试并发的方法
2019/06/13 Python
Python数据持久化存储实现方法分析
2019/12/21 Python
Pythonic版二分查找实现过程原理解析
2020/08/11 Python
介绍一下SQL Server里面的索引视图
2016/07/31 面试题
物业保安主管岗位职责
2013/12/25 职场文书
小学家长会邀请函
2014/01/23 职场文书
婚前协议书范本
2014/04/15 职场文书
大学毕业生管理学求职信
2014/09/01 职场文书
节约每一滴水演讲稿
2014/09/09 职场文书
2014年帮扶工作总结
2014/11/26 职场文书
2015年城管个人工作总结范文
2015/04/20 职场文书
低端且暴利的线上线下创业项目分享
2019/09/03 职场文书
JavaScript模拟实现网易云轮播效果
2022/04/04 Javascript
js面向对象编程OOP及函数式编程FP区别
2022/07/07 Javascript