Python基础（1）：dir()，help()

Python：3.6.4

 

开始编写Python程序了...可是，某个模块怎么用呢？模块里的函数怎么用呢？...使用本文介绍的dir()、help()两个帮助函数可以

获得绝大部分开发所需要的信息！

 

dir()

使用help(dir)得到信息如下：

dir()是一个内置函数（built-in），存在于模块builtins中。

用法：dir([object])，参数是 对象，返回值为 字符串列表（list of strings）。

说明：

a.参数为空的时候，获取当前范围（current scope）的名称（names）列表，名称包括内置模块、导入模块、类、定义的变量（对象）等；

b.如果有参数，就返回给定对象的依照字母进行排序的属性名称的字符串列表（以下划线开头的排在最前面）；

c.若是对象包含__dir__方法，就使用这个方法的返回值；否则，就按照dir()函数的默认逻辑返回内容：

　　-模块对象（module）

　　　模块的属性；

　　-类对象（class）

　　   类本身的属性，以及递归找到的类的基类（its bases）的属性；

　　-其它对象（any other）

　　  对象本身的属性（？），它的类的属性，递归找到的它的类的基类的属性；

 

综上，dir()函数是用来获取 模块、类和其它对象 的属性列表的。

 

P.S.Python中一切皆对象，模块时对象，类也是对象。

 

help()

使用help(help)得到的信息如下：

help()函数用于获取帮助信息，用于Python的交互式命令行（Python interactive prompt）中。

说明：

a.没有参数的help()

启动一个交互式帮助会话（interactive help session），然后在其中输入自己想要得到的一些东西的帮助信息；

-进入交互式帮助会话

-获取内置函数dir的帮助信息

-获取模块os的帮助信息

-获取字符串类str下的count方法的帮助信息

 

退出交互式命令的方法：在help>提示符下按回车键。

 

b.有参数的help(thing)

输出Python对象thing的帮助信息——用法等；

需要注意的是，这里的thing可以是一个字符串，也可以是一个对象。

a.当thing是字符串时，这个字符串会被当作一个 模块、函数、类、方法、关键字 或者 文档主题 进行查找；

e.g.如下，help(if)发生SyntaxError错误，使用help('if')可以获取if关键字的信息。

b.当thing是一个对象时，这个对象上的帮助页（help page）将会被生成；

 

当然，前面提到的help(dir)就是这种用法，返回的结果和无参数的help()中返回的结果相同。

 

注意，对象上的 帮助页 或许会很长，一页显示不晚，可以按下回车键多显示一行，或者按下空格键多显示

一页，退出帮助页按下q即可（另有说法按下Ctrl+C或Z）。

 

help()更多信息来自官方网页-参考链接中的第一个网页：

 

------

 

另外，在Python安装目录下有一个Doc目录，里面有一份*.chm文件，文件中包含了Python所有的帮助信息，在没有网络时，可以很好地使用。

有网络时用它查信息也是很好的，避免被网络的各种信息打扰。

 

参考链接：

Built-in Functions
Python dir()内置函数作用及使用方法
用好Python帮助函数help()，dir()，type()