Python帮助文档的使用

Python的一个优势是有着大量自带和在线的模块(module)资源,可以提供丰富的功能，在使用这些模块的时候，如果每次都去网站找在线文档会过于浪费时间，因此，我们可以使用IDLE里边自带的查看帮助功能，可以在编辑时不中断地迅速找到所需要模块和函数的使用方法。

通用帮助函数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> modulesPlease wait a moment while I gather a list of all available modules...AutoComplete        _sqlite3            fnmatch             pymsgbox
AutoCompleteWindow  _sre                formatter           pyparsing
AutoExpand          _ssl                fractions           pyperclip
Bindings            _stat               ftplib              pyscreeze
CallTipWindow       _string             functools           pytweening
CallTips            _strptime           gc                  queue
......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:NAMEmathDESCRIPTIONThis module is always available.  It provides access to themathematical functions defined by the C standard.FUNCTIONSacos(...)acos(x)Return the arc cosine (measured in radians) of x.acosh(...)acosh(x)Return the inverse hyperbolic cosine of x.fabs(...)fabs(x)Return the absolute value of the float x.factorial(...)factorial(x) -> IntegralFind x!. Raise a ValueError if x is negative or non-integral.
DATAe = 2.718281828459045inf = infnan = nanpi = 3.141592653589793FILE(built-in)

使用help(module_name)时首先需要import该模块, 不先进行导入可能会出出错

查看內间模块sys.builtin_module_name

>>> import sys
>>> sys.builtin_module_names
('_ast', '_bisect', '_codecs', '_codecs_cn', '_codecs_hk', '_codecs_iso2022', '_codecs_jp', '_codecs_kr', '_codecs_tw', '_collections', '_csv', '_datetime', '_functools', '_heapq', '_imp', '_io', '_json', '_locale', '_lsprof', '_md5',  'zipimport', 'zlib')

需要导入sys模块. 这里列举的一般是自带的使用C/C++编译链接的模块

查询函数信息

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

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

>>> dir(math)
['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'acos', 'acosh', 'asin', 'asinh', 'atan', 'atan2', 'atanh', 'ceil', 'copysign', 'cos', 'cosh', 'degrees', 'e', 'erf', 'erfc', 'exp', 'expm1', 'fabs', 'factorial', 'floor', 'fmod', 'frexp', 'fsum', 'gamma', 'gcd', 'hypot', 'inf', 'isclose', 'isfinite', 'isinf', 'isnan', 'ldexp', 'lgamma', 'log', 'log10', 'log1p', 'log2', 'modf', 'nan', 'pi', 'pow', 'radians', 'sin', 'sinh', 'sqrt', 'tan', 'tanh', 'trunc']

同样需要先导入模块

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

>>> 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.__doc__)
print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file:  a file-like object (stream); defaults to the current sys.stdout.
sep:   string inserted between values, default a space.
end:   string appended after the last value, default a newline.
flush: whether to forcibly flush the stream.

__doc__前后是两个下划线, 在Python中会合并为长下划线

Python帮助文档的使用相关推荐

python 帮助文档、自我解释
现在让我们以交互方式使用 Python 来开始研究.当我们从命令行启动 Python 时,就进入了 Python shell,在这里可以输入 Python 代码,而且立刻会从 Python 解释器获得 ...
python 帮助文档，撰写函数文档，并查看函数文档
python 帮助文档,撰写函数文档,并查看函数文档定义函数 def test(a,b):'''参数:a:整数b:整数返回值:a+b'''return a+b 运行函数 test(11,22) 33 ...
关于深度学习框架Hamaa与Python API文档生成工具Sophon
五月两场 | NVIDIA DLI 深度学习入门课程 5月19日/5月26日一天密集式学习快速带你入门阅读全文> 正文共1988个字,预计阅读时间12分钟. 前言最近三个月我主要花时间在造 ...
Python之文档测试
0 参考文档 Sphinx--自动生成Python文档 Python之文档测试模块--doctest 1 doctest doctest是python自带的一个模块.doctest有两种使用方式:一种 ...
Python处理文档
本文转载自:https://blog.csdn.net/fudaxing/article/details/88736916 Python处理文档Python可以创建和修改具有.docx文件的Word文 ...
python创建文档
python创建文档创建word文档首先我们要安装会用到的三方库在终端输入以下代码安装 pip install python-docx pillow 这里我们制作的word文档会涉及到图,我们将 ...
sphinx：基于 Python 的文档生成工具
sphinx:基于 Python 的文档生成工具 Motivation 对于软件开发来说,文档是软件可维护性的重要保障.sphinx 是一款文档生成工具,以 restructuredText 为标记语 ...
Python 操作文档之请假条
Python 操作文档之请假条.md from docx import Document from datetime import datetimedoc=Document() doc.add_hea ...
python生成接口文档_使用apiDoc实现python接口文档编写
使用apiDoc实现python接口文档编写 apiDoc的安装 npm install apidoc -g 生成api的终端命令:apidoc -i 代码所在路径-o 生成文件的路径接口文档的编写 ...
python api 文档查看方式
1. cmd命令: python -m pydoc -p 1234 然后按照提示访问指定网址: 2. 浏览器访问http://localhost:1234就可查看全部的Python api文档: 3. ...