自动创建.pyi文件？

Question

如何自动创建pyi文件的样板代码？

我想创建一个保华集团的类型描述暗示文件pep484其中包含了所有的方法名。

我不要魔术。我要在自动创建文件后添加类型信息。

我想避免复制+粘贴工作。

目标：在PyCharm for Python2中键入提示。

Answer 1

就我而言，PyCharm中没有此类直接工具。但是，有用于此目的的第三方工具。

---

.pyi 发电机

MyPy

是的，我想任何想在Python中使用编译时类型检查的人都可能最终使用MyPy。MyPy包含生成文件的stubgen.py工具.pyi。

用法

mkdir out
stubgen urllib.parse

产生out/urllib/parse.pyi。

您也可以在Python2中使用它：

stubgen --py2 textwrap

对于C模块：

scripts/stubgen --docpath <DIR>/Python-3.4.2/Doc/library curses

如果要指定自定义软件包的路径，可以使用以下--search-path选项：

stubgen my-pkg --search-path=folder/path/to/the/package

[制作存根文件](https://github.com/edreamleo/make-stub-files “Github上的make-stub-

files”)

该项目致力于实现这一目标。

用法

一个非常基本的选项（但它有很多选择，只需咨询README.md或make_stub_files -h

make_stub_files foo.py

---

预写.pyi文件

因此，您不必自己编写。

打字

是的，如果您.pyi在自己的项目中使用文件，则在使用外部代码时也可能希望使用此文件。Typeshed包含.pyi适用于Python2和Python3
stdlib的文件以及一堆Python2库（如redis，crypto，…）和一些Python3库（如werkzeug或request），它们都经过了很好的版本控制。

---

PyCharm替代.pyi文件

如果您很懒惰，或者只是在不需要.pyi文件的项目上工作，并且不想使用第3方工具来打扰，PyCharm允许您使用：

• 键入文档字符串（旧版）
• Python 3函数注释