news 2026/1/26 9:41:33

python之asynccontextmanager学习

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
python之asynccontextmanager学习

一、asynccontextmanager的作用

asynccontextmanager是 Python 标准库contextlib模块提供的异步上下文管理器装饰器,专门用于简化异步场景下上下文管理器的实现。

它的核心特性

  • 装饰异步生成器函数(使用async def定义,包含yield关键字)
  • 自动封装异步上下文管理器的__aenter__()和__aexit__()方法(无需手动实现这两个魔法方法)
  • 配合async with语句使用,实现异步资源的自动获取与释放

二、适用场景

当你在异步代码中需要管理「需要先获取、使用后必须释放 / 清理」的资源时,asynccontextmanager是最优选择,典型场景包括:

  • 异步网络连接:异步数据库连接(如asyncmy操作 MySQL)、异步 Redis 连接、异步 HTTP 客户端连接,自动建立 / 关闭连接
  • 异步文件操作:异步读写文件(如aiofiles),自动打开 / 关闭文件句柄
  • 异步锁 / 信号量:异步编程中的asyncio.Lock,自动获取 / 释放锁,避免死锁
  • 异步资源初始化 / 销毁:如 FastAPI 的异步应用生命周期管理(启动时初始化资源,关闭时清理资源)

简单来说:异步场景 + 资源需要自动管理(获取 + 释放),就用asynccontextmanager。

三、示例

示例中会用到异步文件操作库aiofiles(演示异步资源管理),先安装:

pip install aiofiles

完整代码

# 1. 导入必要模块importasyncioimportaiofilesfromcontextlibimportasynccontextmanager# 2. 使用@asynccontextmanager装饰异步生成器,实现异步上下文管理器@asynccontextmanagerasyncdefasync_file_manager(file_path:str,mode:str="r",encoding:str="utf-8"):""" 异步文件管理器:自动打开/关闭文件,封装异步文件操作的资源管理 :param file_path: 文件路径 :param mode: 文件打开模式(r/w/a等) :param encoding: 文件编码 """# -------- 对应__aenter__()方法:获取/初始化资源(支持await异步操作) --------file_handle=Nonetry:# 异步打开文件(aiofiles提供异步文件操作,需要await)file_handle=awaitaiofiles.open(file_path,mode=mode,encoding=encoding)print(f"✅ 异步打开文件:{file_path}(模式:{mode})")# 关键:yield资源给async with语句使用(类似return,但会保留函数状态)yieldfile_handle# -------- 对应__aexit__()方法:释放/清理资源(无论是否发生异常,都会执行) --------finally:iffile_handle:# 异步关闭文件(需要await)awaitfile_handle.close()print(f"❌ 异步关闭文件:{file_path}")# 3. 使用异步上下文管理器(配合async with语句)asyncdefmain():# 示例1:异步读取文件(先创建一个测试文件test.txt,写入一些内容)test_file_path="test.txt"# 第一步:先异步写入测试内容(使用async_file_manager)asyncwithasync_file_manager(test_file_path,mode="w")asf:awaitf.write("Hello, asynccontextmanager!\n")awaitf.write("这是异步文件写入测试\n")# 第二步:异步读取文件内容(再次使用async_file_manager)asyncwithasync_file_manager(test_file_path,mode="r")asf:content=awaitf.read()print("\n📄 文件内容:")print(content)# 4. 运行异步主函数if__name__=="__main__":asyncio.run(main())

四、关键细节解析

异步生成器函数的结构

@asynccontextmanager装饰的函数必须满足:

  • 用async def定义(异步函数)
  • 包含且仅包含一个yield关键字(分割「资源获取」和「资源释放」逻辑)
  • yield之前的代码:在进入async with时执行(对应__aenter__),负责获取 / 初始化资源
  • yield之后的代码:在离开async with时执行(对应__aexit__),通常放在finally块中,确保无论是否发生异常(如文件读写报错),都能释放资源

async with的使用语法

asyncwith异步上下文管理器(参数)as资源变量:# 操作资源(支持await异步操作)await资源变量.xxx()

