pydoc

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

2.1版本中的新功能。

源代码： Lib / pydoc.py

pydoc模块自动从Python模块生成文档。文档可以作为控制台上的文本页面呈现，提供给Web浏览器或保存到HTML文件。

对于模块，类，函数和方法，所显示的文档是从对象的docstring（即__doc__属性）派生的，并且是对其可记录成员的递归派生。如果没有文档字符串，则pydoc尝试从源文件中的类，函数或方法的定义上方或模块的顶部（请参阅参考资料）中的注释行块获取说明inspect.getcomments()。

内置函数help()调用交互式解释器中的联机帮助系统，该解释器用于pydoc在控制台上以文本形式生成其文档。通过在操作系统的命令提示符处将pydoc作为脚本运行，也可以从Python解释器外部查看相同的文本文档。例如，运行

pydoc sys

在shell提示符下将显示sys模块上的文档，其格式类似于Unix man命令所显示的手册页。pydoc的参数可以是函数，模块或包的名称，也可以是包中模块或模块中的类，方法或函数的虚线引用。如果pydoc的参数看起来像一个路径（即它包含操作系统的路径分隔符，例如Unix中的斜杠），并且引用现有的Python源文件，则会为该文件生成文档。

注意

为了查找对象及其文档，pydoc导入要记录的模块。因此，模块级别的任何代码都将在此时执行。if __name__ == '__main__':当一个文件被调用为一个脚本而不是仅仅被导入时，使用一个警卫来执行代码。

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

-w在参数前指定一个标志将导致HTML文档被写出到当前目录中的文件中，而不是在控制台上显示文本。

-k在参数前面指定一个标志将以类似于Unix man命令的方式再次搜索所有可用模块的提纲行，以获得作为参数给定的关键字。模块的摘要行是其文档字符串的第一行。

您也可以使用pydoc在本地机器上启动HTTP服务器，该服务器将为访问Web浏览器提供文档。pydoc -p 1234将在端口1234上启动HTTP服务器，允许您http://localhost:1234/在首选Web浏览器中浏览文档。pydoc -g将启动服务器并另外启动一个小型Tkinter图形界面以帮助您搜索文档页面。

当pydoc生成文档时，它使用当前的环境和路径来查找模块。因此，如果启动Python解释器并键入，则调用pydoc垃圾邮件文档就是您将获得的模块版本import spam。

假设核心模块的模块文档位于https://docs.python.org/library/中。这可以通过将PYTHONDOCS环境变量设置为不同的URL或包含“库参考手册”页面的本地目录来覆盖。