【Python】functools.wraps定义函数装饰器
第一次见到functools.wraps是在 Flask Web开发 中,一直不明白怎么回事。
装饰器(decorator)是干嘛的?对于受到封装的原函数来说,装饰器能够在那个函数执行前或者执行后分别运行一些代码,使得可以再装饰器里面访问并修改原函数的参数以及返回值,以实现约束定义、调试程序、注册函数等目标。装饰器一般返回一个包装器(wrapper),而functools.wraps就是装饰包装器的装饰器。
先来看一个不使用functools.wraps的装饰器例子。
1 def tracer(func): 2 def wrapper(*args, **kwargs): 3 result = func(*args, **kwargs) 4 print('%s(%r,%r)->%r'%(func.__name__,args,kwargs,result)) 5 return result 6 return wrapper 7 8 @tracer 9 def fibonacci(n): 10 if n in (0,1): 11 return n 12 return (fibonacci(n-1)+fibonacci(n-2)) 13 14 15 fibonacci(3) 16 print(fibonacci) 17 print('help:') 18 help(fibonacci)
输出结果:
可以看到,装饰器完全可以正常工作。。。
但是,函数的名字变成装饰器中的包装器了!!!help内置函数也失效了
也就是说,原函数的属性失效了
如果想要保留原函数的属性,就可以用到functools.wraps了
1 from functools import wraps 2 def tracer(func): 3 @wraps(func) 4 def wrapper(*args, **kwargs): 5 result = func(*args, **kwargs) 6 print('%s(%r,%r)->%r'%(func.__name__,args,kwargs,result)) 7 return result 8 return wrapper 9 10 @tracer 11 def fibonacci(n): 12 if n in (0,1): 13 return n 14 return (fibonacci(n-1)+fibonacci(n-2)) 15 16 17 fibonacci(3) 18 print(fibonacci) 19 print('help:') 20 help(fibonacci)
输出结果:
参考资料:Effective Python,第6章 内置模块