用 contextlib 写出更干净的资源管理代码
【摘要】 在 Python 里,打开文件、获取锁、建立数据库连接,这些操作都有一个共同点:用完必须释放。很多人知道 with open(...) 的写法,却很少自己写上下文管理器。其实标准库里的 contextlib 模块,能让这件事变得非常简单。 一、为什么需要上下文管理器先看一段常见代码:conn = connect_db()try: do_query(conn)finally: co...
在 Python 里,打开文件、获取锁、建立数据库连接,这些操作都有一个共同点:用完必须释放。很多人知道 with open(...) 的写法,却很少自己写上下文管理器。其实标准库里的 contextlib 模块,能让这件事变得非常简单。
一、为什么需要上下文管理器
先看一段常见代码:
conn = connect_db()
try:
do_query(conn)
finally:
conn.close()
逻辑没问题,但每个用到连接的地方都要重复 try/finally。一旦忘记,就会出现连接泄漏。上下文管理器的价值,就是把“获取”和“释放”绑在一起,调用方只关心中间的业务逻辑。
二、用 @contextmanager 三行写一个
传统写法需要定义一个类,实现 __enter__ 和 __exit__。contextlib 提供的装饰器把它简化成一个生成器函数:
from contextlib import contextmanager
@contextmanager
def db_connection():
conn = connect_db()
try:
yield conn
finally:
conn.close()
with db_connection() as conn:
do_query(conn)
yield 之前是进入时执行的代码,yield 之后是退出时执行的代码。即使 with 块里抛出异常,finally 也保证连接被关闭。
三、几个好用的小工具
- suppress:有意忽略某个异常
from contextlib import suppress
import os
with suppress(FileNotFoundError):
os.remove("tmp.txt")
比写一个空的 except FileNotFoundError: pass 更直观,意图一眼可见。
- redirect_stdout:临时把输出写到别处
import io
from contextlib import redirect_stdout
buf = io.StringIO()
with redirect_stdout(buf):
print("hello")
print(buf.getvalue())
测试一些只会 print 的老函数时很方便。
- ExitStack:数量不固定的资源
from contextlib import ExitStack
with ExitStack() as stack:
files = [stack.enter_context(open(p)) for p in paths]
merge(files)
当要同时打开的文件数量在运行时才知道时,ExitStack 会在退出时按相反顺序逐个关闭它们。
四、一个实用例子:计时器
import time
from contextlib import contextmanager
@contextmanager
def timer(name):
start = time.perf_counter()
yield
cost = time.perf_counter() - start
print(f"{name} 耗时 {cost:.3f}s")
with timer("加载数据"):
load_data()
这类小工具放进项目的 utils 里,排查性能问题时非常顺手。
五、注意事项
- @contextmanager 装饰的函数里只能 yield 一次。
- 需要处理异常时,把 yield 放进 try 中;不想吞掉异常,就不要在 except 里静默返回。
- Python 3.7 起还有 asynccontextmanager,可用于 async with 场景。
结语
上下文管理器不是什么高级技巧,而是一种“把清理责任交给结构”的习惯。下次再写 try/finally 时,不妨想一想:这段逻辑能不能封装成一个 with?代码会更短,也更不容易出错。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)