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按行读取文件的实现方法【小文件和大文件读取】
Sep 19 Python
Python机器学习logistic回归代码解析
Jan 17 Python
python装饰器深入学习
Apr 06 Python
Python面向对象之类和对象实例详解
Dec 10 Python
在python环境下运用kafka对数据进行实时传输的方法
Dec 27 Python
python将pandas datarame保存为txt文件的实例
Feb 12 Python
基于Python2、Python3中reload()的不同用法介绍
Aug 12 Python
如何使用python进行pdf文件分割
Nov 11 Python
python 读取更新中的log 或其它文本方式
Dec 24 Python
详解字符串在Python内部是如何省内存的
Feb 03 Python
flask项目集成swagger的方法
Dec 09 Python
请求模块urllib之PYTHON爬虫的基本使用
Apr 08 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模拟asp.net的StringBuilder类实现方法
2015/08/08 PHP
php实现微信支付之企业付款
2018/05/30 PHP
Yii支持多域名cors原理的实现
2018/12/05 PHP
jquery表格内容筛选实现思路及代码
2013/04/16 Javascript
JQuery的AJAX实现文件下载的小例子
2013/05/15 Javascript
JavaScript中的lastIndexOf()方法使用详解
2015/06/06 Javascript
nodejs进阶(6)—连接MySQL数据库示例
2017/01/07 NodeJs
vue基于Vue2.0和高德地图的地图组件实例
2017/04/28 Javascript
JS实现汉字与Unicode码相互转换的方法详解
2017/04/28 Javascript
基于vue 实现token验证的实例代码
2017/12/14 Javascript
node中modules.exports与exports导出的区别
2018/06/08 Javascript
在vue中使用公共过滤器filter的方法
2018/06/26 Javascript
如何进行微信公众号开发的本地调试的方法
2019/06/16 Javascript
HTML+JavaScript实现扫雷小游戏
2019/09/30 Javascript
[01:04]不如跳舞!DOTA2新英雄玛尔斯的欢乐日常
2019/03/11 DOTA
python实现无证书加密解密实例
2014/10/27 Python
python OpenCV学习笔记之绘制直方图的方法
2018/02/08 Python
Python贪心算法实例小结
2018/04/22 Python
python退出命令是什么?详解python退出方法
2018/12/10 Python
python日期与时间戳的各种转换示例
2020/02/12 Python
django使用JWT保存用户登录信息
2020/04/22 Python
Python调用OpenCV实现图像平滑代码实例
2020/06/19 Python
Python 处理日期时间的Arrow库使用
2020/08/18 Python
html5音频_动力节点Java学院整理
2018/08/22 HTML / CSS
梵蒂冈和罗马卡:Omnia Card Pass
2018/02/10 全球购物
Rhone官方网站:男士运动服装、健身服装和高级运动服
2019/05/01 全球购物
工厂门卫岗位职责
2013/11/25 职场文书
申报职称专业技术个人的自我评价
2013/12/12 职场文书
大学生职业生涯规划书范文
2014/01/04 职场文书
家长对孩子评语
2014/01/30 职场文书
20年同学聚会邀请函
2014/02/04 职场文书
工商行政管理专业求职书
2014/05/23 职场文书
会计学习心得体会
2014/09/09 职场文书
党员作风建设整改方案
2014/10/27 职场文书
幼儿园国培研修日志
2015/11/13 职场文书
Docker 镜像介绍以及commit相关操作
2022/04/13 Servers