Python查看模块帮助/文档

如果你不熟悉某个Python模块,你可以通过如下方法获得帮助信息:

  • built-in的dir函数
  • built-in的help函数
  • 使用pydoc模块
  • 使用inspect模块
  • Google搜索(本帖介绍前4种方法,不需要联网)

dir

dir()函数可以查看对像内所有属于及方法。

在Python中任何东西都是对像,数据类型,模块等,都有自己的属性和方法。除了常用方法外,其它的你不需要全部记住,交给dir()函数就好了。

如果不向dir传入任何参数:dir(),它输出当前域内的属性和方法。如:

Python查看模块帮助/文档

查看指定对象的属性和方法:

Python查看模块帮助/文档

Python查看模块帮助/文档

help

Python内置的帮助功能,它实际上是基于pydoc.help

如果help不带任何参数,会进入交互模式:

Python查看模块帮助/文档

也可以直接传入要查询的模块:

Python查看模块帮助/文档
q 退出

只要安装的模块包含文档,就可以使用help函数查看帮助信息。

pydoc

pydoc可以从Python模块中自动生成文档。

查看pydoc帮助文档:

Python查看模块帮助/文档

启动http服务,使用浏览器查看文档:

Python查看模块帮助/文档

inspect

inspect模块可以在运行时帮助我们确定对象类型。对应的函数如下:

  • ismodule()
  • isclass()
  • ismethod()
  • isfunction()
  • isgeneratorfunction()
  • isgenerator()
  • istraceback()
  • isframe()
  • iscode()
  • isbuiltin()
  • isroutine()

Python查看模块帮助/文档

使用getmembers()获得对象所有成员:

使用getdoc获得文档对象:

查看inspect帮助:

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注