Python 小技巧 058：Python 的 pydoc（4. 启动 HTTP 服务）

zltzlt

Pydoc 在指定端口上浏览文档

Pydoc 不仅让你可以在命令行中浏览文档，它还能为你启动 HTTP 服务，在指定的端口上浏览文档。

这是从 Pydoc 帮助文档上截取的一段话：

1. pydoc -p <port>
   
2.     Start an HTTP server on the given port on the local machine.  Port
   
3.     number 0 can be used to get an arbitrary unused port.

复制代码

这段话说明了 pydoc 可以使用 python -m pydoc -p <端口号> 命令启动 HTTP 服务并打开指定的端口号（如果端口号为 0 则自动打开可用的端口号）。让我们来试一下。

假设我们要在端口 500 开启一个服务器，则运行 python -m pydoc -p 500 命令。显示：

1. Server ready at http://localhost:500/
   
2. Server commands: [b]rowser, [q]uit
   
3. server>

复制代码

这时端口已经打开，我们可以在浏览器中输入地址 http://localhost:500/ 浏览或输入 browser（或者简单地输入 b）打开文档页面：

1. server> b
   
2. server>

复制代码

输入 b 后 Pydoc 会帮你打开文档页面。页面大致是这样子的：







可以看到，Python 包含了大量的内置模块和包。建议鱼油有空时多花点时间去浏览它们，熟悉有哪些功能可以用。

                               
登录/注册后可看大图

                               
登录/注册后可看大图

                               
登录/注册后可看大图

                               
登录/注册后可看大图

假设我们不知道 timeit 模块如何使用，则找到 xxx\lib（源码可见的第三方库），找到 timeit，点击：



打开后页面大致是这样的：







可以单击右上角的 Module Index 回到主页面。



如果想查看具体模块或函数的文档，在上面第一个输入栏中输入后单击 Get 即可。例如，查看内置函数 pow 的文档：



如果不知道一些模块或函数的名字，可以使用关键字搜索的方式。



例如：



回到控制台，输入 quit（或简单地输入 q）或按下 Ctrl + C 即能关闭服务器：

1. server> q
   
2. Server stopped

复制代码

Python 还为你提供了启动服务器的一条捷径，即输入 python -m pydoc -b 命令：