python包和模块帮助信息获取

󰃭 2017-07-05

对刚入门的Pythoner来说, 对很多python包和模块不了解, 也不知道如何去查响应的帮助信息, 以下总结如何查询python包和模块的帮助信息

pydoc

pydoc 是查询python文档的命令行工具, 比如, 我们想查datetime的文档

可以执行命令

pydoc datetime

得到帮助信息如下

pydoc -k keyword 可以使用关键字查询相关的包和模块, 查到后, 用pydoc module_name 查询帮助文档

pydoc 还可以起一个本地的端口服务, 用以通过web页面查看已经安装的包和模块的帮助信息

如下

pydoc -p 6789

通过http://localhost:6789/ 就能看到本地的包和模块列表了, 点击进去就可以看到相应的帮助信息了

help 函数

python shell里 通过help 函数也可以查看模块帮助信息

关键字

help('datetime')

模块

如果模块已经被引入, 可以直接如下查看

import datetime
help(datetime)

对象

如果得到了某个模块的对象, 我们也可以获得该对象的帮助信息

import datetime
d = datetime.datetime.now()
help(d)

dir

dir 函数可以列出模块和对象内部的所有属性和方法, 在一定程度上也可以帮助查看模块信息

比如

dir(datetime)

列举了该模块下的子模块和内置属性

['MAXYEAR',
 'MINYEAR',
 '__builtins__',
 '__cached__',
 '__doc__',
 '__file__',
 '__loader__',
 '__name__',
 '__package__',
 '__spec__',
 '_divide_and_round',
 'date',
 'datetime',
 'datetime_CAPI',
 'time',
 'timedelta',
 'timezone',
 'tzinfo']
import datetime
d = datetime.datetime.now()
dir(d)

列举了d的所有属性和函数列表

['__add__',
 '__class__',
 '__delattr__',
 '__dir__',
 '__doc__',
 '__eq__',
 '__format__',
 '__ge__',
  ......
 'utcfromtimestamp',
 'utcnow',
 'utcoffset',
 'utctimetuple',
 'weekday',
 'year']