如何在Python中自定义ContextManager_使用contextlib.contextmanager

小萱小哥_9930

小萱小哥_9930

2026-05-07

746人浏览

原创

@contextmanager要求函数必须含且仅含一个yield,yield前对应__enter__、后对应__exit__;yield不可被条件包裹,其后需用try/finally保证清理,并通过sys.exc_info()判断异常。

如何在python中自定义contextmanager_使用contextlib.contextmanager

contextlib.contextmanager 要求函数必须用 yield 分隔前后逻辑

它不是装饰任意函数都能变上下文管理器的工具——contextlib.contextmanager 本质是把一个生成器函数包装成 __enter__ 和 __exit__ 的实现。关键约束是:函数体内必须有且仅有一个 yield,且 yield 前的部分对应 __enter__,之后的部分对应 __exit__(即异常处理和清理逻辑)。

常见错误是写成普通函数、或 yield 多次、或 yield 在 if/else 分支里,这时会报 RuntimeError: generator didn't yield 或更隐蔽的 StopIteration。

  • yield 必须存在,且不能被条件语句包裹(比如不能写 if flag: yield)
  • yield 后面可以跟一个值,它将成为 with 语句中 as 绑定的对象
  • yield 之后的代码只在退出时执行,无论是否发生异常;若需区分正常退出与异常退出,要手动检查 sys.exc_info()

如何在 yield 后捕获并处理异常

默认情况下,contextlib.contextmanager 把异常原样抛出。如果你需要拦截、记录或压制异常(比如文件关闭失败不中断主流程),就得在 yield 后显式处理 sys.exc_info()。

注意:yield 本身不接收参数,但 __exit__ 阶段能拿到三元组 (exc_type, exc_value, traceback),所以得靠 sys.exc_info() 拿到当前异常上下文。

  • 必须在 try...except 中调用 yield,否则 yield 后的代码根本不会执行
  • yield 后应立即检查 sys.exc_info()[0] 是否为 None 来判断是否有异常
  • 若返回 True 表示已处理异常,不再向上抛;返回 None 或 False 则继续传播
from contextlib import contextmanager
import sys
<p>@contextmanager
def suppress_file_error():
try:
yield
finally:
exc_type, exc_val, tb = sys.exc_info()
if exc_type is not None and "Permission" in str(exc_val):
print("忽略权限错误")
return True  # 抑制该异常
</p>

@contextmanager 装饰的函数不能带额外参数?其实可以,但要注意调用方式

它可以带参数,但这些参数要在装饰器外层传入——也就是说,你写的不是上下文管理器本身,而是一个“返回上下文管理器的工厂函数”。这和直接定义类实现 __enter__/__exit__ 的行为一致,但容易混淆。

Python Use Agent
Python Use Agent

智能执行Python任务,自动生成、执行代码并反馈结果,无需额外配置,兼容旧命令。

下载

典型误用是写成 @contextmanager\ndef my_cm(arg): ... 然后直接 with my_cm(123): —— 这没问题;但若漏掉括号,写成 with my_cm: 就会报 TypeError: object is not callable,因为此时 my_cm 是个未调用的生成器函数对象。

  • 带参的 @contextmanager 函数必须被调用(加括号),返回值才是真正的上下文管理器
  • 参数不能是可变默认值(如 def f(lst=[])),避免跨 with 块状态污染
  • 若需复用带参逻辑,推荐封装一层工厂函数,比在 yield 前做复杂初始化更清晰

对比 class 实现,@contextmanager 在什么场景下更合适

当资源生命周期简单、无状态共享、且不需要在 __enter__ 和 __exit__ 之间传递大量中间变量时,@contextmanager 更轻量。但它无法像类那样保存实例属性,所有数据都得靠闭包或外部作用域维持。

一旦你需要多次重用同一个上下文管理器实例(比如设置超时、重试次数等配置),或者要在 __exit__ 中访问 __enter__ 返回的对象内部状态,class 方式就更可控。

  • 适合一次性资源:临时目录、日志级别切换、数据库连接池借用
  • 不适合跨阶段强状态依赖:比如 __enter__ 创建 socket,__exit__ 要发心跳包,就得靠类存 socket 引用
  • 调试困难:yield 分割逻辑导致断点跳转不直观,异常栈也比 class 实现深一层

真正麻烦的从来不是怎么写出来,而是别人读代码时得在 yield 上下反复切视角,还容易漏掉 finally 里的清理逻辑。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4124

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

23857

23

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

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

2023.08.04

2927

5

python eval
python eval

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

2023.08.04

2947

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

2283

5

热门下载

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

精品课程

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