python模块解析函数帮助文件快速查询方式实例

      本文关键给大家介绍了python模块解析函数帮助文件快速查询方式实例详细说明，感兴趣的小伙伴可以参考借鉴一下，希望可以带来帮助，祝愿大家多多的发展，尽早步步高升涨薪加官进爵

　　前言

　　python的1个优点是具有很多内置和一直在线控制模块(module)网络资源，能够提供丰富多彩的功效，使用这种模块情况下，假如每一次都要去网址找在线文档编辑会过度耗费精力，结论并不一定精确。因而这儿推荐下python带有的查询协助作用，还可以在程序编写的时候不终断地快速寻找需要控制模块解析函数使用方法

　　通用性协助函数公式help()

　　在pythoncmd中键入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>

　　进入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.
　　...
　　>>>

　　__doc__前后是两个短下划线，在python中会合并为长下划线

　　python中的help()类似unix中的man指令，熟悉后会对我们的编程带来很大帮助

　　这篇文章就给大家介绍到这里了，希望可以给大家带来帮助。