python存根文件生成器。
pygenstub的Python项目详细描述
pygenstub是一个从docstring生成存根文件的实用程序 在源文件中。它接受一个源文件作为输入并创建一个存根文件 具有相同的基名和.pyi扩展名。
如果函数的docstring包含sig字段,则 字段将用于通过将类型与 参数的顺序相同。例如,对于下面给出的代码:
deffoo(a,b):"""Do foo. :sig: (int, str) -> None """
pygenstub将生成以下存根:
deffoo(a:int,b:str)->None:...
pygenstub由一个单独的模块组成,该模块本身包含签名。 您可以看到source code和自动生成的stub file 作为一个例子。
开始
Pygenstub已经过Python2.7、Python3.4+和兼容的测试 Pypy的版本。您可以使用pip:
安装最新版本pip install pygenstub
安装创建一个名为pygenstub的脚本,该脚本可以使用 如下所示:
pygenstub foo.py
此命令将在同一目录中生成文件foo.pyi。 作为输入文件。如果输出文件已经存在,它将被覆盖。
如果pygenstub被激活为sphinx扩展(在autodoc之后),它将插入 为docstring中的参数和返回值键入注释。它也会 删除签名字段以将其从输出中排除:
extensions=['sphinx.ext.autodoc','pygenstub']
作为输出的示例,您可以看到API documentation 对于皮根斯图布本身。
许可证
版权所有(c)2016-2019 H.Turgut Uyar<;uyar@tekir.org>;
Pygenstub是在GPL许可下发布的,版本3或更高。阅读 包含的LICENSE.txt了解详细信息。