You are here:  Home » Python » – 文档生成器和在线帮助系统 – 开发工具(Python教程)(参考资料)

pydoc文档生成器在线帮助系统

源代码: Lib / pydoc.py


pydoc模块自动生成Pythonmodules的文档。文档可以在控制台上显示为文本页面,提供给Web浏览器,或保存到HTML文件.

对于模块,类,函数和方法,显示的文档来自docstring(即对象的__doc__属性,以及其可记录成员的递归。如果没有docstring,pydoc尝试从源文件中的类,函数或方法的定义或模块顶部的注释行块中获取描述(请参阅inspect.getcomments()).

内置函数help()调用交互式解释器中的在线帮助系统,它使用pydoc在控制台上生成文档文本。也可以通过运行 pydoc 作为操作系统命令提示符下的脚本。例如,在shell提示符下运行

pydoc sys

将显示sys模块,类似于Unix man 命令所示的手册页。对 pydoc 可以是函数,模块或包的名称,也可以是包中模块或模块中的类,方法或函数的虚线引用。如果 pydoc 看起来像一个路径(也就是说,它包含操作系统的路径分隔符,例如斜杠inUnix),并引用现有的Python源文件,然后为该文件生成文档.

注意

为了找到对象及其文档,pydoc导入要记录的模块。因此,在那种情况下将执行模块级别的任何代码。使用if __name__ == "__main__":当文件作为脚本调用而不仅仅是导入时,警卫只执行代码.

当打印输出到控制台时, pydoc 尝试对输出进行分页以便于阅读。如果设置了PAGER环境变量, pydoc 将使用其值作为分页程序.

指定一个-w标志在参数之前将HTML文档写入当前目录中的文件,而不是在控制台上显示文本.

在参数之前指定一个-k标志将搜索所有可用的概要作为参数给出的关键字的模块,再次类似于Unix man 命令。模块的概要行是其文档字符串的第一行.

你也可以使用 pydoc 在本地机器上启动一个HTTP服务器来提供文档访问Web浏览器 pydoc -p 1234 将在端口1234上启动HTTP服务器,允许您在首选的Web浏览器中浏览http://localhost:1234/的文档。指定0因为端口号将选择一个任意未使用的端口.

pydoc -n< hostname> 将启动服务器侦听给定的主机名。默认情况下,主机名为“localhost”,但如果您希望从其他计算机访问服务器,则可能需要更改服务器响应的主机名。在开发过程中,如果你想从容器中运行pydoc,这将特别有用.

pydoc -b 将启动服务器并另外打开web浏览器到模块索引页面。每个提供的页面在顶部都有一个导航栏,您可以Get帮助单个项目,Search所有模块在其概要行中都带有关键字,然后转到Module index, TopicsKeywords pages.

pydoc 生成文档时,它使用当前环境和路径来定位模块。因此,调用 pydoc spam 文件准确地说明了如果你启动了thePython解释器并输入了import spam.

模块的版本,假定核心模块的模块文件驻留在https://docs.python.org/X.Y/library/ XY是Python解释器的主要版本号和次要版本号。这可以通过设置PYTHONDOCS环境变量到一个不同的URL或包含LibraryReference手册页的本地目录.

在版本3.2中更改:添加了-b选项

更改在版本3.3:-g命令行选项已删除.

版本3.4更改:pydoc现在使用inspect.signature()而不是inspect.getfullargspec()从calblebles中提取签名信息.

更改版本3.7:添加了-n选项

评论被关闭。