setuptools 自动包含类型存根文件的注意事项
2025-06-29 21:24:49作者:范靓好Udolf
在Python项目开发中,类型提示(Type Hints)已经成为提高代码可维护性和开发体验的重要工具。setuptools作为Python生态中广泛使用的打包工具,从69.0.0版本开始提供了自动包含类型信息文件(.pyi和py.typed)的实验性功能,这符合PEP 561规范。
然而,开发者需要注意一个关键细节:setuptools的自动类型存根文件包含功能仅对Python包(package)有效,对单独的模块(module)无效。这意味着如果你的项目结构是单个.py文件或Cython扩展模块,而没有包含在包结构中(即没有__init__.py文件),那么即使存在对应的.pyi类型存根文件,setuptools也不会自动将其包含在分发包中。
这个行为的设计考虑可能源于Python包管理的惯例,通常类型提示更常用于包而非独立模块。对于独立模块的情况,开发者需要通过以下两种方式之一显式包含类型存根文件:
- 在项目中添加__init__.py文件,将模块转换为包结构
- 在MANIFEST.in文件中明确指定要包含的.pyi文件
对于使用Cython扩展的项目,这个问题尤为常见,因为Cython项目通常以独立扩展模块的形式存在。开发者需要特别注意项目结构设计,确保类型提示文件能够被正确包含在分发包中。
setuptools团队将此功能标记为"实验性",意味着未来版本可能会调整其行为。开发者在使用时应关注版本更新日志,并在项目配置中做好相应的兼容性处理。
理解这一机制有助于开发者在构建类型提示丰富的Python项目时,确保类型信息能够正确分发,从而为下游用户提供更好的开发体验和工具支持。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0150- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0111
项目优选
收起
暂无描述
Dockerfile
731
4.74 K
Ascend Extension for PyTorch
Python
610
794
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1 K
1.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
433
392
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
145
237
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.16 K
150
暂无简介
Dart
983
252
Oohos_react_native
React Native鸿蒙化仓库
C++
348
401
昇腾LLM分布式训练框架
Python
166
198
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.67 K
987