如何让Python对象支持上下文管理协议_实现__enter__与__exit__方法

夜静同学_3347

夜静同学_3347

2026-05-31

322人浏览

原创

__enter__ 不能用 yield,必须直接 return 值;__exit__ 参数用于异常处理,无异常时全为 none;@contextmanager 安全但需单次 yield;嵌套时 __exit__ 先内后外执行,异常由首个返回 true 的拦截。

如何让python对象支持上下文管理协议_实现__enter__与__exit__方法

为什么加了 __enter__ 还是报错 “RuntimeError: generator didn’t yield”

这是最常见的误用:把 __enter__ 写成生成器函数(用了 yield),但上下文管理协议不要求、也不支持生成器。Python 在调用 __enter__ 时期望它返回一个值,而不是一个生成器对象。

正确做法是直接 return 要进入上下文后暴露的对象:

class DatabaseConnection:
    def __init__(self, url):
        self.url = url
        self.conn = None
<pre class="brush:python;toolbar:false;">def __enter__(self):
    self.conn = connect(self.url)  # 假设 connect 是个连接函数
    return self.conn  # ✅ 直接 return,不是 yield

def __exit__(self, exc_type, exc_val, exc_tb):
    if self.conn:
        self.conn.close()

  • __enter__ 必须有返回值(哪怕返回 None),且不能是生成器
  • 如果想复用已有资源(比如单例连接池),return 那个实例即可,不用新构造
  • 返回值会绑定到 as 后的变量,不返回就导致 as x 中的 x 是 None

__exit__ 的三个参数到底怎么用,要不要都写上

__exit__ 接收 exc_type、exc_val、exc_tb —— 分别对应异常类型、异常实例、回溯对象。它们在无异常时全为 None。是否“都要写上”,取决于你是否要处理异常。

常见场景和写法:

  • 只做清理(如关闭文件、释放锁):参数名保留,但函数体里不检查异常,最后 return False(让异常继续传播)
  • 吞掉特定异常(比如忽略 FileNotFoundError):if exc_type is FileNotFoundError: return True
  • 记录异常但不压制:logging.exception("Context exit with error"),仍 return False
  • 绝对不要写 except: 块在里面 —— 这会让 __exit__ 变得难以调试

示例(安静地忽略连接已关闭的错误):

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
def __exit__(self, exc_type, exc_val, exc_tb):
    try:
        self.sock.close()
    except OSError as e:
        if exc_type is not None and "Bad file descriptor" in str(e):
            return True  # 吞掉这个已知噪音
    return False  # 其他异常照常抛出

用 @contextlib.contextmanager 装饰器替代手写方法,安全吗

安全,而且更轻量——但它底层仍是帮你生成了带 __enter__/__exit__ 的类。关键限制在于:函数体内必须有且仅有一个 yield,且 yield 的值就是 __enter__ 的返回值。

  • yield 之前的部分 = __enter__ 逻辑(支持 try/finally 做前置准备)
  • yield 之后的部分 = __exit__ 逻辑(自动接收异常三元组,可判断处理)
  • 如果 yield 后有代码但没异常发生,它会在正常退出时执行;如果有异常,也会执行,此时可通过检查 sys.exc_info() 或捕获 yield 表达式来响应

示例(带资源清理的简洁写法):

from contextlib import contextmanager
<p>@contextmanager
def temporary_dir():
tmp = mkdtemp()
try:
yield tmp  # ✅ yield 一次,且只 yield 一个值
finally:
rmtree(tmp)
</p>

注意:装饰器生成的对象不继承自任何类,无法被 isinstance(obj, ContextManager) 检测(除非显式注册),这点在类型检查或框架集成时容易被忽略。

多个上下文嵌套时,__exit__ 的执行顺序和异常传递规则

嵌套的 with 块按“先入后出”顺序触发 __exit__:最内层最先执行,最外层最后执行。异常只由第一个返回 True 的 __exit__ 拦截;其余即使也写了处理逻辑,也不会再收到该异常。

  • 如果内层 __exit__ 返回 False(默认行为),异常会透传给外层
  • 如果外层也返回 False,异常最终抛出;任一返回 True,则终止传播
  • 即便内层已处理异常,外层的 __exit__ 仍会被调用,只是三个参数全为 None
  • 所以清理逻辑(比如关文件、解锁)一定要放在 finally 块或无条件执行路径中,不能依赖异常参数判断是否执行

这点在实现带锁或事务的上下文管理器时特别关键:锁必须释放,不管有没有异常;事务必须回滚或提交,不能因为上层吞了异常就跳过。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1691

4

python能做什么
python能做什么

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

2023.07.25

4244

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24617

23

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

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

2023.08.04

3007

5

python eval
python eval

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

2023.08.04

3027

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2343

5

热门下载

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

精品课程

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