安装PyQt5时不会安装完整的类库帮助文档，PyQt5的在线Reference Guide提供了PyQt5使用中的一些关键技术问题的说明，但是关于具体的某个类的信息并不完整，不如Qt官网上的帮助文档信息全面。

要离线获取一个类的详细帮助信息，可以使用Qt Creator的帮助窗口。例如，在Qt Creator的帮助窗口里搜索QSpinBox，其资料页面如图2-32所示，这里有对QSpinBox类的简单说明和主要特性的示例代码，列出了其所有的属性、类型定义、公共接口函数、公共槽函数、信号等，并且可以查看每一项的详细资料。

图2-32 在Qt Creator的帮助窗口查找类的详细信息

Qt类库包含的类很多，具体到某个特定的类，其属性、接口函数、信号也很多，不可能全部介绍或列出来。对任何一种编程语言来说，其自带的帮助文档的信息都是最全面最准确的，学习时要善于查找帮助信息。

PyQt5安装后虽然没有Qt Creator里那样详细的类库帮助文档，但是可以通过Python的一些基本指令获取类或函数的内置帮助信息。例如，dir()指令可以显示一个类的所有接口信息；help()指令可以显示一个类的详细接口定义或一个函数的原型定义。

例如，要在Python Shell里查看QSpinBox的帮助信息，可执行下面的指令：

1. >>> from PyQt5.QtWidgets import QSpinBox
2. >>> dir(QSpinBox)

指令dir(QSpinBox)会列出QSpinBox的所有属性和方法的名称，包括所有从父类继承的属性和方法。

1. >>> help(QSpinBox)

指令help(QSpinBox)会更详细地列出QSpinBox类的所有属性和方法，它会先列出QSpinBox类里新定义的属性和方法，然后依次列出父类的属性和方法。接口函数（即方法）会显示输入输出参数定义。

help()指令也可以显示一个方法的函数原型（如QSpinBox.setValue()函数）的帮助信息：

1. >>> help(QSpinBox.setValue)
2. Help on built-in function setValue:
3. setValue(...)
4. setValue(self, int)

其中的最后一行表示setValue()函数需要一个int类型的输入参数，没有返回值。self是Python中所有类的接口函数的第一个参数，不看作函数参数。

1. >>> help (QSpinBox.value)
2. Help on built-in function value:
3. value(...)
4. value(self) -> int

上面显示的是QSpinBox.value()函数的帮助信息，最后一行表示value()函数返回一个int类型的数据，没有输入参数。

PyQt5的内置帮助信息虽然不详细、查阅不方便，但是可以提供最准确的信息，特别是在函数的输入输出参数定义上。对于某些类或函数，Qt C++类库中的定义和PyQt5中的定义有差异，应该以PyQt5的定义为准。

PyQt5是Qt C++类库的一个Python绑定，它包含了很多模块，在PyQt5安装后的目录“D:Python37Libsite-packagesPyQt5”里可以看到所有模块的文件。在前面的示例程序中已经用到了QtWidgets、QtCore、QtGui等模块，PyQt5中常用的几个模块如表2-5所示。

表2-5 PyQt5中常用的模块

在Python程序里用到某个PyQt5的类时，需要用import语句导入这个类，例如在前面的示例程序中用过这样的导入语句：

1. from PyQt5.QtWidgets import QApplication, QWidget
2. from PyQt5.QtCore import pyqtSlot, pyqtSignal
3. from PyQt5.QtGui import QIcon

因为Qt的类一般都以大写字母Q开头作为类名，与Python自带的类或其他程序包的类有很好的区分度，所以一般导入具体的类，然后在程序里直接使用这个类。

尽量不要使用类似于这样的导入语句：

1. from PyQt5.QtWidgets import *

这样虽然可以导入PyQt5.QtWidgets中的所有类并且直接使用，但是会导入很多不需要用到的类，这可能使程序运行变慢。

对于一个具体的类，如何知道它属于哪个模块呢？例如，对于类QPalette，如何知道它属于哪个模块，从而使用正确的import语句呢？

Qt C++的类库也是以模块组织的，Qt C++类库中的模块与PyQt5中的模块基本是对应的，可以在Qt Creator的帮助页面查找一个类的详细资料来查到其属于哪个模块。例如，QPalette类的帮助信息的基本描述如图2-33所示，其中有一行是：

1. qmake: QT += gui

这表明在Qt C++类库中，QPalette是属于gui模块的，那么在PyQt5中对应的模块就是PyQt5.QtGui，所以导入语句应该是：

1. from PyQt5.QtGui import QPalette

Qt帮助文档中qmake语句常见的描述与PyQt5模块的对应关系如表2-6所示。

表2-6 Qt帮助文档里的qmake描述与PyQt5模块的对应关系

PyQt5中大部分类的接口函数，以及每个函数的输入输出参数定义与Qt C++类库中的是一致的，所以在Qt Creator中查询帮助信息就可以知道类的接口或一个函数的输入输出参数。

但是有少量PyQt5的类或接口函数与Qt C++类库中的是不一样的。例如，对于QDataStream类，Qt C++类库中使用流操作符“>>”和“<<”实现各种类型数据的输入和输出，但是PyQt5中的QDataStream类没有这两个流操作符，而是定义了很多接口函数进行各种数据的输入和输出（详见9.3节）。

