Python装饰器(decorator)在实现的时候,有一些细节需要被注意。例如,被装饰后的函数其实已经是另外一个函数了(函数名等函数属性会发生改变)。这样有时候会对程序造成一些不便,例如笔者想对unittest框架中的一些函数添加自定义的decorator,添加后由于函数名和函数的doc发生了改变,对测试结果有一些影响。
所以,Python的functools包中提供了一个叫wraps的decorator来消除这样的副作用。写一个decorator的时候,最好在实现之前加上functools的wrap,它能保留原有函数的名称和docstring。例如:
test_decorator.py |
#-*-coding=utf-8-*-
fromfunctoolsimportwraps
defmy_decorator(func):
@wraps(func)
defwrapper(*args,**kwargs):
print('Callingdecoratedfunction...')
returnfunc(*args,**kwargs)
returnwrapper@my_decorator
defexample():
"""Docstring"""
print('Calledexamplefunction')
print(example.__name__,example.__doc__)
打印出:exampleDocstring