怎样在Python中实现支持异步上下文管理的类

陌伟君_3472

陌伟君_3472

2026-10-08

524人浏览

原创

async with 语句要求类必须实现 aenter 和 aexit 两个异步方法,且均需用 async def 定义;__aenter__ 必须返回可等待对象(通常为 self),__aexit__ 必须接收 exc_type、exc_value、traceback 三个参数并支持异常抑制。

怎样在python中实现支持异步上下文管理的类

async with 语句要求类实现哪几个特殊方法

Python 的 async with 不是普通 with 的语法糖,它明确要求类必须实现 __aenter__ 和 __aexit__ 两个异步方法,且都必须用 async def 定义。缺任何一个,运行时会直接报 AttributeError: __aenter__ 或类似错误。

注意:不能只写 __enter__/__exit__ 试图“降级兼容”——async with 完全不看这两个同步方法。

  • __aenter__ 必须返回一个可等待对象(通常就是 self 或某个资源),不能返回普通值
  • __aexit__ 必须接收三个参数:exc_type、exc_value、traceback,和同步版本一致,但函数本身必须是 async
  • 如果 __aexit__ 返回真值(如 True),会抑制异常;返回 None 或假值则正常传播

典型实现:封装一个异步 HTTP 客户端连接

最常见需求是管理异步网络连接(比如 aiohttp 的 ClientSession),此时上下文要负责创建和关闭会话:

import aiohttp
<p>class AsyncHttpClient:
def <strong>init</strong>(self, base_url: str):
self.base_url = base_url
self.session = None</p><pre class="brush:python;toolbar:false;">async def __aenter__(self):
    self.session = aiohttp.ClientSession(base_url=self.base_url)
    return self

async def __aexit__(self, exc_type, exc_value, traceback):
    if self.session:
        await self.session.close()

async def get(self, path: str):
    async with self.session.get(path) as resp:
        return await resp.text()

使用时:async with AsyncHttpClient("https://api.example.com") as client: —— 这里 __aenter__ 启动会话,__aexit__ 确保关闭,哪怕中间抛出异常也安全。

关键点:不要在 __aenter__ 里做耗时阻塞操作(如 time.sleep),否则会卡住整个事件循环。

python-pro
python-pro

高级 Python 特性、异步编程、性能调优、静态类型、内存管理、Python 内部机制及生态库方面的专家。

下载

为什么不能在 __aenter__ 里直接 await open()?

有些同学尝试在 __aenter__ 中直接 await asyncio.open_connection(...) 并把返回的 reader/writer 赋给 self,结果发现 async with 块内无法访问这些属性。问题出在返回值上:

  • 如果 __aenter__ 返回的是 (reader, writer) 元组,那 async with obj as x: 中的 x 就是这个元组,不是 obj
  • 若想保持实例可用,必须让 __aenter__ 返回 self(并确保内部状态已就绪)
  • 更安全的做法是把连接逻辑拆成显式方法(如 async def connect(self):),在 __aenter__ 中调用它,再返回 self

否则容易出现 “AttributeError: 'tuple' object has no attribute 'readline'” 这类错误。

与同步上下文管理器共存时的陷阱

如果一个类既要支持 with 又要支持 async with,不能简单地复用逻辑。例如下面这种写法是错的:

# ❌ 错误:__enter__ 返回了 awaitable,同步 with 会崩溃
def __enter__(self):
    return self.__aenter__()  # 返回 coroutine 对象,不是实际资源

正确做法是彻底分离:

  • 同步路径走 __enter__/__exit__,用 requests 或 socket
  • 异步路径走 __aenter__/__aexit__,用 aiohttp 或 asyncio.open_connection
  • 避免在同一个类里混用 await 和阻塞调用,否则可能引发 RuntimeError: "cannot be used from a thread"

异步上下文管理器的核心约束很硬:所有涉及 I/O 的清理动作,都必须在 __aexit__ 里用 await 完成,没有例外。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4184

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24217

23

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

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

2023.08.04

2967

5

python eval
python eval

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

2023.08.04

2987

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

2323

5

热门下载

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

精品课程

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