在定义函数之后,希望扩展这些函数的功能,譬如在函数调用前后自动打印日志,但如果是一些通用的功能,修改每一个函数又会显得比较麻烦。最好的方法就是定义一个装饰器,给每个函数增加功能。这种在代码运行期间动态增加函数功能的方式,称为装饰器(Decorator)
原理
不带参数的装饰器
@a_decorator
def f(...):
...
#经过a_decorator后, 函数f就相当于以f为参数调用a_decorator返回结果。
f = a_decorator(f)
来分析这个式子, 可以看出至少要满足以下几个条件
1. 装饰器函数运行在函数定义的时候
2. 装饰器需要返回一个可执行的对象
3. 装饰器返回的可执行对象要兼容函数f的参数
初始函数
from datetime import datetime
def now():
print(datetime.now())
>>>now()
增加功能
def now():
print('run %s().' % now.__name__)
print(datetime.now())
print('run %s() finished.' % now.__name__)
>>>now()
def decorator(fun): #将函数作为参数传入
def wrapper(*args,**kw):
print('run %s().' % fun.__name__)
outcome = fun(*args,**kw)
print('run %s() finished.' % fun.__name__)
return outcome #将函数作为返回值返回
return wrapper
now = decorator(now)
now()
这是装饰器最直观的表示了,定义一个装饰器函数,然后将自己的函数传入,输出的新函数即添加了新功能。本质上来看,装饰器就是一个高阶函数。由于其接收参数为(*args,**kw),所以能够接受任何形式的调用。在wrapper函数内,调用传入的fun()函数之外,就可以定义新的功能。
__name__问题
>>>now()
run now().
2016-05-31 17:10:32.217998
run now() finished.
>>>now.__name__
'wrapper' #在这里名字应该为now,被改变了
调用完成之后,新的问题又出现了:函数的__name__属性因为使用装饰器改变了,有些依赖函数签名的代码执行就会出错。
python内置的functools.wraps能够将函数名称替换回来。一个完整的decorator写法如下:
>>> import functools
>>> def decorator(fun):
@functools.wraps(fun)
def wrapper(*args,**kw):
print('run %s().' % fun.__name__)
outcome = fun(*args,**kw)
print('run %s() finished.' % fun.__name__)
return outcome
return wrapper
>>> @decorator
def now():
print(datetime.now())
>>> now()
run now().2016-05-31 17:32:59.270645
run now() finished.
>>> now.__name__
'now'
那么,问题来了,我们能不能创建一个装饰器,能够传入参数,也可以不传入参数呢?
这需要对装饰器的运行过程有充分的了解,观察上面的两类装饰器,主要的区别在于:
没有参数的装饰器,最外层接收的是func函数,最终返回的函数是wrapper(*args,**kw),直接接收func函数参数
带参数的装饰器,最外层接收的是参数,而最终返回的函数是wrapper(func),接收func函数
那么,我们就可以通过判定最外层的函数接收的是func函数还是参数,来决定是有参数或者是无参数的装饰器,最终决定如何返回。尝试结果如下:
装饰器类
在Python中, 其实函数也是对象。 反过来, 对象其实也可以像函数一样调用, 只要在类的方法中实现__call__()方法。
__new__: 对象的创建,是一个静态方法,第一个参数是cls。(想想也是,不可能是self,对象还没创建,哪来的self)
(__new__方法在类定义中不是必须写的,如果没定义,默认会调用object.__new__去创建一个对象。如果定义了,就是override,可以custom创建对象的行为。聪明的读者可能想到,既然__new__可以custom对象的创建,那我在这里做一下手脚,每次创建对象都返回同一个,那不就是单例模式了吗)
__init__ : 对象的初始化, 是一个实例方法,第一个参数是self。
(__init__其实不是实例化一个类的时候第一个被调用的方法。当使用 Persion(name, age) 这样的表达式来实例化一个类时,最先被调用的方法 其实是 __new__ 方法。)
__call__ : 对象可call,注意不是类,是对象
(对象通过提供__call__(slef, [,*args [,**kwargs]])方法可以模拟函数的行为,如果一个对象x提供了该方法,就可以像函数一样使用它,也就是说x(arg1, arg2...) 等同于调用x.__call__(self, arg1, arg2) 。模拟函数的对象可以用于创建防函数(functor) 或代理(proxy).)
网友评论