python - 自动创建 .pyi 文件？

Question

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

我想创建一个 pyi pep484 中描述的类型提示文件其中包含所有方法名称。

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

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

目标:在 Python2 的 PyCharm 中键入提示。

Answer 1

就我而言，PyCharm 中没有这样的直接工具。但是，有用于此目的的 3rd 方工具。

---

.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

make-stub-files

这个项目正是致力于实现这个目标。

用法

一个非常基本的(但它有一些选项，只需引用 README.md 或 make_stub_files -h

make_stub_files foo.py

---

预先编写的.pyi文件

所以你不必自己写。

Typeshed

是的，如果您在自己的项目中使用 .pyi 文件，您可能希望在使用外部代码时也使用它。 Typeshed 包含 Python2 和 Python3 标准库的 .pyi 文件和一堆 Python2 库(如 redis、crypto、...)和一些 Python3 库(如 werkzeug 或 requests )，所有版本都很好。

---

.pyi 文件的 PyCharm 替代品

如果你很懒惰，或者只是在做一个不需要 .pyi 文件的项目并且你不想被使用第三方工具所困扰，PyCharm 允许你使用:

• Type docstrings (旧版)
• Python 3 function annotations