异常处理(可选扩展)

@asynccontextmanagerasyncdefasync_file_manager(file_path:str,mode:str="r",encoding:str="utf-8"):file_handle=Nonetry:file_handle=awaitaiofiles.open(file_path,mode=mode,encoding=encoding)print(f"✅ 异步打开文件:{file_path}(模式:{mode})")yieldfile_handle# 此处抛出的异常会被传递到async with代码块exceptExceptionase:print(f"❌ 操作文件出错:{e}")raise# 可选:重新抛出异常,让调用方处理finally:iffile_handle:awaitfile_handle.close()print(f"❌ 异步关闭文件:{file_path}")

五、扩展场景:FastAPI 异步生命周期管理

asynccontextmanager在 Web 框架中应用广泛,例如 FastAPI 中用于管理应用的异步生命周期:

fromfastapiimportFastAPIfromcontextlibimportasynccontextmanagerimportasyncio# 定义异步生命周期管理器@asynccontextmanagerasyncdefapp_lifespan(app:FastAPI):# 应用启动时:初始化异步资源(如异步数据库连接池)print("🚀 FastAPI应用启动,初始化异步资源...")awaitasyncio.sleep(1)# 模拟异步初始化操作yield# 应用运行中,传递控制权# 应用关闭时:清理异步资源(如关闭数据库连接池)print("🛑 FastAPI应用关闭,清理异步资源...")awaitasyncio.sleep(1)# 模拟异步清理操作# 传入生命周期管理器创建FastAPI应用app=FastAPI(lifespan=app_lifespan)# 定义接口@app.get("/")asyncdefroot():return{"message":"Hello, FastAPI + asynccontextmanager!"}
版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/1/20 8:49:22

CUDA out of memory怎么办?Image-to-Video显存优化方案

CUDA out of memory怎么办?Image-to-Video显存优化方案 问题背景与挑战 在使用基于 I2VGen-XL 模型的 Image-to-Video 图像转视频生成器 进行二次开发时,开发者“科哥”遇到了一个典型但棘手的问题:CUDA out of memory(显存溢出&a…

作者头像 李华
网站建设 2026/1/24 12:26:25

能否添加背景音乐?后处理功能开发中,支持音频混音导出

能否添加背景音乐?后处理功能开发中,支持音频混音导出 🎧 语音合成的进阶需求:从“能说”到“好听” 当前,基于 Sambert-Hifigan 的中文多情感语音合成系统已实现高质量、低延迟的文本转语音能力。用户可通过 WebUI 或…

作者头像 李华
网站建设 2026/1/22 16:32:36

STEP文件与PRT文件的区别

STEP文件和PRT文件是工程设计和制造领域中两种常见的三维模型文件格式,它们的主要区别在于通用性和软件关联性。 一句话总结: STEP文件是通用交换格式,用于在不同CAD软件之间安全地传输几何数据。PRT文件是Creo/ProE的专用原生格式&#xff0…

作者头像 李华
网站建设 2026/1/21 11:36:09

华为OD技术面真题 - 计算机网络 - 3

文章目录 介绍一下HTTP报文结构HTTP请求方法有哪些,分别代表什么含义HTTP响应状态码分为哪几类HTTP和HTTPS的区别HTTP请求为什么是无状态的如何使用HTTP实现有状态访问 介绍一下HTTP报文结构 HTTP请求头结构图: 请求报文整体分为四个部分:…

作者头像 李华
网站建设 2026/1/16 4:51:24

在 ABAP Cloud 里正确使用系统字段 SYST:从 SY 到 Context 与 XCO 的迁移指南

很多 ABAP 开发者对 SY 这套系统字段又爱又恨:它随处可用、运行时自动刷新,写日志、判定流程、拼消息都很顺手。可一旦进入 ABAP Cloud(包括 SAP BTP 上的 ABAP environment,以及 S/4HANA Cloud 的 ABAP for Cloud Development 语法版本),你会明显感到同一段代码在不同环…

作者头像 李华