Python Typing项目:关于存根包命名规范的最新解读
2025-07-10 22:49:47作者:凤尚柏Louis
在Python生态系统中,类型存根(Type Stubs)是用于为现有库提供静态类型信息的特殊文件。这些存根文件通常以.pyi为扩展名,包含函数签名、类定义等类型注解,帮助类型检查器(如mypy)理解代码的行为。
存根包命名规范的历史演变
长期以来,Python社区推荐使用types-<package>的命名约定来发布第三方存根包。这一惯例源于typeshed项目(Python标准库和流行第三方库类型存根的官方仓库)的实践。然而,这种命名方式实际上只适用于typeshed维护的存根包。
当前最佳实践
根据Python Typing项目的最新指导,对于非typeshed维护的第三方存根包,开发者应该避免使用types-前缀。这一变化的主要原因包括:
- 命名空间清晰性:
types-前缀应保留给typeshed维护的官方存根包 - 避免混淆:防止用户误认为非官方存根包是typeshed项目的一部分
- 维护责任明确:区分官方维护和社区维护的存根包
对开发者的建议
如果你是存根包的维护者,应当:
- 为你的存根包选择一个独特的名称,避免使用
types-前缀 - 在包描述中明确说明这是第三方类型存根
- 遵循PEP 561关于类型存根分发的规范
- 确保与原始包的版本兼容性
技术实现细节
在实现存根包时,需要注意:
- 包结构中必须包含
py.typed标记文件 - 存根文件应放在正确的包目录结构中
- 类型注解应尽可能完整和准确
- 考虑使用
__all__来控制类型的导出
未来发展方向
Python社区正在探索更好的类型存根分发机制,可能包括:
- 更完善的包命名空间支持
- 改进的类型存根发现机制
- 增强与原始包的版本协调
- 更好的工具链支持
通过遵循这些最佳实践,开发者可以确保他们的类型存根包能够更好地服务于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 StartedRust0218
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0139
uni-appA cross-platform framework using Vue.jsJavaScript09
GLM-5.2智谱开源 GLM-5.2,这是针对长文本任务的最新旗舰模型。相较于前代产品 GLM-5.1,它在长文本任务处理能力上实现了显著飞跃,并且首次在稳定的 100 万 token 上下文中提供这一能力。Jinja00
SwanLab⚡️SwanLab - an open-source, modern-design AI training tracking and visualization tool. Supports Cloud / Self-hosted use. Integrated with PyTorch / Transformers / LLaMA Factory / veRL/ Swift / Ultralytics / MMEngine / Keras etc.Python00
tiny-universe《大模型白盒子构建指南》:一个全手搓的Tiny-UniverseJupyter Notebook03
项目优选
收起
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
Ascend Extension for PyTorch
Python
758
968
昇腾LLM分布式训练框架
Python
186
231
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
699
1.4 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
879
2.03 K
暂无描述
Dockerfile
780
5.08 K
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
70
22
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
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
2.09 K
217