本人近日初学python,在廖雪峰大大的网站上学习。该教程内容大纲是齐全的,但是在某些概念阐述和理解方面,对于初学者往往没有较好的适应性。所以我摘选了某些优秀同学的见解和译文推荐,写了一篇博,方便自己以后翻阅,也希望能帮到大家,
>>> def now():... print('2015-3-25')...>>> f = now>>> f()2015-3-25
函数对象有一个__name__
属性,可以拿到函数的名字:
>>> now.__name__'now'>>> f.__name__'now'
now()
函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改 now()
函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。 我们要定义一个能打印日志的decorator,可以定义如下:
def log(func): def wrapper(*args, **kw): print('call %s():' % func.__name__) return func(*args, **kw) return wrapper
观察上面的log
,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:
@logdef now(): print('2015-3-25')
调用now()
函数,不仅会运行now()
函数本身,还会在运行now()
函数前打印一行日志:
>>> now()call now():2015-3-25
把@log
放到now()
函数的定义处,相当于执行了语句:
now = log(now)
由于log()
是一个decorator,返回一个函数,所以,原来的now()
函数仍然存在,只是现在同名的now
变量指向了新的函数,于是调用now()
将执行新函数,即在log()
函数中返回的wrapper()
函数。
wrapper()
函数的参数定义是(*args, **kw)
,因此,wrapper()
函数可以接受任意参数的调用。在wrapper()
函数内,首先打印日志,再紧接着调用原始函数。
如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义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
这个3层嵌套的decorator用法如下:
@log('execute')def now(): print('2015-3-25')
执行结果如下:
>>> now()execute now():2015-3-25
和两层嵌套的decorator相比,3层嵌套的效果是这样的:
>>> 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 functoolsdef log(func): @functools.wraps(func) def wrapper(*args, **kw): print('call %s():' % func.__name__) return func(*args, **kw) return wrapper
或者针对带参数的decorator:
import functoolsdef 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
import functools
是导入functools
模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()
的前面加上@functools.wraps(func)
即可。
小结
在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。
decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。
'begin call'
和 'end call'
的日志。 #练习巩固了我对廖大大本讲主要内容的理解,分两种情况: #1#如果decorator本身不用传入参数的话,只是接受一个函数(当然也可以把接受的函数作为参数,为了区别,我们暂且将他们分开),并返回一个函数的话,当使用@log时即把目标函数接入; #2#如果decorator本身需要传入参数,那我们首先就需要在外层嵌套一个传入参数的接口,然后再接受函数并返回一个函数,内层则就是重复第一种情况,当时用@log('要传入的参数'),log('要传入的参数')就相当于第一种情况的log,也许这样说你还不是很能理解,我把廖大大的代码稍微做一点点改变,只改变下函数的名称: #1. 装饰器本身不用传入参数,只接收函数func def decorator(func): @functools.wraps(func) def wrapper(*args, **kw): print('call %s():' % func.__name__) return func(*args, **kw) return wrapper @decorator def f(): pass #2. 装饰器本身需要传入参数,再接收函数func 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 @log('execute') def f(): pass #其中第二种情况@log('execute')就是传入了字符串参数的decorator,传入参数之后就完全等同于第一种情况的@decorator,log只是在第一种情况下作为实现传入字符串参数功能的外层,可以发现第二种情况的内层完全和第一种情况相同。线性的把第二种情况展开:首先log()传入字符串参数,然后返回decorator接受目标函数func,返回wrapper,最后wrapper输出内容并运行目标函数。明显传入字符串参数之后完全和第一种情况一致。