Python进阶-装饰器应用场景
装饰器的应用场景
- 附加功能
- 数据的清理或添加:
- 函数参数类型验证 @require_ints 类似请求前拦截
- 数据格式转换 将函数返回字典改为 JSON/YAML 类似响应后篡改
- 为函数提供额外的数据 mock.patch
- 函数注册
- 在任务中心注册一个任务
- 注册一个带信号处理器的函数
示例1-函数注册
简单注册表，使用全局变量保存所有注册（带特定装饰器）的函数，示例如下：
funcs = []
def register(func):
funcs.append(func)
return func
@register
def a():
return 3
@register
def b():
return 5
# 访问结果-运行所有注册的函数
result = [func() for func in funcs]
如果想实现注册表隔离（注册不同的流程）则可以用类（对象属性代替全局变量存储注册的函数）来实现，示例如下：
class Registry(object):
def __init__(self):
self._funcs = []
def register(self, func):
self._funcs.append(func)
def run_all(self):
return [func() for func in self._funcs]
r1 = Registry()
r2 = Registry()
@r1.register
def a():
return 3
@r2.register
def b():
return 5
@r1.register
@r2.register
示例2-参数类型检查
假设我们要求某些函数的多有参数都必须为int类型，可以设计一个装饰器来进行参数类型检查，示例如下：
from functools import wraps
def require_ints(func):
@wraps(func) # 将func的信息复制给inner
def inner(*args, **kwargs):
for arg list(args) + list(kwargs.values()):
if not isinstance(arg, int:
raise TypeError("{} 只接受int类型参数".format(func.__name__)
return func(*args, **kwargs)
return inner
示例3-用户验证
用户验证（包括权限验证）和参数检查的逻辑一致，都是在装饰器内部，在内部函数调用原函数前，对参数、权限等进行拦截和检查，示例代码如下：
from functools import wraps
class User(object):
def __init__(self, username, email):
self.username = username
self.email = email
class AnonymousUser(object):
def __init__(self):
self.username = self.email = None
def __nonzero__(self): # 将对象转换为bool类型时调用
return False
def requires_user(func):
@wraps(func)
def inner(user, *args, **kwargs): # 由于第一个参数无法支持self, 该装饰器不支持装饰类
if user and isinstance(user, User):
return func(use, *args, **kwargs)
else:
raise ValueError("非合法用户")
return inner
示例4-输出格式化
除拦截函数参数进行检查外，还可以拦截函数返回值，进行一些处理，以下是一个将原本返回字典格式的函数，转为返回JSON字符串形式的例子。
import json
from functools import wraps
def json_output(func): # 将原本func返回的字典格式转为返回json字符串格式
@wrap(func)
def inner(*args, **kwargs):
return json.dumps(func(*args, **kwargs))
return inner
示例5-异常捕获
除了处理函数参数、返回值外，装饰器内部函数也可以对函数调用过程进行处理，最常见的就是在调用原函数时进行异常捕获，并做对应处理，示例如下：
import json
from functools import wraps
class Error1(Exception):
def __init__(self, msg):
self.msg = msg
def __str__(self):
return self.msg
def json_output(func):
@wrap(func)
def inner(*args, **kwargs):
try:
result = func(*args, **kwargs)
except Error1 as ex:
result = {"status": "error", "msg": str(ex)}
return json.dumps(result)
return inner
# 使用方法
@json_ouput
def error():
raise Error1("该条异常会被捕获并按JSON格式输出")
示例6-日志管理
为函数动态增加日志输出也是装饰器的典型应用场景之一，可以在不修改原函数的情况下，快速为不同的函数添加日志功能。
import time
import logging
from functools import wraps
def logged(func):
@wraps(func)
def inner(*args, **kwargs): # *args可以装饰函数也可以装饰类
start = time.time()
result = func(*args, **kwargs)
exec_time = time.time() - start
logger = logging.getLoger("func.logged")
logger.warning("{} 调用时间:{:.2} 执行时间:{:.2}s 结果:{}".format(func.__name__, start, exec_time, result)
return result
return inner
带参数的装饰器
带参数的装饰器实际上于一个返回装饰器的函数,@deco(a=1)在调用@之前会首先执行deco(a=1)得到一个实际的装饰器, 带参数的装饰器deco(a=1)模块导入时立即执行。
示例7-类的装饰器
装饰器也可以应用与类，只要满足以下要求即可：
- 参数是一个类对象
- 返回一个相同功能的类对象
以下是一个，为类增加可排序功能的示例。当多个类需要增加此功能时，可以不通过继承子类扩充父类方法。
这也是面向切片编程（AOP）的一种典型使用方式。
import time
from functools import wraps
def sortable_by_created(cls):
original_init = cls.__init__
@wrap(original_init)
def new_init(self, *args, **kwargs):
original_init(*args, **kwargs)
self._created = time.time()
cls.__init__ = new_init
cls.__lt__ = lambda self, other: self._created < other._created
cls.__gt__ = lambda self, other: self._created > other._created
return cls
也可定义一个SortableByCreated()类, 子类使用多重继承其父类和SortableByCreated
示例8-使用类对象替代原函数
函数装饰器的要求是参数是一个函数，返回一个同功能的函数。出来在装饰器中嵌套一个新函数外，我们可以通过使用带__call__方法带对象来模拟一个函数（和原函数功能一致），示例如下：
class Task(object):
def __call__(self, *args, **kwargs):
return self.run(*args, **kwargs)
def run(self, *args, **kwargs):
raise NotImplementedError("子类未实现该接口")
def task(func):
class SubTask(Task):
def run(self, *args, **kwargs):
func(*args, **kwargs)
return SubTask()
