装饰器本质上是一个 Python 函数或类，它会接受一个callable对象作为参数，然后再返回一个callable对象作为返回值。装饰器可以在不修改原有对象代码的基础上，为对象添加额外的功能。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景，有了装饰器，我们就可以抽象出大量与函数功能本身无关的雷同代码到装饰器中进行重用。
简单装饰器
下面是一个简单的装饰器例子：
def log(func):
def wrapper(*args, **kwargs):
print('The following function name is [%s]' % func.__name__)
return func(*args, **kwargs)
return wrapper
@log # 无()
def test():
print('Hi, I am test' )
test()
# Output>>>
The following function name is [test]
Hi, I am test
上例中，log 就是一个装饰器，它接收一个函数（func）作为参数，同时也返回一个函数（wrapper）。从运行结果可以发现，test 函数不需要做任何修改，只需在函数定义的地方加上装饰器，@ 符号是装饰器的语法糖，它放在函数开始定义的地方，这样就可以省略最后一步再次赋值的操作。函数调用的时候还是和以前一样，如果我们还有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们不但为对象添加了额外的功能，还提高了代码的可重复利用性。
装饰器在 Python 中使用如此方便，主要归因于 Python 中一切皆对象的思想，函数也能像普通的对象一样，能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内，以及闭包结构所拥有的极大威力。
继续看下面的例子：
def log(func):
def wrapper():
'''This is decorator'''
print('The following function name is [%s]' % func.__name__)
return func(*args, **kwargs)
return wrapper
@log
def test():
'''This is test'''
print(test.__doc__)
print('Hi, %s' % test.__name__)
test()
# Output>>>
The following function name is [test]
This is decorator
Hi, wrapper
从运行结果中看到，使用装饰器后，test函数的函数名和注释文档等元信息被wrapper的元信息替换了，这显然不是我们想要看到的。Python提供给我们一个functools.wraps函数来解决这个问题，对上面的代码进行修改：
from functools import wraps
'''
@wraps接受一个函数来进行装饰，并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性
'''
def log(func):
@wraps(func)
def wrapper(*args, **kwargs):
'''This is decorator'''
print('>>>The following function name is %s' % func.__name__)
return func(*args, **kwargs)
return wrapper
@log
def test():
'''This is test'''
print(test.__doc__)
print('Hi, %s' % test.__name__)
test()
# Output>>>
The following function name is test
This is test
Hi, test
从运行结果来看，现在已经达到了我们所期望的结果。
带参数的装饰器
在上面的代码中使用的@wraps装饰器，它可以像普通函数一样接受参数，下面来实现一个带参数的装饰器，用来输出日志文件。
from datetime import datetime
from functools import wraps
import logging
def logit(log_level='info'):
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
log_file = datetime.now().strftime('%Y%m%d') + '.log'
log_string = 'Current function is %s' % func.__name__
if log_level == 'warning':
logging.warning('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(log_level))
elif log_level == 'info':
logging.info('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(log_level))
elif log_level == 'error':
logging.debug('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(log_level))
else:
raise ValueError('log level is illegal.')
return func(*args, **kwargs)
return wrapper
return decorator
@logit(log_level='warning')
def test1():
print('I am %s' % test1.__name__)
@logit(log_level='error')
def test2():
print('I am %s' % test2.__name__)
test1()
test2()
类装饰器
使用类装饰器主要是依靠重写类的__call__方法，相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使在下面的代码中，以类的方式来重新构建logit.
import logging
from datetime import datetime
from functools import wraps
class logit:
def __init__(self, log_level='info'):
self.log_level = log_level
def __call__(self, func):
@wraps(func)
def wrapper(*args, **kwargs):
log_file = datetime.now().strftime('%Y%m%d') + '.log'
log_string = 'Current function is %s' % func.__name__
if self.log_level == 'warning':
logging.warning('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(self.log_level))
elif self.log_level == 'info':
logging.info('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(self.log_level))
elif self.log_level == 'error':
logging.debug('%s is running' % func.__name__)
with open(log_file, 'a') as f:
f.write((str(datetime.now()) + '\n' + '[{}]' + log_string + '\n').format(self.log_level))
else:
raise ValueError('log level is illegal.')
return func(*args, **kwargs)
return wrapper
@logit()
def test1():
print('I am %s' % test1.__name__)
@logit(log_level='error')
def test2():
print('I am %s' % test2.__name__)
test1()
test2()
上述实现方法比函数嵌套的方法更加整洁，并且可以非常方便的使用继承的场景，如使用logit作为基类，在添加一个email的功能，代码如下：
class email_logit(logit):
def __init__(self,email_addr = 'xxx@xx.com',*args,**kwargs):
self.email_addr = email_addr
super(email_logit, self).__init__(*args,**kwargs)
def notify(self):
# 邮件通知相关代码，参见：https://www.jianshu.com/p/2e1486db28ca
pass
从现在起，@email_logit 将和 @logit 产生同样的效果，但是在打印日志的基础上，还会多发送一封邮件给相关用户。
[To be continued....]
参考文档
-
Python 装饰器执行顺序迷思 , Nisen
-
Python函数装饰器，菜鸟教程
网友评论