Python怎么查看帮助信息

Python014

Python怎么查看帮助信息,第1张

Python获取帮助的3种方式

help()

help函数是Python的一个内置函数。

函数原型:help([object])。

可以帮助我们了解该对象的更多信息。

dir()

dir函数是Python的一个内置函数。

函数原型:dir([object])

可以帮助我们获取该对象的大部分相关属性。

_ doc_

在Python中有一个奇妙的特性,文档字符串,又称为DocStrings。

用它可以为我们的模块、类、函数等添加说明性的文字,使程序易读易懂,更重要的是可以通过Python自带的标准方法将这些描述性文字信息输出。

上面提到的自带的标准方法就是_ doc _。前后各两个下划线。

注:当不是函数、方法、模块等调用doc时,而是具体对象调用时,会显示此对象从属的类型的构造函数的文档字符串。

Python 标准库中的 argparse 可以根据程序中的定义,从 sys.argv 中解析参数,并且自动生成帮助信息。

使用 add_argument 方法为应用程序添加参数,其中 add_argument 方法的参数比较多,这也使得 argparse 库的使用不够简洁,后续将继续为大家介绍更好用的命令行参数解析的开源库 click 。

下面是 add_argument 方法的参数及含义总结:

解析参数需要使用 ArgumentParser 实例的 parse_args 方法,此方法返回一个 NameSpace 对象;可以通过访问 NameSpace 对象属性的方式获取参数值。

下面是一个简单的例子:通过 parser.server 获取 --host 选项的值,通过 parse.boolean_switch 获取 -t 选项的值。

查看帮助信息:

参数默认值:

指定参数:

打印帮助信息:

打印版本信息:

传递参数:

# 帮助文档

1、dir函数式可以查看对象的属性:Python命令窗口输入 dir(str) 即可查看str的属性。

2. 如何查看对象某个属性的帮助文档 ?

如要查看str的split属性,可以用__doc__(双下划线), 使用方法为print(str.split.__doc__)

或者help函数,使用方法为help(str.split)。

要注意在python3.4中查看其它模块的对象属性要在help函数中加上‘’,help('time.strftime'); 或者先加载模块 import time; help (time.strftime)

3. 查看某个对象的详细文档用help,

如查看str类型的详细文档可以用help(str)。如果文档的内容很多,help会列出全部文档的一部分,并在左下角提示“-- More

--”,按Enter键盘会显示更多的信息,要回到命令行交互模式可按Ctrl + C。

4. 搜索引擎中输入某一对象,找python.doc官网上找,或者用site地址仔细找相关对象的文档。

# sublime 快捷键

Sublime Text 使用介绍、全套快捷键及插件推荐 :http://www.daqianduan.com/4820.html