【Python】直接使用Python查阅文档

初衷

本篇博文写给Python小白用户，主要关于直接使用Python内置函数查阅API文档的方法。有时候我们需要用到某一个具体的类或者函数，这个时候“打开浏览器、输入网址（或搜索关键词）、进入官方在线文档（可能还有筛选网站）、再查阅”其实是一个相当漫长的过程。

如果我们在编程时，只是需要了解少数几个类或者函数的用法，我们可以直接使用Python内置的dir函数和help函数。

查找所有函数和类

使用dir函数可以输出一个模块中的所有函数和类。下面我们使用numpy做个简单的演示：

import numpy as np
print(dir(np.random))

可以得到输出：

其中，__开头和结尾的一般为Python特殊对象，_开头的一般为内部函数，我们可以忽略。

查找某个函数和类的用法

当使用dir函数找到需要使用的类或者函数之后，我们可以使用help函数来打印它的用法。

import numpy as np
print(help(np.array))

输出结果通常包含函数的参数解释、返回值解释、示例等，如下图：