Python帮助信息获取技巧讲座

Python帮助信息获取技巧讲座

写Python程序肯定避免不了大量的查询资料和帮助文档。帮助文档中毫无疑问Python官方的文档是最权威最准确的。Python在帮助文档方面做的非常细致和贴心。

本文介绍的帮助主要方式有：

在线帮助文档

安装版本的本地帮助文档

使用内置（built-in）的dir函数

使用内置（built-in）的help函数

使用标准方法__doc__查看对象的帮助文档

 

★在线帮助文档

在线帮助文档地址：https://docs.python.org/3/可以查看最新Python3版本的帮助文档，还可以中英文切换。参见下图：

你可以切换到中文看看。目前有些部分尚未中文化。

 

 

★使用开发工具的本地文档帮助

 

你可以在索引页或搜索页中键入关键字，在此在索引页键入关键字timeit的情况如下图：

 

如果想知道一个对象(object)更多的信息，那么可以调用help(object) 函数！另外还有一些有用的方法，dir(object) 函数会显示该对象的大部分相关属性名，还有object.__doc__会显示其相对应的文档字符串。下面对其进行逐一介绍。

★dir()函数，格式：

dir([object])

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

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

 

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

对于内置对象

dir(abs)  # abs是内置函数

参见下图：

 

对于包或模块中的对象

dir(tkinter)  #出错

改为

import tkinter  #要先导入tkinter

dir(tkinter)  #不出错

参见下图：

通过 dir() 函数获取到的模块成员，不仅包含供外部文件使用的成员，还包含很多“特殊”（名称以 2 个下划线开头和结束）的成员，列出这些成员，对我们并没有实际意义。

因此，这里给读者推荐一种可以忽略显示 dir() 函数输出的特殊成员的方法：

[e for e in dir(tkinter) if not e.startswith('_')]

参见下图：

 

★help()函数，格式：

help([object])

help()函数是Python内置的帮助功能，可以在在python的Shell,在>>>提示符后输入使用。如果help不带任何参数，会进入交互模式。也可以获取包或模块中的对象的帮助。

对于内置对象，在python的Shell,在>>>提示符后输入

help(abs) # abs是内置函数

参见下图：

【关于help（）输出中的斜杠是什么意思？

斜杠（/）前面的参数仅为位置参数，斜杠（/）后面的参数根据语法可以是任何类型的参数。可参见：https://blog.csdn.net/weixin_34145418/article/details/113651813 】

 

对于包或模块中的对象

help(tkinter.Label)  #出错

改为

import tkinter  #要先导入tkinter

help(tkinter.Label)  #不出错

参见下图：

 

可以使用help查看模块下特定函数信息，格式：

help(module_name.func_name)

注意：func_name后面不要加()，因为python的语法默认加了括号后就运行函数。

 

★使用方法__doc__查看对象的帮助文档。格式：

object.__doc__

注意doc前后有两个下划线。

在Python中有一个奇妙的特性，文档字符串（DocStrings）。它可以为我们的模块、类、函数等添加说明性的文字，使程序易读易懂，更重要的是可以通过Python自带的标准方法__doc__将这些描述性文字信息输出。

以模块timeit为例

import timeit  #要先导入模块timeit

然后用

timeit.__doc__    # 查看模块的说明

或

print(timeit.__doc__)     # 美观显示模块的说明

参见下图：

 

timeit.repeat.__doc__       # 查看其中repeat 函数（Functions）的说明

参见下图：

 

除此之外，还可以上网搜索，如使用Google搜索。对此不多说了。