如何为pythonnet导入的.NET库添加Python类型提示?
解决方案汇总
1. 调整存根文件目录结构,符合PEP 561规范
PyCharm遵循PEP 561标准识别存根文件,你需要把生成的存根文件夹调整为符合规范的结构:
- 如果你打的Python包名为
your_package_name,存根文件需要放在your_package_name-stubs目录下,或者直接放在包的根目录下,和你实际的导入模块结构完全对齐 - 确保存根文件目录里存在空的
__init__.pyi文件,以及py.typed标记文件,py.typed直接放在包的根目录即可,用来告诉Python编辑器这个包支持类型提示
注意:
py.typed是纯空文件,不需要写任何内容,setuptools打包的时候要记得把这个文件和所有.pyi文件都包含进分发包,你可以在setup.py里添加package_data配置:package_data={ "your_package_name": ["py.typed", "**/*.pyi"] }, zip_safe=False
2. 手动配置PyCharm的存根识别路径
如果调整结构后还是识别不了,可以手动在PyCharm里添加存根目录为源根:
- 打开PyCharm的项目面板,找到你存stubs的文件夹
- 右键点击文件夹,选择
Mark Directory as->Sources Root - 重启PyCharm的索引:点击顶部菜单
File->Invalidate Caches...,选择Invalidate and Restart即可
3. 校验存根文件的导入路径匹配
要确保生成的stubs文件里的类、方法定义路径和你实际导入的路径完全一致:
- 比如你实际用
from your_package_name import YourDotnetClass导入,那存根文件里也要对应在your_package_name/__init__.pyi里声明该类,或者对应子模块的路径完全匹配 - 避免存根文件里出现多余的嵌套路径,比如不要把存根都放在
stubs/your_package_name/下而直接把stubs放进包,应该把your_package_name对应的存根目录直接放在包根目录
内容的提问来源于stack exchange,提问作者Karel Marik
相关产品推荐
相关产品推荐

