with 离开之后:读懂 Python 的上下文管理器
写 Python 时,我们几乎每天都在用 with:打开文件、加锁、创建数据库连接、临时切换目录。它看起来像一种“语法糖”,但真正有价值的地方在于:无论代码块如何结束,清理逻辑都能被可靠执行。
这篇文章从 with 的执行规则讲起,带你手写一个上下文管理器,再用 contextlib 写出更简洁的实现,最后补上几个容易踩的坑。
with 解决的是什么问题
先看一段典型代码:
1f = open("data.txt", "w", encoding="utf-8")
2f.write("hello\n")
3f.close()如果 write() 抛出异常,close() 就不会执行。改成 try/finally 可以解决:
1f = open("data.txt", "w", encoding="utf-8")
2try:
3 f.write("hello\n")
4finally:
5 f.close()with 做的事情本质上就是把“进入资源”和“退出时清理”这组动作固定下来:
1with open("data.txt", "w", encoding="utf-8") as f:
2 f.write("hello\n")这里的收益不只是少写几行代码,而是把“必须成对出现”的逻辑绑定在一起,降低遗漏清理步骤的概率。
上下文管理协议:__enter__ 与 __exit__
一个对象只要实现了下面两个方法,就可以被 with 使用:
__enter__(self):进入上下文时调用,返回值会绑定给as后面的变量__exit__(self, exc_type, exc, tb):离开上下文时调用,负责清理;如果块内发生异常,异常信息会传进来
可以把 with 近似理解为:
1manager = EXPR
2value = manager.__enter__()
3try:
4 # 执行 with 块
5 ...
6except BaseException:
7 if not manager.__exit__(exc_type, exc, tb):
8 raise
9else:
10 manager.__exit__(None, None, None)有两个细节值得记住:
as拿到的是__enter__的返回值,不一定是管理器对象本身。__exit__返回True表示“异常已经处理,不要再向外抛出”;返回False或None,异常会继续传播。
手写一个计时器上下文管理器
下面这个例子可以直接运行,它会统计代码块耗时,并演示异常信息如何传入 __exit__:
1import time
2
3
4class Timer:
5 def __init__(self, label: str):
6 self.label = label
7 self.start = 0.0
8
9 def __enter__(self):
10 self.start = time.perf_counter()
11 print(f"[{self.label}] 开始")
12 return self # 绑定给 as 后的变量
13
14 def __exit__(self, exc_type, exc, tb):
15 elapsed = time.perf_counter() - self.start
16 if exc_type is None:
17 print(f"[{self.label}] 正常结束,用时 {elapsed:.4f}s")
18 else:
19 print(f"[{self.label}] 异常结束: {exc_type.__name__}: {exc}")
20 print(f"[{self.label}] 用时 {elapsed:.4f}s")
21 return False # 不吞掉异常
22
23
24if __name__ == "__main__":
25 with Timer("任务A"):
26 total = sum(range(1_000_00))
27
28 try:
29 with Timer("任务B"):
30 1 / 0
31 except ZeroDivisionError:
32 print("异常已传播到外层")运行后你会看到两次计时输出:第一次正常结束,第二次虽然块内出错,但清理逻辑依然执行了。这就是上下文管理器最核心的价值。
用 contextlib.contextmanager 写得更轻量
如果清理逻辑可以用“进入前 / 退出后”来描述,contextlib.contextmanager 往往更省事。它把一个生成器函数改造成上下文管理器:yield 之前是进入逻辑,yield 之后是退出逻辑。
1from contextlib import contextmanager
2import os
3
4
5@contextmanager
6def pushd(path: str):
7 old = os.getcwd()
8 os.chdir(path)
9 try:
10 yield
11 finally:
12 os.chdir(old)
13
14
15# 用法
16# with pushd("/tmp"):
17# print(os.getcwd())这里有一个关键点:yield 必须放在 try/finally 中。否则块内一旦抛异常,yield 后面的恢复代码就不会执行,目录也就切不回去了。
如果需要把资源对象交给 as 使用,可以 yield 出去:
1from contextlib import contextmanager
2
3
4@contextmanager
5def managed_resource(name: str):
6 print(f"获取资源: {name}")
7 resource = {"name": name}
8 try:
9 yield resource
10 finally:
11 print(f"释放资源: {name}")
12
13
14with managed_resource("db-conn") as r:
15 print("使用中:", r["name"])同时管理多个资源
需要多个上下文时,可以在一条 with 语句里并列写出:
1with open("in.txt", "r", encoding="utf-8") as src, \
2 open("out.txt", "w", encoding="utf-8") as dst:
3 dst.write(src.read())当资源数量在运行时才能确定,或者你希望动态收集上下文时,可以用 contextlib.ExitStack:
1from contextlib import ExitStack
2
3
4filenames = ["a.txt", "b.txt", "c.txt"]
5
6with ExitStack() as stack:
7 files = [stack.enter_context(open(name, "w", encoding="utf-8")) for name in filenames]
8 for i, f in enumerate(files):
9 f.write(f"file {i}\n")
10# 离开 with 后,所有文件都会按正确顺序关闭ExitStack 的好处是:进入了多少个上下文,就会负责退出多少个;中途某一步失败时,已经成功进入的部分也会被清理。
常见误区与实践建议
| 场景 | 容易出的问题 | 建议做法 |
|---|---|---|
| 手写类管理器 | __exit__ 忘记考虑异常参数 | 始终按 (exc_type, exc, tb) 处理,默认返回 False |
| 生成器管理器 | yield 没放进 try/finally | 清理逻辑必须写在 finally 中 |
| 想吞掉异常 | 随手 return True | 只在明确知道如何恢复时才吞异常,并限制异常类型 |
as 的理解偏差 | 以为总是拿到管理器本身 | 记住 as 绑定的是 __enter__ 的返回值 |
| 多资源管理 | 手写多层嵌套,可读性差 | 优先用一条 with 管理多个,动态场景用 ExitStack |
还有一个容易忽略的点:并不是所有“有关闭方法”的对象都适合作为上下文管理器,但大多数需要成对打开/释放的资源都应该优先支持 with。如果你在写库代码,给资源对象实现上下文协议,通常比只提供 close() 更稳妥,也更符合 Python 使用者的预期。
小结
with 的本质不是少写 finally,而是把“使用资源”和“释放资源”绑定成一个明确的生命周期。理解它时,抓住三句话就够了:
__enter__决定进入时做什么,以及as得到什么;__exit__决定离开时如何清理,以及是否吞掉异常;contextlib和ExitStack能帮你用更少的样板代码表达同样的保证。
下次再写文件、锁、连接或临时状态切换时,不妨先问一句:这段逻辑是否应该被包进一个上下文管理器里?很多“偶发的资源泄漏”和“异常后状态没恢复”,都能在这一步被提前消掉。
参考文档
- Python/输入输出/文件 IO - Primers 编程伙伴
- Python/内建函数/open - Primers 编程伙伴
- Python/内建函数/str - Primers 编程伙伴
- Python/内建函数/print - Primers 编程伙伴
- Python/内建函数/sum - Primers 编程伙伴
- Python/内建函数/range - Primers 编程伙伴
- Python/内建函数/enumerate - Primers 编程伙伴
本文由 AI 辅助生成并经人工校验,如有疏漏欢迎指正。