讲师中心 微信公众号
AI工具推荐 视频效率加速

如何让Python对象支持with语句_实现上下文管理器协议的步骤

轻墨大大_5602

轻墨大大_5602

发布时间:2026-04-30 08:39:48

|

972人浏览过

|

来源于php中文网

原创

必须同时实现 enter 和 exit 方法,因 with 语句严格检查二者缺一不可;仅定义 enter 会报 AttributeError: exit__;__exit 须接收三个异常参数并按需返回 True/False 控制异常传播;@contextmanager 要求单次 yield 且需 try/finally 保证清理。

如何让python对象支持with语句_实现上下文管理器协议的步骤

必须实现 __enter__ 和 __exit__ 两个方法,缺一不可;否则 with 语句会抛出 AttributeError: __enter__ 或类似错误。

为什么只加 __enter__ 不行?

Python 解释器在遇到 with 语句时,会**严格检查对象是否同时具备这两个方法**。即使你只关心“进入时初始化”,不写 __exit__ 也会直接报错——它不是可选的“清理钩子”,而是协议的强制组成部分。

常见错误现象:

  • 定义了 __enter__ 但忘了写 __exit__ → 报 AttributeError: __exit__
  • 把 __exit__ 写成 __leave__ 或拼错名 → 同样报 __exit__ 缺失
  • 方法定义在父类但被子类覆盖且没调用 super().__exit__ → 子类实例实际无有效 __exit__

__exit__ 的三个参数和返回值怎么设?

__exit__(self, exc_type, exc_val, exc_tb) 的设计目标是:无论代码块是否异常,都确保资源释放;同时允许你选择是否吞掉异常。

立即学习“Python免费学习笔记(深入)”;

实操建议:

Forge — Python Developer
Forge — Python Developer

Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...

下载
  • 若只需保证清理(最常见),__exit__ 末尾加 return None 或直接不写 return(等价于 return False)→ 异常照常抛出
  • 若想静默忽略特定异常(如 IOError),在内部判断 exc_type is IOError 后 return True
  • 切勿在 __exit__ 中裸写 except: 或 raise —— 它本就是异常处理入口,重复捕获易掩盖问题
  • 参数为 (None, None, None) 表示无异常;只要任一非 None,说明发生了异常

用 @contextmanager 装饰器快速实现,但要注意 yield 规则

比起手写类,contextlib.contextmanager 是更轻量的选择,但它依赖生成器协议,对结构敏感。

关键约束:

  • 被装饰函数必须是 generator(含 yield)
  • yield **只能出现一次**,且必须产出你要绑定给 as 变量的值
  • yield 前的代码 = __enter__ 逻辑,yield 后的 finally 块 = __exit__ 逻辑
  • 若 yield 后没有 finally,资源不会被释放 → 必须用 try/finally 包裹清理动作

示例片段:

from contextlib import contextmanager
<p>@contextmanager
def db_connection():
conn = acquire_db()  # <strong>enter</strong> 部分
try:
yield conn        # 绑定给 as 后的变量
finally:
conn.close()      # <strong>exit</strong> 部分,必执行

自定义类 vs @contextmanager:性能与复用差异

两者语义等价,但底层开销和适用场景不同。

选择依据:

  • 需要保存状态(如重试次数、缓存句柄)→ 用类,方便在 self 上存属性
  • 逻辑简单、一次性使用(如临时切换目录、打日志标记)→ @contextmanager 更紧凑
  • 高频调用(如每毫秒创建一个上下文)→ 类实例略快(无生成器状态机开销),但差异通常可忽略
  • 要支持装饰器用法(如 @my_context 修饰函数)→ 必须继承 contextlib.ContextDecorator,此时类更直接

容易被忽略的一点:__enter__ 的返回值决定 as 变量内容,而 @contextmanager 中 yield 的值就是它——如果 yield 后多加了个 print,不影响返回值;但如果 yield 写成 yield x; yield y,会直接报 RuntimeError: generator didn't yield。

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

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

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

1731

2023.07.20

python能做什么
python能做什么

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

4424

2023.07.25

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

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

1709

2023.07.31

python教程
python教程

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

25957

2023.08.03

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

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

3147

2023.08.04

python eval
python eval

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

3167

2023.08.04

scratch和python区别
scratch和python区别

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

1183

2023.08.11

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

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

596

2023.08.10

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn