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