函数装饰器
中等 约 35 分钟
你将构建什么
三个可复用装饰器:@timer(测量执行时间)、@log_calls(记录参数和结果)和 @retry(异常时带退避重试)。
学习目标
- 理解装饰器为包装函数的函数
- 用 functools.wraps 保留函数元数据
- 接受 *args 和 **kwargs 实现通用包装
- 构建参数化装饰器(带参数的 retry)
前置要求
- 函数与参数
- *args 和 **kwargs
- try/except 异常处理
步骤
- 1
编写基础计时装饰器
装饰器是接受函数并返回包装版本的函数。从 @timer 开始,用 time.perf_counter 测量并打印执行时间。
代码import time from functools import wraps def timer(func): @wraps(func) def wrapper(*args, **kwargs): start = time.perf_counter() result = func(*args, **kwargs) elapsed = time.perf_counter() - start print(f"{func.__name__} took {elapsed:.4f}s") return result return wrapper @timer def slow_sum(n): return sum(range(n)) print(slow_sum(1_000_000)) # prints time, then result预期结果
调用 slow_sum 打印执行时间和结果。
- 2
添加日志装饰器
编写 @log_calls,打印函数名、参数和返回值。用 functools.wraps 保留原函数名和文档字符串。
代码def log_calls(func): @wraps(func) def wrapper(*args, **kwargs): print(f"Calling {func.__name__}({args}, {kwargs})") result = func(*args, **kwargs) print(f"{func.__name__} returned {result}") return result return wrapper @log_calls def greet(name, greeting="Hello"): return f"{greeting}, {name}!" print(greet("Alice", greeting="Hi"))预期结果
打印调用、返回值和最终结果。
- 3
编写参数化重试装饰器
参数化装饰器自身接受参数,因此需要三层嵌套。编写 @retry(times=3, delay=0.1),异常时重试。
代码def retry(times=3, delay=0.1): def decorator(func): @wraps(func) def wrapper(*args, **kwargs): for attempt in range(times): try: return func(*args, **kwargs) except Exception as e: if attempt == times - 1: raise print(f"Retry {attempt + 1}/{times}: {e}") time.sleep(delay) return wrapper return decorator @retry(times=3, delay=0.1) def flaky(): import random if random.random() < 0.5: raise ValueError("Random fail") return "success" print(flaky())预期结果
最多重试 3 次;最终返回 'success' 或 3 次后抛出。
- 4
堆叠多个装饰器
将 @timer、@log_calls 和 @retry 应用于同一函数。装饰器自底向上应用,顺序很重要。测试哪个先运行。
代码@timer @log_calls @retry(times=2) def process(data): return len(data) print(process([1, 2, 3]))预期结果
retry 包装 process,log_calls 包装 retry,timer 包装 log_calls——timer 测量一切。
- 5
验证元数据保留
没有 functools.wraps,包装函数的 __name__ 会变成 'wrapper'。验证用 @wraps 后名称和文档字符串被保留。
代码print(slow_sum.__name__) # 'slow_sum', not 'wrapper' print(slow_sum.__doc__) # original docstring # Without @wraps it would print 'wrapper'预期结果
__name__ 为 'slow_sum',确认 @wraps 保留了元数据。
自己动手试试
起始代码
from functools import wraps
def timer(func):
# TODO: wrap and time the function
pass解决方案代码
def timer(func):
@wraps(func)
def w(*a, **k):
s = time.perf_counter(); r = func(*a, **k); print(f"{func.__name__}: {time.perf_counter()-s:.4f}s"); return r
return w你学到了什么
你构建了可复用装饰器——Flask 路由、pytest fixture 和许多 Python 库背后的模式。装饰器让你无需修改函数即可添加横切行为。
相关资源
相关课程
- 函数
装饰器是高阶函数。
查阅不认识的术语
新手友好的术语表用大白话解释编程术语——变量、函数、DOM、Promise 等等。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。