如何在python中查看函数文档

python的优点之一是它有大量的内置和在线模块资源，可以提供丰富的功能。在使用这些模块的时候，每次去网站查找在线文档会太费时间，而且结果可能不准确。 .因此，这里介绍一下python自带的查看帮助功能，可以在编程过程中不中断的快速找到所需模块和功能的用法。

通用帮助函数help()

在python命令行中键入help(),可以看到：

>>> help()
Welcome to Python 3.5's help utility!
If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://docs.python.org/3.5/tutorial/.
Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".
To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics".  Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".
help>

进入帮助文档界面，可以根据屏幕提示继续输入相应的关键字进行查询，继续输入modules列出当前安装的所有模块：

help> modules
Please wait a moment while I gather a list of all available modules...
AutoComplete        _pyio               filecmp             pyscreeze
AutoCompleteWindow  _random             fileinput           pytweening
......        
Enter any module name to get more help.  Or, type "modules spam" to search
for modules whose name or summary contain the string "spam".

你可以继续输入对应的模块名称，获取模块的帮助信息。

这是python的通用查询帮助，几乎可以找到所有的帮助文档，但是我们经常不需要这样分层向下查询。接下来，我们将介绍如何直接查询特定模块和功能的帮助信息。

模块帮助查询

查看.py结尾的普通模块help(module_name)

例如要查询math模块的使用方法，可以如下操作：

>>> import math
>>> help(math)
Help on built-in module math:
NAME
    math
DESCRIPTION
    This module is always available.  It provides access to the
    mathematical functions defined by the C standard.
FUNCTIONS
    acos(...)
        acos(x)
        
        Return the arc cosine (measured in radians) of x.
...
>>>

使用 help(module_name) 时，首先需要导入模块。有些教程不导入并在模块名称中添加引号 help('module_name')。这种方法可能会导致问题。你可以使用数学模块对其进行测试。建议先使用 Import 再使用 help() 函数查询。

查看内建模块sys.bultin_modulenames

>>> import sys
>>> sys.builtin_module_names
('_ast', '_bisect', '_codecs', '_codecs_cn', '_codecs_hk', ... 'zlib')
>>>

需要导入 sys 模块。这里列出的模块一般是使用 C/C++ 编译和链接的内置模块

查询函数信息

查看模块下所有函数dir(module_name)

如我们需要列举出math模块下所有的函数名称

>>> dir(math)
['__doc__', '__loader__', '__name__',...]
>>>

同样需要首先导入该模块

查看模块下特定函数信息help(module_name.func_name)

如查看math下的sin()函数

>>> help(math.sin)
Help on built-in function sin in module math:
sin(...)
    sin(x)
    
    Return the sine of x (measured in radians).
>>>

查看函数信息的另一种方法print(func_name.__doc__)

如查看内建函数print用法

>>> print(print.__doc__)
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
Prints the values to a stream, or to sys.stdout by default.
...
>>>