一、装饰器定义
在代码运行期间动态增加功能的方式,称之为 "装饰器"(Decorator)。本质上,Decorator 就是一个返回函数的高阶函数。
- >>> def log(func):
- ... def wrapper(*args, **kw):
- ... print('call %s:' % func.__name__)
- ... return func(*args, **kw)
- ... return wrapper
- ...
- >>> @log
- ... def now():
- ... print('2017-12-16')
- ...
- >>> now()
- call now:
- 2017-12-16
- >>>
观察上面的
,因为它是一个 decorator,所以接受一个函数作为参数,并返回一个函数。要借助 Python 的 @语法,把 decorator 置于函数的定义处。
- log
把
放到
- @log
函数的定义处,相当于执行了语句:
- now()
- 1 >>> now = log(now)
二、带传参的装饰器
- >>> def log(text):
- ... def decorator(func):
- ... def wrapper(*args, **kw):
- ... print('%s %s:' % (text, func.__name__))
- ... return func(*args, **kw)
- ... return wrapper
- ... return decorator
- ...
- >>> @log('execute')
- ... def now():
- ... print('2017-12-16')
- ...
- >>> now()
- execute now:
- 2017-12-16
和两层嵌套的 decorator 相比,3 层嵌套的效果是这样的:
- 1 >>> now = log('execute')(now)
三、functools.wraps
以上两种 decorator 的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有
等属性,但你去看经过 decorator 装饰之后的函数,它们的
- __name__
已经从原来的
- __name__
变成了
- 'now'
:
- 'wrapper'
- >>> now.__name__
- 'wrapper'
因为返回的那个
函数名字就是
- wrapper()
,所以,需要把原始函数的
- 'wrapper'
等属性复制到
- __name__
函数中,否则,有些依赖函数签名的代码执行就会出错。
- wrapper()
不需要编写
这样的代码,Python 内置的
- wrapper.__name__ = func.__name__
就是干这个事的,所以,一个完整的 decorator 的写法如下:
- functools.wraps
- import functools
- def log(func):
- @functools.wraps(func)
- def wrapper(*args, **kw):
- print('call %s():' % func.__name__)
- return func(*args, **kw)
- return wrapper
- 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
来源: http://www.bubuko.com/infodetail-2431560.html