2.6.1 帮助信息的查找
1.在Qt Creator中查找帮助信息
安装PyQt5时不会安装完整的类库帮助文档,PyQt5的在线Reference Guide提供了PyQt5使用中的一些关键技术问题的说明,但是关于具体的某个类的信息并不完整,不如Qt官网上的帮助文档信息全面。
要离线获取一个类的详细帮助信息,可以使用Qt Creator的帮助窗口。例如,在Qt Creator的帮助窗口里搜索QSpinBox,其资料页面如图2-32所示,这里有对QSpinBox类的简单说明和主要特性的示例代码,列出了其所有的属性、类型定义、公共接口函数、公共槽函数、信号等,并且可以查看每一项的详细资料。
图2-32 在Qt Creator的帮助窗口查找类的详细信息
Qt类库包含的类很多,具体到某个特定的类,其属性、接口函数、信号也很多,不可能全部介绍或列出来。对任何一种编程语言来说,其自带的帮助文档的信息都是最全面最准确的,学习时要善于查找帮助信息。
2.在Python中查找帮助信息
PyQt5安装后虽然没有Qt Creator里那样详细的类库帮助文档,但是可以通过Python的一些基本指令获取类或函数的内置帮助信息。例如,dir()指令可以显示一个类的所有接口信息;help()指令可以显示一个类的详细接口定义或一个函数的原型定义。
例如,要在Python Shell里查看QSpinBox的帮助信息,可执行下面的指令:>>> from PyQt5.QtWidgets import QSpinBox
>>> dir(QSpinBox)
指令dir(QSpinBox)会列出QSpinBox的所有属性和方法的名称,包括所有从父类继承的属性和方法。>>> help(QSpinBox)
指令help(QSpinBox)会更详细地列出QSpinBox类的所有属性和方法,它会先列出QSpinBox类里新定义的属性和方法,然后依次列出父类的属性和方法。接口函数(即方法)会显示输入输出参数定义。
help()指令也可以显示一个方法的函数原型(如QSpinBox.setValue()函数)的帮助信息:>>> help(QSpinBox.setValue)
Help on built-in function setValue:
setValue(...)
setValue(self, int)
其中的最后一行表示setValue()函数需要一个int类型的输入参数,没有返回值。self是Python中所有类的接口函数的第一个参数,不看作函数参数。>>> help (QSpinBox.value)
Help on built-in function value:
value(...)
value(self) -&