如何在Python中编写支持上下文管理器的类

酷磊酱_3091

酷磊酱_3091

2026-10-07

927人浏览

原创

上下文管理器必须同时实现__enter__和__exit__方法,前者返回as绑定对象,后者在with块退出时必然执行资源清理,且需正确处理异常参数与幂等性。

如何在python中编写支持上下文管理器的类

__enter__ 和 __exit__ 方法必须成对实现

上下文管理器的核心是让类支持 with 语句,这要求必须定义 __enter__ 和 __exit__ 两个特殊方法。缺一不可——只写 __enter__ 会导致 AttributeError: __exit__;只写 __exit__ 则 with 无法获取上下文对象。

典型错误现象:RuntimeError: generator didn't yield(误用生成器写法但没配装饰器)或 TypeError: object does not support the context manager protocol。

  • __enter__ 应返回要绑定到 as 变量的对象(常为 self,也可返回其他值)
  • __exit__(self, exc_type, exc_value, traceback) 的三个异常参数可能全为 None(无异常时),不能省略或重排顺序
  • 若在 __exit__ 中返回 True,会抑制异常传播;返回 False 或 None 则正常抛出

资源清理逻辑必须放在 __exit__ 中,而非 __del__

__del__ 不可靠:它依赖垃圾回收触发,时机不确定,甚至可能在解释器关闭时才调用。而 __exit__ 在 with 块退出时**必然执行**,无论是否发生异常,这才是做释放、关闭、回滚的唯一可信位置。

常见使用场景:文件句柄、数据库连接、锁、临时目录、计时器启停。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 不要在 __exit__ 里 raise 新异常(除非有意替换原异常),否则会掩盖原始错误
  • 避免在 __exit__ 中调用可能抛异常的复杂逻辑;如需容错,应自行捕获并记录
  • 若资源已关闭/释放过,__exit__ 应幂等处理(比如检查 self._closed 标志)

用 @contextlib.contextmanager 装饰器更轻量,但不适用于类实例管理

如果只是封装一段函数式逻辑(如临时修改环境变量、压栈/出栈状态),用 @contextlib.contextmanager + 生成器最简洁。但它返回的是一个上下文管理器对象,**不是类本身**,无法直接用于需要实例属性或方法调用的场景。

示例对比:

from contextlib import contextmanager
<p>@contextmanager
def timer():
start = time.time()
try:
yield
finally:
print(f"Elapsed: {time.time() - start:.2f}s")</p><h1>✅ 可以 with timer(): ...</h1><h1>❌ 不能 timer().start() 或访问实例属性</h1>
  • 生成器中 yield 之前的部分相当于 __enter__,之后(finally)相当于 __exit__
  • 若需传参(如 timer(label="db")),必须写成工厂函数返回被装饰的生成器
  • 类方式更适合需要维护状态、复用实例、或与其他类继承/组合的场景

测试上下文行为时,务必覆盖异常路径

很多人只验证正常流程(with MyCtx() as x:),却忽略异常退出时 __exit__ 是否真被调用、是否正确处理了 exc_type 等参数。这是最容易漏测也最易出问题的地方。

  • 用 pytest.raises() 或 self.assertRaises() 触发异常,再断言资源是否已释放(如文件是否 closed、锁是否 release)
  • 手动传入 exc_type=ZeroDivisionError 等模拟异常,在单元测试中调用 ctx.__exit__(...) 直接测逻辑
  • 注意:若 __exit__ 返回 True 但实际不该吞异常(比如仅处理 IOError 却吞了 ValueError),会导致调试困难

真正难的不是写这两个方法,而是想清楚:哪些状态必须保证在退出时还原,以及异常发生时还原动作本身会不会失败。这两点决定了 <strong>exit</strong> 的健壮性,而不是语法是否正确。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4144

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24017

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2947

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2967

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2303

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程