Pyright类型检查器中异步上下文管理器装饰器的正确使用方式
2025-05-16 10:52:29作者:裴麒琰
在Python类型检查器Pyright中,使用@asynccontextmanager
装饰器定义异步上下文管理器时,开发者可能会遇到类型检查错误。本文将深入分析这一现象的原因,并提供正确的解决方案。
问题现象
当开发者尝试在类型存根(stub)文件中使用@asynccontextmanager
装饰器定义异步上下文管理器时,Pyright会报告类型不匹配错误。错误信息表明返回类型Coroutine[Any, Any, AsyncIterator[int]]
与期望的AsyncIterator[_T_co]
不兼容。
根本原因
这一现象并非Pyright的bug,而是有意为之的设计。主要原因有两点:
-
yield语句的语义转换:Python中yield语句的存在会改变函数的返回类型语义。虽然Python类型规范尚未明确描述这一转换,但主流类型检查器(Pyright、mypy等)都采用了一致的处理方式。
-
存根文件装饰器限制:Python类型规范明确定义了存根文件中支持的装饰器列表,而
@contextlib.asynccontextmanager
并不在其中。对于不在支持列表中的装饰器,开发者需要手动应用装饰器效果并在存根文件中正确反映。
解决方案
方法一:使用内部类型定义
对于私有存根文件,可以直接使用contextlib模块中的内部类型定义:
from contextlib import _AsyncGeneratorContextManager
def async_simple_stub() -> _AsyncGeneratorContextManager[int, None]: ...
需要注意的是,这种方法使用了私有类,不适合用于公开发布的存根库。
方法二:复制类型定义
对于公开的存根库,更规范的做法是从typeshed存根中复制相关类型定义:
from typing import AsyncIterator, Generic, TypeVar
T = TypeVar('T')
class _AsyncGeneratorContextManager(Generic[T]):
async def __aenter__(self) -> T: ...
async def __aexit__(self, *args: object) -> None: ...
def async_simple_stub() -> _AsyncGeneratorContextManager[int]: ...
同步上下文管理器的情况
值得注意的是,同步上下文管理器(@contextmanager
)在存根文件中不会出现类似问题,因为其行为已被类型系统更好地捕获。
最佳实践建议
- 在存根文件中尽量避免使用复杂装饰器
- 对于必须使用的装饰器效果,直接在类型注解中体现
- 保持与typeshed存根的一致性
- 对于公开库,优先使用方法二确保类型安全
通过理解类型系统的这些特性,开发者可以更准确地定义异步上下文管理器的类型注解,避免类型检查错误。
登录后查看全文
热门项目推荐
相关项目推荐
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0269get_jobs
💼【AI找工作助手】全平台自动投简历脚本:(boss、前程无忧、猎聘、拉勾、智联招聘)Java00AudioFly
AudioFly是一款基于LDM架构的文本转音频生成模型。它能生成采样率为44.1 kHz的高保真音频,且与文本提示高度一致,适用于音效、音乐及多事件音频合成等任务。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile08
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp课程视频测验中的Tab键导航问题解析2 freeCodeCamp音乐播放器项目中的函数调用问题解析3 freeCodeCamp论坛排行榜项目中的错误日志规范要求4 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析5 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析6 freeCodeCamp全栈开发课程中React实验项目的分类修正7 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析8 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析9 freeCodeCamp课程页面空白问题的技术分析与解决方案10 freeCodeCamp博客页面工作坊中的断言方法优化建议
最新内容推荐
PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 JDK 8u381 Windows x64 安装包:企业级Java开发环境的完美选择 QT连接阿里云MySQL数据库完整指南:从环境配置到问题解决 SAP S4HANA物料管理资源全面解析:从入门到精通的完整指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 OpenSSL 3.3.0资源下载指南:新一代加密库的全面解析与部署教程 基恩士LJ-X8000A开发版SDK样本程序全面指南 - 工业激光轮廓仪开发利器 ZLIB 1.3 静态库 Windows x64 版本:高效数据压缩解决方案完全指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 全球36个生物多样性热点地区KML矢量图资源详解与应用指南
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
148
1.95 K

deepin linux kernel
C
22
6

React Native鸿蒙化仓库
C++
192
274

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
515