python的函数修饰符(装饰器)
首先明确函数也是对象(python万物皆对象),而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。
例如
>>> def now(): ... print ("2013-12-25") ... >>> f = now #函数名可以赋给一个变量,根据变量+()就可以调用这个函数 >>> f() 2013-12-25
函数对象有一个__name__属性,可以获取函数的名字:
>>> now.__name__ 'now' >>> f.__name__ 'now'
现在,假设我们要扩展now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。本质上,decorator就是一个返回函数的高阶函数
创建函数修饰符的规则:
(1)修饰符是一个函数
(2)修饰符取被修饰函数为参数
(3)修饰符返回一个新函数
(4)修饰符维护被维护函数的签名
def log(func): def wrapper(*args, **kw): print ( "call %s()" % func.__name__) return func(*args, **kw) return wrapper @log #相当于执行了语句 now = log(now)@修饰符的功能就是把now当做参数传递给log,然后把log的返回值(wrapper)赋给now变量def now(): print ( "2013-12-25 ") >>> now() call now() 2013-12-25
这里的log()是一个decorator,是返回一个函数的高阶函数;原来的now()函数仍然存在,只是现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即wrapper()函数。
wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用(如果被修饰函数now不接受参数,wrapper可以无参);在wrapper()函数内,首先打印日志,再紧接着调用原始函数。
此时经过decorator装饰之后的函数,它们的__name__已经从原来的'now'变成了'wrapper':
>>> now.__name__ 'wrapper'
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,多一层包装。比如,要自定义log的文本:
2 def decorator(func): 3 def wrapper(*args , **kw): 4 print("%s %s()" % (text , func.__name__)) 5 return func(*args , **kw) 6 return wrapper 7 return decorator 8 9 @log('execute') #等价于now = log('execute')(now) log()返回一个函数名 10 def now(): 11 print("2013-12-25 ") 12 13 14 >>> now() 15 execute now() 16 2013-12-25
首先执行log('execute'),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数
以上两种decorator的定义都没有问题,但还差最后一步。因为函数也是对象,它有__name__等属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的'now'变成了'wrapper':
>>> now.__name__ 'wrapper'
所以,需要把原始函数的__name__等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。
不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:
import functools #导入functools模块def log(func): @functools.wraps(func) #py内置的functools.wraps 的修改函数属性的方法wrapsdef wrapper(*args, **kw): print ('call %s()' % func.__name__) return func(*args, **kw) return wrapper
或者带参数的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
》》只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。
functools模块提供的修改函数属性的方法wraps 进一步理解
def log(func): def wrapper(): print('log开始 ...') func() print('log结束 ...') return wrapper @log def test1(): print('test1 ..') def test2(): print('test2 ..') print(test1.__name__) print(test2.__name__) 运行结果: wrapper #test1.__name__改变了 test2
test1的函数名称变了,如果某些代码用到就会出问题,可以使用functools模块提供的修改函数属性的方法wraps,例如
from functools import wraps #可以写成import functools 后面改@functools.wraps(func) 发挥命名空间的意义 def log(func): @wraps(func) def wrapper(): print('log开始 ...') func() print('log结束 ...') return wrapper @log def test1(): print('test1 ..') def test2(): print('test2 ..') print(test1.__name__) print(test2.__name__) 运行结果: test1 test2
更多请看 https://www.cnblogs.com/gdjlc/p/11182441.html 条理更加清晰!!!
》》总结:
--Python的decorator可以用函数实现,也可以用类实现,decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。
--函数修饰符@的作用是为现有函数增加额外的功能,常用于插入日志、性能测试、事务处理等等