pydoc模块详解：查看、生成帮助文档

Python在创建函数、类以及类方法时，可以为它们添加说明性文档，即分别在函数体、类体以及类方法内部的首行添加具有说明性的字符串即可。例如：

#demo.py文件
def display(add):
    '''
    这是一个函数
    '''
    print(add)
   
class my_cla:
    '''
    这是一个类
    '''
    def say(self,add):
        '''
        这是一个类实例方法
        '''
        print(add)

如上所示，我们分别创建了 display() 函数和 my_cla 类，该类中还包含一个 say() 实例方法，并且我们为它们设置了说明性文档。

在此基础上，可以通过 help() 函数或者 doc 属性来调用函数、类或者类方法的说明性文档。例如在上面程序的基础上，添加如下代码：

help(display)
help(my_cla)
help(my_cla.say)

执行程序，运行结果为：

Help on function display in module __main__:

display(add)
    这是一个函数

Help on class my_cla in module __main__:

class my_cla(builtins.object)
|  这是一个类
| 
|  Methods defined here:
| 
|  say(self, add)
|      这是一个类实例方法
| 
|  ----------------------------------------------------------------------
|  Data descriptors defined here:
| 
|  __dict__
|      dictionary for instance variables (if defined)
| 
|  __weakref__
|      list of weak references to the object (if defined)

Help on function say in module __main__:

say(self, add)
    这是一个类实例方法

显然，我们调出了它们的说明性文档，但不得不说，该方法仅能通过编写调用代码在输出结果中查看，不是很方便。

实际上，Python 还提供了 pydoc 模块，通过该模块可以快速地生成程序的帮助文档。接下来就详细讲解 pydoc 模块的用法。

pydoc 可以实现在浏览器查看文档

和 help() 及 doc 不同，使用 pydoc 模块无需编写任何 python 代码，通过执行 python 命令即可查看程序中成员的说明性文档。 pydoc 命令语法格式如下：

python -m pydoc  -p 端口号

其中，-m 表示运行指定模块，这里表示要执行 pydoc 模块。注意在指定模块名时，除非其创建在 Python 解释器能自行找到的目录下，否则这里要明确模块所在的位置。

举个例子，执行如下命令：

python -m pydoc -p 8899

执行此命令，会看到如下输出信息：

Server ready at http://localhost:8899/
Server commands: [b]rowser, [q]uit
server>

显然，这里需要我们手动输入 b 或 q。其中，b 命令表示启动浏览器，而 q 命令表示退出。这里我们选择输入 b，此时浏览器会自动打开并自动访问 http://localhost:8899/, 将看到如图 所示的画面。

image.png

在该页面中，如果想查看某个模块的说明文档，直接点击该模块即可。

需要指明的一点是，pydoc 在显示所有 Python 模块时，会大致按照以下顺序进行显示：

显示 Python 内置的核心模块；
显示当前目录下的所有 Python 模块；
显示 PYTHONPATH 环境变量指定路径下包含的 Python 模块。

附

本文部分内容源自 Python pydoc模块详解：查看、生成帮助文档