Python上下文管理实现_自定义with说明【教程】

Python中with语句依赖__enter__和__exit__方法实现上下文管理,支持类定义或contextlib.contextmanager装饰器两种方式,用于自动管理资源生命周期,避免手动清理。

Python 中的 with 语句依赖上下文管理器协议,核心是实现 __enter____exit__ 两个特殊方法。自定义上下文管理器能让资源(如文件、数据库连接、锁等)在进入和退出时自动初始化与清理,避免手动 try/finally 的冗余代码。

用类实现上下文管理器

最直接的方式是定义一个类,显式实现两个方法:

  • __enter__:在 with 语句块开始时调用,通常返回需要被管理的对象(如打开的文件),也可返回 self 或其他值供 as 绑定
  • __exit__(exc_type, exc_value, traceback):在 with 块结束时(无论是否异常)调用;三个参数分别表示异常类型、异常值、回溯信息;若该方法返回 True,则会抑制异常传播

示例:一个简单的计时上下文管理器

import time

class Timer: def enter(self): self.start = time.time() return self

def __exit__(self, exc_type, exc_value, traceback):
    self.end = time.time()
    print(f"耗时: {self.end - self.start:.3f} 秒")

使用

with Timer() as t: time.sleep(1)

输出:耗时: 1.001 秒

立即学习“Python免费学习笔记(深入)”;

用 contextlib.contextmanager 装饰器(推荐)

更简洁的方式是使用 contextlib.contextmanager 装饰生成器函数。函数中 yield 之前的代码相当于 __enter__,之后的代码(在 finally 块中执行)相当于 __exit__

  • yield 的值即为 as 接收的对象
  • 所有清理逻辑写在 yield 后,天然支持异常安全(类似 try/finally
  • 无需手动处理异常参数,也无需返回布尔值来抑制异常(如需抑制,仍需加 try/except

示例:临时修改环境变量

from contextlib import contextmanager
import os

@contextmanager def temp_env(**kwargs): old_values = {} for key, value in kwargs.items(): old_values[key] = os.environ.get(key) os.environ[key] = str(value) try: yield finally: for key, old_value in old_values.items(): if old_value is None: os.environ.pop(key, None) else: os.environ[key] = old_value

使用

with temp_env(DEBUG="1", ENV="test"): print(os.environ["DEBUG"]) # 1 print(os.environ["ENV"]) # test

退出后自动恢复原环境变量

立即学习“Python免费学习笔记(深入)”;

常见注意事项与技巧

写自定义上下文管理器时容易忽略的关键点:

  • __exit__ 方法必须接受三个参数(即使不用也要保留),否则会报错
  • 若上下文管理器本身可能抛出异常,应在 __exit__ 中谨慎处理,避免掩盖原始错误
  • 多个上下文管理器可写在同一行:with open("a.txt") as f1, open("b.txt") as f2:
  • 想复用已有对象的上下文行为?确认它实现了协议(比如 threading.Lockpathlib.Path.open() 返回的文件对象都支持 with

何时该自己写,而不是用现成的?

标准库和第三方包已覆盖大部分场景(文件、数据库连接池、锁、临时目录等)。只有当业务有明确的“进入-执行-退出”生命周期,且涉及资源独占、状态切换或副作用清理时,才值得封装:

  • 临时切换日志级别
  • 测试中模拟网络超时或异常响应
  • GPU 显存分配与释放(PyTorch/TensorFlow 中常见)
  • 数据库事务的 begin/commit/rollback 封装

不复杂但容易忽略细节,掌握协议本质比死记语法更重要。