如何在Python中使用contextlib.contextmanager自定义上下文管理器?

风芳同学_3278

风芳同学_3278

2026-11-03

383人浏览

原创

使用@contextlib.contextmanager需确保yield前后分别对应__enter__和__exit__逻辑:yield前初始化并返回资源,yield后必须用try/finally做清理;yield仅一次且不可return;异常处理需用except捕获并显式re-raise;不支持异步,异步场景须用asynccontextmanager。

如何在python中使用contextlib.contextmanager自定义上下文管理器?

直接用 @contextlib.contextmanager 装饰器写生成器函数,就能快速实现上下文管理器,但 yield 前后逻辑必须严格对应 __enter__ 和 __exit__ 的职责,否则资源会泄漏或异常被吞。

yield 之前是 enter 逻辑,之后是 exit 逻辑

装饰器把生成器拆成两段:yield 左侧执行完就返回给 with 语句的 as 变量;yield 右侧(包括 finally 块)负责清理。不能在 yield 后面写普通 return,也不能漏掉异常处理。

  • yield 必须出现且只能出现一次,否则会报 RuntimeError: generator didn't yield
  • 如果需要返回值给 as,yield 后面跟表达式,比如 yield resource
  • 清理逻辑要包在 try/finally 里,否则遇到异常时不会执行 —— @contextmanager 不自动加 finally
from contextlib import contextmanager
<p>@contextmanager
def open_file(path):
f = None
try:
f = open(path, 'r')
yield f  # ← 这个值赋给 as 后面的变量
finally:
if f is not None:
f.close()  # ← 必须放 finally,否则异常时跳过
</p>

捕获并处理异常要用 except,不是 if

如果想在退出时根据是否发生异常做不同处理(比如只在出错时记录日志),得用 except 捕获,再重新 raise,不能靠判断某个变量是否为 None。

Python Dependency Candidate Fetcher 2
Python Dependency Candidate Fetcher 2

根据包的能力以及 Jupyter 环境中的导入语句,从候选列表中挑选最适合用户表格工作流的 Python 包。

下载
  • __exit__ 接收三个参数:exc_type, exc_value, traceback,@contextmanager 把它们传进生成器的 except 块
  • 若在 except 中 return True,异常会被吞掉;return None 或 False 则继续传播
  • 不要试图在 yield 后检查 sys.exc_info(),此时异常上下文已丢失
@contextmanager
def log_on_failure():
    try:
        yield
    except Exception as e:
        print(f"Failed with {type(e).__name__}")
        raise  # ← 显式 re-raise,否则异常消失

不支持异步,别和 async/await 混用

@contextmanager 生成的是同步上下文管理器,套在 async with 里会直接报 TypeError: object __aenter__ is not callable。

  • 异步场景必须用 @contextlib.asynccontextmanager(Python 3.7+)
  • 即使生成器函数本身用了 await,只要没用 asynccontextmanager,就不是合法的异步上下文管理器
  • 同步装饰器无法识别 async def,会抛 TypeError: cannot decorate asynchronous function

最常被忽略的是 finally 的必要性——很多人只写 try/yield,以为 yield 后的代码总会执行,其实不是。异常路径下,没有 finally 就等于没清理。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1851

4

python能做什么
python能做什么

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

2023.07.25

5024

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30177

23

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

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

2023.08.04

3587

5

python eval
python eval

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

2023.08.04

3607

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2803

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习