代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator),本质上是一个返回函数的高阶数
一个简单例子
假设我们现在有个函数是这样的:
def now():
print "2015-12-26"
>> now.__name__
>> 'now' #函数名
我们现在希望增强下函数的功能,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这时候可以使用装饰器:
def log(func):
def wrapper(*args, **kw):
print 'call %s():' % func.__name__
return func(*args, **kw)
return wrapper
观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:
@log
def now():
print '2015-12-26'
此时调用now,出现:
>> now()
>> call now():
2015-12-26
把@log放到now()函数的定义处,相当于执行了语句:
now = log(now)
可以发现效果是一样的:
>> now = log(now)
>> now()
>> call now():
2015-12-26
此时now函数的name是:
>> now.__name__
>> 'wrapper'
现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即在log()函数中返回的wrapper()函数。
一个复杂的例子
如果此时我们希望传递点参数给wrapper怎么办?那就需要编写一个返回decorator的高阶函数,写出来会更复杂,比如下面的例子:
def log(text):
def decorator(func):
def wrapper(*args, **kw):
print '%s %s():' % (text, func.__name__)
return func(*args, **kw)
return wrapper
return decorator
这个3层嵌套的decorator用法如下:
@log('execute')
def now():
print '2015-12-26'
结果:
>> now()
>> execute now():
2015-12-26
此时的执行相当于:
now = log('execute')(now)
首先执行log(‘execute’),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数
此时now的名称变为:
>> now.__name__
>> 'wrapper'
返回的那个wrapper()函数名字就是’wrapper’,所以,需要把原始函数的name等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。
不需要编写wrapper.name = func.name这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:
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