微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

举例讲解Python中装饰器的用法

这篇文章主要介绍了Python中装饰器的用法,是Python学习进阶当中的重要知识,需要的朋友可以参考下

由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用函数

>>> def Now(): ... print '2013-12-25' ... >>> f = Now >>> f() 2013-12-25

函数对象有一个__name__属性,可以拿到函数的名字:

>>> Now.__name__ 'Now' >>> f.__name__ 'Now'

现在,假设我们要增强Now()函数功能,比如,在函数调用前后自动打印日志,但又不希望修改Now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。

本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:

def log(func): def wrapper(*args, **kw): print 'call %s():' % func.__name__ return func(*args, **kw) return wrapper

观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:

@log def Now(): print '2013-12-25'

调用Now()函数,不仅会运行Now()函数本身,还会在运行Now()函数前打印一行日志:

>>> Now() call Now(): 2013-12-25

把@log放到Now()函数的定义处,相当于执行了语句:

Now = log(Now)

由于log()是一个decorator,返回一个函数,所以,原来的Now()函数仍然存在,只是现在同名的Now变量指向了新的函数,于是调用Now()将执行新函数,即在log()函数中返回的wrapper()函数

wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数

如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:

def log(text): def decorator(func): def wrapper(*args, **kw): print '%s %s():' % (text, func.__name__) return func(*args, **kw) return wrapper return decorator

这个3层嵌套的decorator用法如下:

@log('execute') def Now(): print '2013-12-25'

执行结果如下:

>>> Now() execute Now(): 2013-12-25

和两层嵌套的decorator相比,3层嵌套的效果是这样的:

>>> Now = log('execute')(Now)

我们来剖析上面的语句,首先执行log('execute'),返回的是decorator函数,再调用返回函数,参数是Now函数,返回值最终是wrapper函数

以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的'Now'变成了'wrapper':

>>> Now.__name__ 'wrapper'

因为返回的那个wrapper()函数名字就是'wrapper',所以,需要把原始函数__name__属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。

不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:

import functools def log(func): @functools.wraps(func) def wrapper(*args, **kw): print 'call %s():' % func.__name__ return func(*args, **kw) return wrapper

或者针对带参数的decorator:

import functools def log(text): def decorator(func): @functools.wraps(func) def wrapper(*args, **kw): print '%s %s():' % (text, func.__name__) return func(*args, **kw) return wrapper return decorator

import functools是导入functools模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。

小结

在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。

decorator可以增强函数功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。

请编写一个decorator,能在函数调用的前后打印出'begin call'和'end call'的日志。

再思考一下能否写出一个@log的decorator,使它既支持

@log def f(): pass

支持

@log('execute') def f(): pass

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