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项目时,确保类型信息能够正确分发,从而为下游用户提供更好的开发体验和工具支持。
登录后查看全文
热门项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C037
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C00
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0115
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
26
10
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
433
3.29 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
689
352
Ascend Extension for PyTorch
Python
237
271
暂无简介
Dart
690
162
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
仓颉编程语言运行时与标准库。
Cangjie
143
881
React Native鸿蒙化仓库
JavaScript
266
327
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
211
115
仓颉编译器源码及 cjdb 调试工具。
C++
138
869