怎么查看python库函数的官方文档,查看python的模块和函数帮助文档方法

  怎么查看python库函数的官方文档,查看python的模块和函数帮助文档方法

  大蟒的一个优势是有着大量自带和在线的模块(模块)资源,可以提供丰富的功能,在使用这些模块的时候,如果每次都去网站找在线文档会过于耗费时间,结果也不一定准确。因此这里介绍下大蟒自带的查看帮助功能,可以在编程时不中断地迅速找到所需模块和函数的使用方法

  通用帮助函数help()

  在大蟒命令行中键入help(),可以看到:

  帮助()

  WelcometoPython3.5 shelputility!

  如果这是你第一次使用Python,你应该定义检查

  tutorialontheinternetat http://docs。python。org/3.5/tutorial/.

  输入nameofanymodule,关键字,或ortopictogethelponwriting

  python程序和使用python模块.放弃这种无用和

  返回到解释器,只需键入辞职.

  Togetalistofavailablemodules模块,关键字,符号,或主题,类型

  模块、关键字、符号或主题。每个模块都有

  with one-linesummaryofwhatidos;列出模块名称

  或summarycontainagivenstringsuchas 垃圾邮件,键入modulesspam .

  帮助相关推荐: 《Python教程》

  进入帮助帮助文档界面,根据屏幕提示可以继续键入相应关键词进行查询,继续键入模块可以列出当前所有安装的模块:

  帮助模块

  PleasewaitamomentwhileIgatheralistofallavailablemodules.

  AutoComplete _ pyiofilecmppyskreeze

  自动完成window _ randomfileinp

  utpytweening

  ......

  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.

  ...

  >>>

郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。

留言与评论(共有 条评论)
   
验证码: