PyQt5信号与槽（一）基础介绍

bug学弟 lv.1

发布时间：2023-01-10 01:23:16 612

相关标签： # python# 数据# 信息# 工具# 缺陷

(PyQt5信号与槽（一）基础介绍)

一、信号与槽介绍

信号（Signal）和槽（(Slot）是Qt中的核心机制，也是在PyQt编程中对象之间进行通信的机制。在Qt中，每一个QObject对象和 PyQt中所有继承自QWidget的控件（这些都是QObject的子对象）都支持信号与槽机制。当信号发射时，连接的槽函数将会自动执行。在 PyQt 5中信号与槽通过object.signal.connect()方法连接。
PyQt的窗口控件类中有很多内置信号，开发者也可以添加自定义信号。信号与槽具有如下特点：
- 一个信号可以连接多个槽。
- 一个信号可以连接另一个信号。
- 信号参数可以是任何Python类型。
- 一个槽可以监听多个信号。
- 信号与槽的连接方式可以是同步连接，也可以是异步连接。
- 信号与槽的连接可能会跨线程。
- 信号可能会断开。
在GUI编程中，当改变一个控件的状态时（如单击了按钮），通常需要通知另一个控件,也就是实现了对象之间的通信。在早期的GUI编程中使用的是回调机制,在Qt中则使用一种新机制-信号与槽。在编写一个类时，要先定义该类的信号与槽，在类中信号与槽进行连接，实现对象之间的数据传输。
信号与槽机制示意图：

graph LR
A[发送者: ClassObject1] -- 信号: Signal--> B((连接: connect))--接收 -->
C(接受者:ClassObject2)--调用: get-->D(槽函数: SlotFunc)

当事件或者状态发生改变时，就会发出信号。同时，信号会触发所有与这个事件（信号）相关的函数（槽）。信号与槽可以是多对多的关系。一个信号可以连接多个槽，一个槽也可以监听多个信号。

1、定义信号

PyQt的内置信号是自动定义的。使用 PyQt5.QtCore.pyqtSignal()函数可以为Q0bject创建一个信号，使用 pyqtSingnal()函数可以把信号定义为类的属性。

（1）为QObject对象创建信号

　　使用pyqtSignal()函数创建一个或多个重载的未绑定的信号作为类的属性，信号只能在Q0bject的子类中定义。　　信号必须在类创建时定义，不能在类创建后作为类的属性动态添加进来。types参数表示定义信号时参数的类型，　　　name参数表示信号名字，该项缺省时使用类的属性名字。　

	class Foo(QObject):
	    valueChanged = pyqtSignal([dict], [list])

（2）为控件创建信号

	from PyQt5.QtCore import pyqtSignal
	from PyQt5.QtWidgets import QMainWindow
	
	class WinForm(QMainWindow):
	    btnClickSignal = pyqtSignal()

上面代码为自定义控件创建了一个btnClickSignal 信号。

2、操作信号

使用connect()函数可以把信号绑定到槽函数上。 connect()函数信息如下图：
使用 disconnect()函数可以解除信号与槽函数的绑定。disconnect()函数如下图：
使用emit()函数可以发射信号。emit()函数信息如下图：
中文文档

3、入门应用

信号与槽有三种使用方法，第一种是内置信号与槽的使用，第二种是自定义信号与槽的使用，第三种是装饰器的信号与槽的使用。第三种方法本质上是第一种方法的衍生。这里先讲第一、二种。

（1）内置信号与槽的使用

所谓内置信号与槽的使用，是指在发射信号时，使用窗口控件的函数，而不是自定义的函数。在信号与槽中，可以通过QObject.signal.connect将一QObject的信号连接到另一个QObject的槽函数。本例文件的完整代码如下：

# -*- coding:utf-8 -*-
"""
    # @Time:2022/12/10 0010 13:16
    # @Author：晚秋拾叶
    # @File:qt07_winSigalSlot01.py
    # @PyCharm之Python
"""
from PyQt5.QtWidgets import QPushButton, QApplication, QWidget, QMessageBox
import sys

app = QApplication([])
widget = QWidget()

def showMsg():
    QMessageBox.information(widget, "信息提示框", "ok，弹出测试信息")

btn = QPushButton("测试点击按钮", widget)
btn.clicked.connect(showMsg)
widget.show()
sys.exit(app.exec_())

代码分析
这个例子将一个按键对象的内置clicked信号连接到自定义的槽函数showMsg()，衣可以说showMsg()函数响应了一个按键单击事件。单击“测试点击按钮“，就会弹出一个信息提示框。
效果如图

（2）自定义信号与槽的使用

自定义信号与槽的使用，是指在发射信号时，不使用窗口控件的函数，而是使用自定义的函数（简单地说，就是使用 pyqtSignal类实例发射信号）。之所以要使用自定义信号与槽，是因为通过内置函数发射信号有自身的缺陷。首先，内置函数只包含一些常用的信号，有些信号的发射找不到对应的内置函数;其次，只有在特定情况下(如按钮的点击事件）才能发射这种信号;最后，内置函数传递的参数是特定的，不可以自定义。使用自定义的信号函数则没有这些缺陷。
在PyQt5编程中，自定义信号与槽的适用范围很灵活，比如因为业务需求，在程序中的某个地方需要发射一个信号，传递多种数据类型（实际上就是传递参数），然后在槽函数中接收传递过来的数据,这样就可以非常灵活地实现一些业务逻辑。
在PyQt编程中，信号与槽有多种写法，以下是Python风格的写法。本例代码如下：

# -*- coding:utf-8 -*-
# -*- coding:utf-8 -*-
"""
    # @Time:2022/12/10 0010 13:28
    # @Author：晚秋拾叶
    # @File:qt07_pysignalSlot.py
    # @PyCharm之Python
"""
from PyQt5.QtCore import QObject, pyqtSignal


# 信号对象
class QTypeSignal(QObject):
    # 定义一个信号
    sendmsg = pyqtSignal(object)

    def __init__(self):
        super(QTypeSignal, self).__init__()

    def run(self):
        # 发射信号
        self.sendmsg.emit("Hello PyQt5")
        print("信号运行了")


# 槽函数
class QTypeSlot(QObject):
    def __init__(self):
        super(QTypeSlot, self).__init__()

    # 槽对象中的槽函数
    def get(self, msg):
        print("QSlot get msg =>" + msg)


if __name__ == '__main__':
    send = QTypeSignal()
    slot = QTypeSlot()
    # 1 类对象.信号.绑定(类对象.槽函数)
    print('---把信号绑定到槽函数上---')
    send.sendmsg.connect(slot.get)
    send.run()
    # 2 解绑
    print('---把信号与槽函数在连接断开---')
    send.sendmsg.disconnect(slot.get)
    send.run()

代码分析
- 绑定格式是：类对象.信号.绑定(类对象.槽函数)
- 对应的代码：send.sendmsg.connect(slot.get)
- 槽函数接收数据：
```
def get(self, msg):
        print("QSlot get msg =>" + msg)
```
- 发射信号的实现：self.sendmsg.emit("Hello PyQt5")
- 把信号绑定到槽函数对象中的槽函数get()上，槽函数能接收到所发射的信号msg——"Hello PyQt5"。
- 至此，数据传递成功，就是这么简单。
效果如图
传递两个参数的槽函数，代码如下：

# -*- coding:utf-8 -*-
"""
    # @Time:2022/12/10 0010 19:45
    # @Author：晚秋拾叶
    # @File:qt04_pysignalSlot02.py
    # @PyCharm之Python
"""
from PyQt5.QtCore import QObject, pyqtSignal


# 信号对象
class QTypeSingnal(QObject):
    # 定义一个信号
    sendmsg = pyqtSignal(str, str)

    def __init__(self):
        super(QTypeSingnal, self).__init__()

    def run(self):
        # 发射信号
        self.sendmsg.emit("第一个参数!", "第二个参数！")


# 槽对象
class QTypeSlot(QObject):
    def __init__(self):
        super(QTypeSlot, self).__init__()

    # 槽对象中的槽函数
    def get(self, msg1, msg2):
        print("QSlot get msg => " + msg1 + msg2)


if __name__ == '__main__':
    # 实例化对象
    send = QTypeSingnal()
    slot = QTypeSlot()

    # 1.
    print("--------信号绑定到槽函数----------")
    send.sendmsg.connect(slot.get)
    # 发射信号
    send.run()

    # 2.
    print("--------把信号与槽函数的连接断开--------")
    send.sendmsg.disconnect(slot.get)
    send.run()