所谓装饰器(decorator)指的是在Python代码运行期间动态的增加函数功能的一种方式。在上一节我们知道Python函数在运行时允许返回函数,而函数作为对象也可以被赋值给其他变量来调用,比如:
>>> def LAL():
... print('kobe')
...
>>> f = LAL
>>> f()
kobe
每个函数对象都有一个_ _name_ _属性,调用该属性我们可以取得该函数的名称:
>>> LAL.__name__
'LAL'
>>> f.__name__
'LAL'
而装饰器(decorator)的作用即在于可以使得我们在调用 LAL 函数的时候,使得该函数功能增强,比如说在调用该函数前后自动打印日志,但又不能改变 LAL函数的定义。所以,Python装饰器的本质在于它是一个可以返回函数的高阶函数。我们来定义一个decorator,使得函数在调用前后能打印日志。
def log(func):
def folder(*args,**kw):
print('call %s():' % func.__name__)
return func(*args,**kw)
return folder
仔细观察上述代码,我们定义的log函数作为一个decorator可以接受像func这样的函数作为参数,作为高阶函数它也可以返回一个函数。下面再利用Python的@语法,在重新定义 LAL函数时调用装饰器:
@log
def LAL():
print('kobe')
之后再调用 LAL 函数时,不仅会运行 LAL 函数本身也会打印装饰器所设置的一串日志。
>>> LAL()
call LAL():
kobe
@语法的作用相当于执行了如下语句:
LAL = log(LAL)
如果decorator本身也需要传入参数,那装饰器的定义则需要更加复杂一点。我们可以自定义log的文本:
def log(text):
def decorator(func):
def folder(*args,**kw):
print('call %s():' % (text,func.__name__))
return func(*args,**kw)
return folder
return decorator
可以看见的是,我们经过三层嵌套后使得装饰器本身可以传入文本参数,其用法如下:
@log('execute')
def LAL():
print('kobe')
函数执行结果如下:
>>> LAL()
execute LAL():
kobe
相较于两层嵌套,三层嵌套的decorator相当于执行了如下语句:
>>> LAL = log('execute')(LAL)
可以简单分析一下这个语句。先执行log('execute'),返回的是装饰器函数,调用该返回函数,其参数是LAL函数,最后的返回值则是folder函数。不管两层还是三层嵌套,decorator的定义都是这种套路,我们开头时提到了函数作为对象是有__name__属性的,但经过装饰器装饰后的函数,其__name__属性由原先的'LAL'变成了'folder':
>>> LAL.__name__
'folder'
所以这里我们还需要导入functools模块,使用functools.wraps使得经装饰器装饰前后的函数对象名保持不变,完整的decorator定义方法如下:
import functools
def log(func):
@functools.wraps(func)
def folder(*args,**kw):
print('call %s():' % func.__name__)
return func(*args,**kw)
return folder
decorator可以增强函数的功能,虽然不容易定义清楚,但使用起来非常便利。
louwill学习参考资料:
廖雪峰老师Python官方教程
http://www.liaoxuefeng.com/
推文为该教程学习笔记
一个数据科学践行者的学习日记