-
Notifications
You must be signed in to change notification settings - Fork 198
Open
Description
问题描述:
目前该库缺少对应的 .pyi 类型存根文件(PEP 484),导致在支持类型检查的 IDE(如 VSCode 等)中无法获得正确的代码补全、参数提示和静态类型检查。这显著影响了开发体验和代码可靠性。
复现步骤:
- 在 Python 中导入 cityflow 。
- 在 IDE 中尝试使用该模块的类或函数,观察是否有代码补全和类型提示。
- 确认模块目录下是否缺少 .pyi 文件。
期望行为:
- 提供对应的 .pyi 存根文件,明确标注函数签名、参数类型、返回类型及类的公共接口。
- 支持主流类型检查工具(如 mypy、pyright)和 IDE 的智能感知功能。
建议的解决方案:
- 按照 PEP 484 规范编写 .pyi 文件,并与模块一起分发。
- 或者,考虑在源码仓库中提供 stubs 目录,并通过 py.typed 文件标记类型支持(PEP 561)。
环境信息:
- 操作系统:MacOS 15
- Python 版本:3.9
- 库版本:0.1
- IDE:VSCode 1.108.1
如果需要,我愿意协助贡献初步的 .pyi 文件草案。
Metadata
Metadata
Assignees
Labels
No labels