装饰器简介
每个Python开发者早晚都会遇到装饰器@，装饰器通常用于增强函数功能。
例如，在Django中用装饰器为视图添加权限：
@permission_required('edit_publisher') def publisher_edit(request, pk=None): ...
注册标签
@register.simple_tag def generic_simple_tag(arg1, arg2): ...
装饰器是可调用对象，其参数是一个函数。返回值是一个函数。
下面我们定义一个装饰器dec，它的作用是在执行函数前打印一句话"做了一个装饰"。
def dec(func): def inner(): print("做了一个装饰") func() return inner
可以用两种方式使用装饰器
- 将
@dec放在函数定义上面一行。（常用） - 将函数传递给装饰器
dec(func2)
@dec def func1(): print("Hello! func1") def func2(): print("Hello! func2") func1() print("---") dec_func2 = dec(func2) print("---") dec_func2()
输出：
做了一个装饰 Hello! func1 --- --- 做了一个装饰 Hello! func2
实用的装饰器
1. 计时器
下面定义了一个记录函数耗时的装饰器。
import time import functools def clock(func): @functools.wraps(func) def clocked(*args, **kwargs): t0 = time.perf_counter() result = func(*args, **kwargs) elapsed = time.perf_counter() - t0 name = func.__name__ arg_lst = [repr(arg) for arg in args] arg_lst.extend(f'{k}={v!r}' for k, v in kwargs.items()) arg_str = ', '.join(arg_lst) print(f'[{elapsed:0.8f}s] {name}({arg_str}) -> {result!r}') return result return clocked @clock def factorial(n): return 1 if n < 2 else n*factorial(n-1) factorial(3)
运行结果：
[0.00000030s] factorial(1) -> 1 [0.00004380s] factorial(2) -> 2 [0.00005380s] factorial(3) -> 6
clocked在执行函数前后各记录一次时间，得到函数运行耗时，并且打印函数名称和参数。
clocked函数使用@functools.wraps(func)修饰，@wraps的作用是将所有元数据从一个函数复制到另一个函数，这样可以保留原始函数的信息。(*args, **kwargs)实现了可变数量的位置参数、关键字参数。
2. 返回装饰器的函数
返回装饰器的函数可以实现更灵活的装饰器。
下面定义了一个返回装饰器的函数。装饰器的作用是：当upper_case=True时将func的返回字符串转化成大写，否则返回原始字符串。
from functools import wraps def function_that_creates_a_decorator(upper_case=False): def decorator(func): @wraps(func) def wrapper(*args, **kwargs): result = func(*args, **kwargs) if upper_case: result = result.upper() return result return wrapper return decorator
这个代码看起来有点奇怪，我们一层层地读一下。
- 最外层定义了一个函数
def function_that_creates_a_decorator(upper_case=False)，这个函数的作用是返回一个装饰器。
- 第二层的
def decorator(func)是真正的装饰器，返回包装后的函数。 - 第三层的
def wrapper(*args, **kwargs)是包装的函数。这个函数使用@wraps修饰。
@function_that_creates_a_decorator(upper_case=True) def normalize_user_input(user_input: str, default: str | None=None) -> str | None: """Reduce PBCK as much as possible""" return str(user_input).strip().casefold() or default result = normalize_user_input("HEllo, WoRLD") print(result)
运行结果：
HELLO, WORLD
注意@function_that_creates_a_decorator(upper_case=True)使用了()，是一个函数调用，返回了装饰器。
装饰器的注意事项
- 装饰器在导入模块时立即执行，而被装饰的函数只在显式调用时运行。
- 可以使用多个装饰器，装饰器将按照从里到外的顺序进行装饰。如：
def dec1(func): def inner(): print("做了一个装饰dec1") func() return inner def dec2(func): def inner(): print("做了一个装饰dec2") func() return inner @dec2 @dec1 def func1(): print("Hello! func1") func1()
运行结果：
做了一个装饰dec2 做了一个装饰dec1 Hello! func1
参考&推荐阅读
- 《流畅的Python》(第二版) 第9章 装饰器和闭包
- https://www.bitecode.dev/p/xmas-decoration-part-2