另外，有少量函数的接口在PyQt5和Qt C++中的定义不一样。例如，QFileDialog类的getOpenFileName()在Qt C++中的函数原型（省略了输入参数）是：

1. QString getOpenFileName(…);

而用help()指令查看的PyQt5中的函数原型（省略了输入参数）是：

1. getOpenFileName(…) -> Tuple[str, str]

getOpenFileName()函数在Qt C++和PyQt5中的输入参数相同，所以上面都省略了输入参数的显示。但是在Qt C++中，getOpenFileName()函数只返回一个选择的文件名，而在PyQt5中，getOpenFileName()返回一个Tuple类型的数据，第一个str类型数据是选择的文件名，第二个str类型数据是使用的文件过滤器。如果直接按照Qt C++中的函数原型在Python中使用QFileDialog.getOpenFileName()函数就会出现问题。

在Qt C++类库和PyQt5之间存在差异的类和接口函数并不多，但如果不知道这些差异，按照Qt C++类库的接口定义来使用PyQt5中的相应类或函数就会出现问题。例如，只根据Qt帮助文档里的函数原型使用PyQt5中的类或函数，或者是熟悉Qt C++类库使用的读者根据经验使用这些有差异的类或函数。

下面是整理的本书示例程序或使用PyQt5过程中遇到过的有差异的类或函数，这不是覆盖整个PyQt5的清单，不全面，但是可以让读者遇到此类问题时避免落入陷阱耗费时间。下面整理的内容只是列出了这些有差异的类或函数，并做简单说明，至于具体的差异之处，书中示例程序中涉及的地方会有具体说明。读者在用到以下这些类或函数时，也可以查阅Qt C++帮助文档和PyQt5内置帮助信息来明确这些差异之处。

（1）QDataStream类：接口函数存在较大差异，Qt C++中使用流操作符“>>”和“<<”，PyQt5中使用大量的接口函数替代流操作符。

（2）QFileDialog类：三个类函数getOpenFileName()、getOpenFileNames()、getSaveFileName()的返回数据有差异。Qt C++中只返回文件名或文件名列表，而PyQt5中返回的是一个Tuple类型的数据，第一个元素是文件名或文件名列表，第二个元素是使用的文件名过滤器。

（3）QFontDialog类：类函数getFont()的输入参数、返回数据有差异。

（4）QInputDialog类：getText()、getInt()等类函数返回数据有差异。

（5）QMediaRecorder类：supportedAudioSampleRates()函数返回数据有差异。

C++是强制类型定义的语言，Python是动态数据类型语言，而且两种语言之间的数据类型有一些差异。例如对于字符串数据，Python有内建的str类型，而Qt C++中使用QString类。

Qt C++类库转换为PyQt5后，某些Qt C++中的数据类型与Python中的数据类型存在对应关系，知道这些常见的对应关系后，就可以根据Qt Creator里查到的Qt C++函数原型迅速知道Python中的函数原型，从而正确使用这些函数。

Qt C++的名称空间（namespace）Qt包含大量的枚举类型的定义，例如，表示预定义颜色的枚举类型：

1. enum Qt::GlobalColor

其部分枚举值有Qt::white、Qt::black、Qt::red、Qt::blue等。

PyQt5.QtCore模块中的类Qt对应于Qt C++类库中的名称空间Qt，这些枚举类型常量都通过类属性访问，例如预定义颜色常量Qt.white、Qt.red等。

在Qt C++中，也经常在类里定义枚举类型，例如QPalette类定义的用于表示颜色角色的枚举类型：

1. enum QPalette::ColorRole

其部分枚举值有QPalette::Window、QPalette::Text等。

在PyQt5中，对应的枚举类型就是QPalette.ColorRole，而这些枚举类型常量作为类属性访问，也就是QPalette.Window、QPalette.Text等。

PyQt5中没有QString类型，Qt C++中的QString会被自动转换为Python的str类型，例如，C++中的一个函数返回值是QString类型：

1. QString QFileDialog::getExistingDirectory(…);

在PyQt5中的返回值就是str类型：

1. getExistingDirectory(…) -> str

由于返回结果是Python的str类型，不能使用QString的接口函数对返回结果进行处理，而应该使用Python的str类型的接口函数。

在Qt C++中用QList<type>定义类型为type的数据列表，而在Python中有内建的list数据类型，所以，Qt C++中的QList<type>在PyQt5中对应的是list[type]数据。例如，Qt C++中用于表示字符串列表的是QStringList类，在PyQt5中没有这个类，而是转换为list[str]数据。

例如，Qt C++中QFileDialog.getOpenFileNames()函数用于返回选择的多个文件的列表，其C++函数原型定义（省略了输入参数）是：

1. QStringList getOpenFileNames(…);

而在PyQt5的内置帮助信息显示的函数原型（省略了输入参数）是：

1. getOpenFileNames(…) -> Tuple[List[str], str]

其返回数据是Tuple类型，第一个数据List[str]是选择的文件名称字符串列表，第二个str数据是使用的文件过滤器。所以，这里还存在Qt C++与PyQt5函数参数不一致的问题。

既然返回的结果是list[str]，就应该用Python的list数据处理的方法，例如：

1. fileList,flt=QFileDialog.getOpenFileNames(self,"选择多个文件",
2. "", "Images(*.jpg)")
3. if (len(fileList)<1): #fileList是字符串列表
4. return
5. for i in range(len(fileList)):
6. print(fileList[i])