python查看函数文档的方法

这篇文章主要介绍python查看函数文档的方法，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！

公司专注于为企业提供网站设计制作、成都网站制作、微信公众号开发、商城开发，微信小程序定制开发，软件按需定制设计等一站式互联网企业服务。凭借多年丰富的经验，我们会仔细了解各客户的需求而做出多方面的分析、设计、整合，为客户设计出具风格及创意性的商业解决方案，创新互联建站更提供一系列网站制作和网站推广的服务。

python的一个优势是有着大量自带和在线的模块(module)资源，可以提供丰富的功能，在使用这些模块的时候，如果每次都去网站找在线文档会过于耗费时间，结果也不一定准确。因此这里介绍下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>

进入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)时首先需要import该模块，有些教程中不进行导入而在模块名中加入引号help('module_name')，这种方法可能会带来问题，大家可以用math模块测试，建议使用先导入再使用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.
...
>>>

以上是python查看函数文档的方法的所有内容，感谢各位的阅读！希望分享的内容对大家有帮助，更多相关知识，欢迎关注创新互联行业资讯频道！