装饰器的作用总结起来就是不对原有代码进行更改的情况下可以动态地添加业务。好比天气冷了,我只要再穿一点就可以了,而不用把原来穿的东西换掉。
首先要理解在python中一切都是对象的概念,函数名只是一个标签而已,函数名可以用来彼此之间赋值。
对Python中函数理解深刻点就看这篇文章
>>> def now():
... print('2015-3-25')
...
>>> f = now
>>> f()
2015-3-25
现在,假设我们要增强now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。
本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
在这个嵌套函数中,log就是一个装饰器,它可以接受一个函数作为参数,它固定执行的一个功能是print('call %s():' % func.__name__)
,执行完成后在执行func函数的内容,可是这样读起来比较晦涩,所以使用Python中的@语法
@log
def now():
print('2015-3-25')
它的作用其实等同于now = log(now)
得到的输出结果是:
>>> now()
call now():
2015-3-25
所以我们如果需要对原有的业务程序进行扩充,就可以使用装饰器。
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本,我们可以给log加上一个参数。
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('2015-3-25')
#输出
>>> now()
execute now():
2015-3-25
其实也相当于是>>> now = log('execute')(now)
,我们来剖析上面的语句,首先执行log(‘execute’),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数。
以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有name等属性,但你去看经过decorator装饰之后的函数,它们的name已经从原来的’now’变成了’wrapper’:
>>> now.__name__
'wrapper'
因为返回的那个wrapper()函数名字就是’wrapper’,所以,需要把原始函数的name等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。
不需要编写wrapper.name = func.name这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:
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
一道应用题,做一个装饰器,接受一段程序,并且输出这个程序执行的时间
def metric(func):
@functools.wraps(func)#因为后面有用到程序的名字
def wrapper(*args,**kw):#*args,**kw可以接受所用类型的参数
start=time.time()
func(*args,**kw)
stop=time.time()-start
print('%s executed in %s ms' % (func.__name__, stop))
return func(*args,**kw)
return wrapper
装饰器也可以一个对多个,比如:
@z
@x
@f
def q():
print('sss')
它的含义就是q=z(x(f(q))
参考资料
廖雪峰老师的教程
知乎上一个用户的解答