Python 教程 / 装饰器与上下文管理器:返回值、异常和清理

装饰器包装函数调用行为,上下文管理器则安排代码块前后的准备与清理。它们能提取重复的公共处理,但返回值、参数和异常如何传递,仍然必须明确设计和验证。

区分调用包装与资源寿命

@announce 相当于函数定义后执行 total = announce(total),不是仅作标记的注释。announce 返回 wrapper,让原函数名称指向包装后的调用入口。包装器可以在调用前执行公共逻辑,但也可能无意改变接口。

functools.wraps 帮助保留被包装函数的名称、文档等元信息,并提供 __wrapped__ 关联,不会自动验证所有参数、安全政策或异常契约。具体行为见wraps 官方说明。

with 则调用上下文的进入与退出逻辑。contextlib.contextmanager 可用生成器表达这一流程:准备、yield 给代码块、恢复执行并清理。它需要恰好 yield 一次,相关约定见Python 官方 contextlib 文档。

运行完整包装与临时列表示例

在独立练习目录中,把以下全部内容以 UTF-8 保存为 wrappers.py。使用 Python 3.12 以上项目环境执行 python wrappers.py;若实际解释器命令是 python3,则相应替换。这里只使用标准库。

from functools import wraps
from contextlib import contextmanager

def announce(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("start")
        return func(*args, **kwargs)
    return wrapper

@contextmanager
def temporary_items():
    items = []
    try:
        yield items
    finally:
        items.clear()
        print("cleared")

@announce
def total(amounts):
    return sum(amounts)

with temporary_items() as items:
    items.extend([3500, 8000])
    print(total(items))
print(total.__name__)
print(items)

预期输出:

start
11500
cleared
total
[]

调用 total 时 wrapper 先打印 start,再返回 sum 的 11500。退出 with 时 finally 清空列表并打印 cleared;wraps 保留名称,所以随后显示 total。最后的 [] 来自同一列表对象已被清空。

with 不创建新的变量作用域,因此 items 在块后仍可访问。清理改变的是列表内容,不是删除变量。对于文件或数据库等对象,也必须依据该对象的上下文协议判断退出后发生什么,不能把这个列表例子推广成所有资源都使用 clear。

追踪参数、返回值和异常

*args 与 **kwargs 转发位置参数和关键字参数。return func(*args, **kwargs) 中的 return 很重要:去掉它之后,原函数仍执行,但调用者得到 None。仅看到 start 不能证明返回值仍然正确。

temporary_items 在 yield 前创建列表,yield 的值绑定给 as 后的名称,代码块结束后生成器继续。块内有异常时,异常在 yield 处重新进入生成器;finally 仍执行清理,然后错误继续传给调用方。

如果围绕 yield 捕获异常却不重新抛出,就可能抑制它。只有明确的恢复政策才应这样做,否则调用方会把失败当成成功。原理仍遵循try、except 与 finally规则。

本例 announce 没有捕获原函数异常,也没有调用结束后的 finally。若需要在失败调用后执行某个动作,要另外设计。with 内未处理的异常还会阻止后续普通语句执行;要在失败后打印空列表,可在 with 外层捕获预期异常再检查,不能要求未捕获错误后程序还照常继续。

试验清理并选择合适的抽象

  1. 在 with 内的合计打印后暂时加入 raise ValueError("test")。运行应显示 cleared,但进程仍以错误结束;需要检查列表时,在外层 try/except 捕获该错误。
  2. 恢复程序,只把包装器中的 return func(*args, **kwargs) 改为 func(*args, **kwargs)。结果打印变成 None,清理仍然执行。
  3. 恢复 return,再次运行,确认五行输出与原始结果一致。

每次调用 temporary_items() 会为新的列表创建新上下文。不要在退出后把同一个生成器上下文对象当成可以重新启动的对象;需要另一个块时,再调用这个工厂函数。

自动重试装饰器可能重复发送有副作用的写入请求,导致交易重复。重试政策与资源清理是两个问题,不能因为都放在装饰器或 with 中就混为一谈。只用一次的小操作,也可以保留清楚的显式代码,不必为了使用语法而增加抽象。