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中的Numpy入门教程
Apr 26 Python
Python中itertools模块用法详解
Sep 25 Python
Flask入门教程实例:搭建一个静态博客
Mar 27 Python
修改Python的pyxmpp2中的主循环使其提高性能
Apr 24 Python
对python 数据处理中的LabelEncoder 和 OneHotEncoder详解
Jul 11 Python
python版本单链表实现代码
Sep 28 Python
详解python Todo清单实战
Nov 01 Python
如何安装2019Pycharm最新版本(详细教程)
Sep 26 Python
Python3将jpg转为pdf文件的方法示例
Dec 13 Python
使用keras实现Precise, Recall, F1-socre方式
Jun 15 Python
零基础学Python之前需要学c语言吗
Jul 21 Python
python 牛顿法实现逻辑回归(Logistic Regression)
Oct 15 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下使用以下代码连接并测试
2008/04/09 PHP
php检测iis环境是否支持htaccess的方法
2014/02/18 PHP
PHP FATAL ERROR: CALL TO UNDEFINED FUNCTION BCMUL()解决办法
2014/05/04 PHP
php实现购物车功能(以大苹果购物网为例)
2017/03/09 PHP
详解PHP中的序列化、反序列化操作
2017/03/21 PHP
thinkphp5.1框架中容器(Container)和门面(Facade)的实现方法分析
2019/08/05 PHP
基于jquery实现的移入页面上空文本框时,让它变为焦点,移出清除焦点
2011/07/26 Javascript
JS控件的生命周期介绍
2012/10/22 Javascript
jQuery筛选器children()案例详解(图文)
2013/02/17 Javascript
JavaScript中实现单体模式分享
2015/01/29 Javascript
AngularJS 中的Promise --- $q服务详解
2016/09/14 Javascript
Boostrap实现的登录界面实例代码
2016/10/09 Javascript
jquery对所有input type=text的控件赋值实现方法
2016/12/02 Javascript
js实现方块上下左右移动效果
2017/08/17 Javascript
通过 JS 判断页面是否有滚动条的实现方法
2018/04/05 Javascript
新手简单了解vue
2019/05/29 Javascript
js+springMVC 提交数组数据到后台的实例
2019/09/21 Javascript
微信公众号开发之微信支付代码记录的实现
2019/10/16 Javascript
JS实现关闭小广告特效
2021/01/29 Javascript
2分钟实现一个Vue实时直播系统的示例代码
2020/06/05 Javascript
[02:29]完美世界高校联赛上海赛区回顾
2015/12/15 DOTA
在Windows中设置Python环境变量的实例讲解
2018/04/28 Python
python爬虫框架scrapy实现模拟登录操作示例
2018/08/02 Python
python绘制简单彩虹图
2018/11/19 Python
Keras自定义实现带masking的meanpooling层方式
2020/06/16 Python
CSS3中几个新增加的盒模型属性使用教程
2016/03/01 HTML / CSS
中国酒类在线零售网站:酒仙网
2016/08/20 全球购物
《我为你骄傲》教学反思
2014/02/20 职场文书
微信营销策划方案
2014/02/24 职场文书
安全教育演讲稿
2014/05/09 职场文书
2014年教师党员公开承诺书
2014/05/28 职场文书
幼儿教师暑期培训方案
2014/08/27 职场文书
感恩老师演讲稿600字
2014/08/28 职场文书
党员自我评议个人对照检查材料
2014/09/16 职场文书
SQL中的三种去重方法小结
2021/11/01 SQL Server
讲解Python实例练习逆序输出字符串
2022/05/06 Python