python怎么查看函数文档

python的一个优势是有着大量自带和在线的模块(module)资源，可以提供丰富的功能，在使用这些模块的时候，如果每次都去网站找在线文档会过于耗费时间，结果也不一定准确。因此这里介绍下python自带的查看帮助功能，可以在编程时不中断地迅速找到所需模块和函数的使用方法

通用帮助函数help()

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

>>>help()
WelcometoPython3.5'shelputility!
IfthisisyourfirsttimeusingPython,youshoulddefinitelycheckout
thetutorialontheInternetathttp://docs.python.org/3.5/tutorial/.
Enterthenameofanymodule,keyword,ortopictogethelponwriting
PythonprogramsandusingPythonmodules.Toquitthishelputilityand
returntotheinterpreter,justtype"quit".
Togetalistofavailablemodules,keywords,symbols,ortopics,type
"modules","keywords","symbols",or"topics".Eachmodulealsocomes
withaone-linesummaryofwhatitdoes;tolistthemoduleswhosename
orsummarycontainagivenstringsuchas"spam",type"modulesspam".
help>

相关推荐：《Python教程》

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

help>modules
PleasewaitamomentwhileIgatheralistofallavailablemodules...
AutoComplete_pyiofilecmppyscreeze
AutoCompleteWindow_randomfileinputpytweening
......
Enteranymodulenametogetmorehelp.Or,type"modulesspam"tosearch
formoduleswhosenameorsummarycontainthestring"spam".

可以继续键入相应的模块名称得到该模块的帮助信息。

这是python的通用的查询帮助，可以查到几乎所有的帮助文档，但我们很多时候不需要这样层级式地向下查询，接下来会介绍如何直接查询特定的模块和函数帮助信息。

模块帮助查询

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

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

>>>importmath
>>>help(math)
Helponbuilt-inmodulemath:
NAME
math
DESCRIPTION
Thismoduleisalwaysavailable.Itprovidesaccesstothe
mathematicalfunctionsdefinedbytheCstandard.
FUNCTIONS
acos(...)
acos(x)

Returnthearccosine(measuredinradians)ofx.
...
>>>

使用help(module_name)时首先需要import该模块，有些教程中不进行导入而在模块名中加入引号help('module_name')，这种方法可能会带来问题，大家可以用math模块测试，建议使用先导入再使用help()函数查询。

查看内建模块sys.bultin_modulenames

>>>importsys
>>>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)
Helponbuilt-infunctionsininmodulemath:
sin(...)
sin(x)

Returnthesineofx(measuredinradians).
>>>

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

如查看内建函数print用法

>>>print(print.__doc__)
print(value,...,sep='',end='\n',file=sys.stdout,flush=False)
Printsthevaluestoastream,ortosys.stdoutbydefault.
...
>>>