async with 要求类必须同时实现 __aenter__ 和 __aexit__ 两个协程方法;嵌套时内层先退出,异常传播规则与同步 with 一致,且各层 __aexit__ 均会被调用以保障清理。

Python 中 async with 要求类实现哪些方法
必须同时提供 __aenter__ 和 __aexit__ 两个协程方法,缺一不可。仅定义 __enter__/__exit__ 不会生效,async with 会直接报 AttributeError: __aenter__。
嵌套的关键在于:外层 __aenter__ 返回的对象本身也要支持 async with,即它内部也得有 __aenter__ 和 __aexit__ —— 这和同步嵌套对 __enter__ 返回值的要求一致,只是全部换成异步版本。
嵌套时 __aexit__ 的调用顺序和异常传播规则
和同步 with 完全一致:内层先退出,外层后退出;若内层 __aexit__ 返回 True,则吞掉异常,外层收不到;否则异常继续向外抛出。
注意点:
-
__aexit__必须是协程函数(用async def),不能只返回True,否则运行时报TypeError: object NoneType can't be used in 'await' expression - 如果内层
__aexit__没有return True且抛出新异常,该异常会覆盖原始异常(和同步行为一样) - 所有嵌套层级的
__aexit__都会被调用,无论中间是否出错 —— 这是资源清理的保障
实际嵌套示例:数据库连接 + 事务
典型场景:外层管理连接池生命周期,内层管理事务边界。两者都需异步初始化和清理。
【极品模板】出品的一款功能强大、安全性高、调用简单、扩展灵活的响应式多语言企业网站管理系统。 产品主要功能如下: 01、支持多语言扩展(独立内容表,可一键复制中文版数据) 02、支持一键修改后台路径; 03、杜绝常见弱口令,内置多种参数过滤、有效防范常见XSS; 04、支持文件分片上传功能,实现大文件轻松上传; 05、支持一键获取微信公众号文章(保存文章的图片到本地服务器); 06、支持一键
class AsyncConnection:
async def __aenter__(self):
self.conn = await connect_db()
return self
async def __aexit__(self, *exc):
await self.conn.close()class AsyncTransaction:
def init(self, conn):
self.conn = conn
async def __aenter__(self):
self.tx = await self.conn.begin()
return self
async def __aexit__(self, *exc):
if exc[0] is None:
await self.tx.commit()
else:
await self.tx.rollback()使用:
async with AsyncConnection() as conn:
async with AsyncTransaction(conn) as tx:
await tx.execute("INSERT ...")
这里 AsyncConnection.__aenter__ 返回 self,而 self 是 AsyncTransaction 的合法构造参数;AsyncTransaction 自身又实现了完整异步上下文协议 —— 嵌套成立。
容易被忽略的细节:返回值类型与 awaitable 兼容性
Python 不强制要求 __aenter__ 返回 Awaitable,但它返回的值将被用于下一层 async with 的目标对象。所以:
- 若你希望嵌套中某一层“透传”资源(比如让外层连接直接暴露为内层可用对象),
__aenter__就得返回一个已具备__aenter__/__aexit__的实例,而不是原始连接对象(如aiohttp.ClientSession本身不支持async with嵌套) - 不要在
__aenter__里返回await xxx的结果并期望它自动支持嵌套 —— 它是否可嵌套,只取决于它自己有没有实现异步上下文协议 - 调试时可检查
hasattr(obj, '__aenter__')和hasattr(obj, '__aexit__'),比看文档更快定位问题
嵌套本身不难,难的是每一层的生命周期责任划分清楚:谁开、谁关、谁捕异常、谁传资源 —— 这些逻辑一旦错位,__aexit__ 就可能被跳过或重复调用。









