查看python 的模块和函数帮助⽂档⽅法
python 的⼀个优势是有着⼤量⾃带和在线的模块(module)资源,可以提供丰富的功能,在使⽤这些模块的时候,如果每次都去⽹站在线⽂档会过于耗费时间,结果也不⼀定准确。因此这⾥介绍下python ⾃带的查看帮助功能,可以在编程时不地迅速到所需模块和函数的使⽤⽅法通⽤帮助函数help()在python中键⼊help(),可以看到:进⼊help帮助⽂档界⾯,根据屏幕提⽰可以继续键⼊相应关键词进⾏查询,继续键⼊modules 可以列出当前所有安装的模块:可以继续键⼊相应的模块名称得到该模块的帮助信息。
这是python的通⽤的查询帮助,可以查到⼏乎所有的帮助⽂档,但我们很多时候不需要这样层级式地向下查询,接下来会介绍如何直接查询特定的模块和函数帮助信息。
模块帮助查询
查看.py 结尾的普通模块help(module_name)例如要查询math 模块的使⽤⽅法,可以如下操作:>>> 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 /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>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1617help> modules Please wait a moment while  I gather a list of all 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".
1
2
3
4
5
6
7
8
9
10
使⽤help(module_name)时⾸先需要import该模块,有些教程中不进⾏导⼊⽽在模块名中加⼊引号help('module_name'),这种⽅法可能会带来问题,⼤家可以⽤math模块测试,建议使⽤先导⼊再使⽤help()函数查询查看内建模块sys.bultin_modulenames
需要导⼊sys模块。这⾥列举的⼀般是⾃带的使⽤C/C++编译链接的模块
查询函数信息
查看模块下所有函数dir(module_name)如我们需要列举出math 模块下所有的函数名称同样需要⾸先导⼊该模块
查看模块下特定函数信息help(module_name.func_name)
如查看math 下的sin()函数>>> 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) >>>
2
3
4
5
6
7
8
9
10
11
12
13
14
1516
17
18
19>>> import  sys >>> sys.builtin_module_names ('_ast', '_bisect', '_codecs', '_codecs_cn', '_codecs_hk', ... 'zlib')>>>
1
2
3
4>>> dir(math)['__doc__', '__loader__', '__name__',...]>>>
1
2
3
查看函数信息的另⼀种⽅法print(func_name.__doc__)如查看内建函数print ⽤法__doc__前后是两个短下划线,在python中会合并为长下划线python中的help()类似unix中的man 指令,熟悉后会对我们的编程带来很⼤帮助Help on built-in  function sin in  module math:sin(...)    sin(x)    Return the sine of x (measured in  radians).>>>
2
3
4
5
python中文文档6
7
8
9>>> print(print .__doc__)print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False )Prints the values to a stream, or  to sys.stdout >>>
1
2
3
4
5
6

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。