Python存根文件生成器。
项目描述
pygenstub 是一个用于从源文件中的文档字符串生成存根文件的实用程序。
如果函数的文档字符串包含sig字段,则该字段的值将用于通过以相同顺序将类型与参数匹配来生成存根。
例如,对于下面给出的函数:
def foo(a, b):
"""Do foo.
:sig: (int, str) -> None
"""
pygenstub 将生成以下存根:
def foo(a: int, b: str) -> None: ...
pygenstub 由一个包含此类签名的源文件组成。您可以检查通过在自身上运行 pygenstub 生成的存根文件作为示例。
入门
pygenstub 在 Python 3.6 及更高版本上运行。您可以从PyPI安装最新版本:
pip install pygenstub
安装会创建一个名为pygenstub的脚本,可以按如下方式使用:
pygenstub foo.py
此命令将在与输入文件相同的目录中生成文件foo.pyi 。如果输出文件已经存在,它将被覆盖。
如果下载源文件,也可以不安装直接运行:
python pygenstub.py foo.py
如果 pygenstub 被激活为 Sphinx 扩展(在sphinx.ext.autodoc之后),它将在文档字符串中插入类型注释:
extensions = [
"sphinx.ext.autodoc",
"pygenstub"
]
作为输出示例,您可以查看 pygenstub 本身的API 文档 。
获得帮助
执照
版权所有 (C) 2016-2021 H. Turgut Uyar < uyar @ tekir 。组织>
pygenstub 是在 GPL 许可下发布的,版本 3 或更高版本。阅读包含的LICENSE.txt以了解详细信息。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。
源分布
pygenstub-2.0.1.tar.gz
(24.8 kB
查看哈希)
内置分布
pygenstub-2.0.1-py3-none-any.whl
(24.4 kB
查看哈希)