如何在Python中利用__enter__与__exit__自定义上下文管理器?

星丽同学_8275

星丽同学_8275

2026-06-28

690人浏览

原创

__enter__和__exit__易出错因签名与返回值有严格约定:__enter__须返回as绑定对象,__exit__必须接收3个异常参数且返回布尔值——漏参、返非布尔值或误抛异常均导致with行为失控。

如何在python中利用__enter__与__exit__自定义上下文管理器?

为什么直接写 __enter__ 和 __exit__ 容易出错?

因为这两个方法的签名和返回值有隐含约定:__enter__ 应该返回要绑定到 as 后变量的对象(或 None),而 __exit__ 必须接收 3 个参数(exc_type, exc_value, traceback)且返回布尔值——返回 True 才会抑制异常。漏掉参数、返回非布尔值、或在 __exit__ 里误抛异常,都会导致 with 块行为失控。

常见错误现象包括:

  • TypeError: __exit__() takes 1 positional argument but 4 were given —— 忘记加那三个异常参数
  • AttributeError: __exit__ —— 拼错方法名(比如写成 __exxit__)
  • 异常没被捕获,或本该吞掉的异常却冒出来了 —— __exit__ 返回了 None 或 False

如何让 __exit__ 正确处理异常并释放资源?

__exit__ 的核心职责不是“处理异常”,而是“决定是否吞掉它”。资源清理(如关闭文件、回滚事务)必须放在 __exit__ 里无条件执行,不能依赖 if exc_type is not None: 来触发。

实操建议:

  • 所有清理逻辑(如 self.file.close())写在 __exit__ 开头,不加条件判断
  • 只在最后用 return True 显式抑制异常;否则默认返回 None(等价于 False),异常继续上抛
  • 如果需要记录异常但不抑制,别在 __exit__ 里 print() 或 logging.error() 后忘了 return False

示例片段:

def __exit__(self, exc_type, exc_value, traceback):
    self.file.close()  # 总是关闭
    if exc_type is not None:
        logging.warning("File operation failed: %s", exc_value)
    return False  # 不抑制异常

什么时候该用类定义上下文管理器,而不是 @contextlib.contextmanager?

当需要在实例中持久保存状态(比如连接池计数器、嵌套锁标记、多次 with 块间共享的缓冲区),就必须用类。装饰器方式生成的上下文管理器每次调用都是全新函数作用域,无法跨 with 块维持状态。

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载

典型使用场景:

  • 数据库连接池:__enter__ 获取连接,__exit__ 归还连接,同时更新内部 self._in_use 计数
  • 带重入保护的锁:用 self._lock_depth 记录嵌套层数,避免重复释放
  • 需要延迟初始化的资源:第一次 __enter__ 才创建对象,后续复用

注意:@contextlib.contextmanager 写起来快,但它的生成器函数里不能安全地 raise 异常再 yield —— 这会导致 StopIteration 被误判为上下文退出。

如何测试自定义上下文管理器是否真正可靠?

不能只测“正常流程”,必须覆盖异常路径。重点验证三件事:资源是否总被释放、异常是否按预期传播、多次嵌套是否稳定。

实操建议:

  • 用 pytest.raises() 配合 with 块,确认异常确实冒出(或被吞掉)
  • 在 __exit__ 里手动 raise ValueError,看是否会引发 RuntimeError: generator didn't stop(仅限装饰器方式)
  • 检查 __enter__ 返回值类型是否与 as 绑定目标一致(比如返回 self 却期望得到一个 file 对象)
  • 对带状态的管理器,做连续两次 with 块,验证内部计数/标志是否正确重置

最容易被忽略的是:__exit__ 中清理代码本身抛出异常时,会掩盖原始异常。务必在清理逻辑外层加 try/except,或确保清理操作是幂等且不会失败的。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3764

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21537

23

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

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

2023.08.04

2647

5

python eval
python eval

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

2023.08.04

2707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2103

5

热门下载

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

精品课程

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