Python笔记：通过pydoc查看API文档

写在前面

在集成了python开发环境后，日常的开发过程中有时候需要查看API文档。

例如我们搭建了python+selenium开发环境，如何才能快速查看本地webdriver的API文档呢。

实现的操作方法简单，但是功能强大。在此介绍一下详细操作方法。

打开pydoc模块

pydoc是python自带的模块。

pydoc是查看python文档的首选工具，可以从python模块中自动生成文档。

生成的文档有以下几种展现方式：

1.基于文本形式呈现；

2.基于WEB页面.html的形式呈现；

3.以浏览器的方式在服务器上呈现。

首先打开命令行，在dos窗口输入以下命令：

python -m pydoc -p 6688

命令解释如下：

◆ python -m pydoc 表示打开pydoc模块；

◆ -p 6688 表示在6688端口上启动server;

备注：端口6688可以随便定义，最好不要和其他服务占用相同的端口。

进入文档详情

根据上图命令行提示复制地址：http://localhost:6688/在浏览器中打开。

或者根据提示输入b然后回车，浏览器会自动跳转到生成的html文档界面。

此时，弹出界面显示python中所有的Modules；

如果你想查看selenium相关的API文档，可以在搜索框内输入selenium点击Search查询出selenium相关的所有文档。

点击下图第一个跳转selenium根路径下的所有内容。

点击下图第二个跳转selenium.common根路径下的所有内容。

如果你想直接查看Webdriver类的基本方法，可以访问这个页面

http://localhost:6688/selenium.webdriver.remote.webdriver.html

后记小结

pydoc模块的使用方式不仅局限于此。还可以通过命令行直接查看具体函数的相关信息。

例如在CMD命令输入以下命令：

python -m pydoc math

python -m pydoc os

python -m pydoc sys
.....

回车查看显示效果，怎么样，发现新大陆没？

个人建议在集成IDE开发时通过点击函数跳转链接查看更便捷。