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项目时,确保类型信息能够正确分发,从而为下游用户提供更好的开发体验和工具支持。
登录后查看全文
热门项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin08
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
533
3.75 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
67
20
暂无简介
Dart
773
191
Ascend Extension for PyTorch
Python
342
406
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
886
596
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
React Native鸿蒙化仓库
JavaScript
303
355
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
336
178