在python中查看模块功能的方法:1、将help()函数输入python命令行,以帮助文档界面;2、键入【modules】列出当前安装的所有模块;3、输入相应的模块名称以获取模块的功能信息。
python的一个优点是它有很多自带和在线模块。(module)资源可以提供丰富的功能。在使用这些模块时,如果你每次都去网站查找在线文档,这将花费太多时间,结果可能不准确。因此,这里我们介绍python的查看帮助功能,它可以快速找到所需模块和函数的使用方法,而无需中断编程
help()通用帮助函数
将help()键入python命令行,可以看到:
>>>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的一般查询帮助,几乎可以找到所有的帮助文档,但我们通常不需要这样的层次下降,然后介绍如何直接查询特定的模块和函数帮助信息。
帮助查询模块
查看.helpy结尾的普通模块(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++模块编译链接
查询函数信息
在模块下查看所有函数dirr(module_name)
如果我们需要列出math模块下的所有函数名称
>>>dir(math) ['__doc__','__loader__','__name__',...] >>>
还需要先导入模块
在模块下查看特定函数信息helpp(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指令,熟悉后会给我们的编程带来很大的帮助
推荐课程:python编程入门系列图文教程