装饰器练习,如何使用wraps
Python装饰器在实现的时候,有一些细节需要被注意。例如,被装饰后的函数其实已经是另外一个函数了(函数名等函数属性会发生改变)。这样有时候会对程序造成一些不便,例如笔者想对flask框架中的一些函数添加自定义的decorator,添加后由于函数名和函数的doc发生了改变,对测试结果有一些影响。
所以,Python的functools包中提供了一个叫wraps的decorator来消除这样的副作用。写一个decorator的时候,最好在实现之前加上functools的wrap,它能保留原有函数的名称和docstring。
下面是一个没加装饰器之前的例子(要求:在装饰中添加代码,让程序执行成功assert不报错)
import time
from functools import wraps
def record_time(func):
# TODO
pass
@record_time
def count_down(timeout):
time.sleep(timeout)
return 'ok'
assert count_down(1)=='ok'
assert count_down.__name__=='count_down'
添加了装饰器后的代码
import time
from functools import wraps
def record_time(func):
# TODO
@wraps(func)
def wrapper(*args,**kwargs):
return func(*args,**kwargs)
return wrapper
@record_time
def count_down(timeout):
time.sleep(timeout)
return 'ok'
assert count_down(1)=='ok'
assert count_down.__name__=='count_down'
其中@wraps()的作用就是使被装饰后的函数不改变其结构(如name,doc)
使assert count_down.__name__成立