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 对于皮根斯图布本身。

获取帮助

文档位于:https://pygenstub.tekir.org/

源代码可以从:https://github.com/uyar/pygenstub

许可证

版权所有(c)2016-2019 H.Turgut Uyar<;uyar@tekir.org>;

Pygenstub是在GPL许可下发布的,版本3或更高。阅读 包含的LICENSE.txt了解详细信息。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java在Red Hat Server中找不到java_HOME   将自定义库导出到可导入jar文件java   java TemplateResolver未添加到TemplateEngine   java Android:使用微调器更改主活动背景颜色   使用javanio的并发连接   java NoClassDefFound加载twain小程序时出错   java如何在使用DateTimeFormatterBuilder将字符串解析为LocalDateTime时防止自动生成的“T”字母   java Quick Spring MVC问题:如果我不返回模型,为什么我仍然可以通过响应渲染视图?   在对话框后请求EditText时,java不显示键盘   java选择中的多个值   java使用带有Spring表单的AJAX调用   密码学是否可以将“GostR3410”标准证书文件导入JKS,并使用keytool或带有java的bouncycastle包获取私钥?   java selenium eclipse seleniumWebDriverException   java更改按钮单击时的TextView布局参数