pydoc在线文档帮助pycharm

26.1。pydoc —文档生成器和在线帮助系统
源代码： Lib / pydoc.py

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

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

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

注意 为了找到对象及其文档，pydoc导入要记录的模块。因此，此时将执行模块级别的任何代码。使用if name == ’ main '：防护仅在将文件作为脚本调用而不仅仅是导入时才执行代码。
在参数前指定-w标志将导致HTML文档被写到当前目录中的文件中，而不是在控制台上显示文本。

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

您还可以使用pydoc在本地计算机上启动HTTP服务器，该服务器将为访问Web浏览器提供文档。 pydoc -p 1234 将在端口1234上启动HTTP服务器，使您可以使用首选的Web浏览器浏览位于http：// localhost：1234 /的文档。指定0作为端口号将选择任意一个未使用的端口。

pydoc -g将启动服务器，并另外打开一个基于tkinter的小型图形界面，以帮助您搜索文档页面。该-g选项已过时，因为服务器现在可以直接从HTTP客户端进行控制。

pydoc -b将启动服务器，并另外打开Web浏览器到模块索引页面。每个服务页面的顶部都有一个导航栏，您可以在其中获得有关单个项目的帮助，在其概要行中使用关键字搜索所有模块，然后转到“ 模块索引”，“ 主题和 关键字”页面。

当是pydoc生成文档，它使用当前的环境和定位模块的路径。因此，调用pydoc spam会 精确地记录您启动Python解释器并输入import spam时将获得的模块版本。

假定用于核心模块的模块文档位于 http://docs.python.org/XY/library/中，其中X和Y是Python解释器的主要和次要版本号。可以通过设置PYTHONDOCS环境变量到另一个URL或包含Library Reference Manual页面的本地目录。

在版本3.2中进行了更改：添加了-b选项，不建议使用-g选项。