PyQt5快速入門（二）PyQt5信號槽機(jī)制

PyQt5快速入門（二）PyQt5信號槽機(jī)制

一、信號槽機(jī)制簡介

1、信號槽簡介

信號槽是Qt的核心機(jī)制，也是PyQt編程中對象進(jìn)行通信的機(jī)制。在Qt中，QObject對象和PyQt中所有繼承自QWidget的控件都支持信號槽機(jī)制。當(dāng)信號發(fā)射時(shí)，連接的槽函數(shù)會(huì)自動(dòng)執(zhí)行。在PyQt5中，信號與槽函數(shù)通過object.signal.connect()方法進(jìn)行連接。
信號槽特點(diǎn)如下：
（1）一個(gè)信號可以連接多個(gè)槽
（2）一個(gè)信號可以連接另一個(gè)信號
（3）信號參數(shù)可以是任意Python類型
（4）一個(gè)槽可以監(jiān)聽多個(gè)信號
（5）信號與槽的連接方式可以是同步連接，也可以是異步連接。
（6）信號與槽的連接可以跨線程
（7）信號可以斷開
在編寫一個(gè)類時(shí)，要首先定義的類的信號與槽，在類中信號與槽進(jìn)行連接，實(shí)現(xiàn)對象之間的數(shù)據(jù)傳輸。當(dāng)事件或狀態(tài)發(fā)生變化時(shí)，會(huì)發(fā)出信號，進(jìn)而觸發(fā)執(zhí)行事件或信號關(guān)聯(lián)的槽函數(shù)。信號槽機(jī)制示意如下：

2、定義信號

PyQt的內(nèi)置信號是自動(dòng)定義的，使用PyQt5.QtCore.pyqtSignal函數(shù)可以為QObject對象創(chuàng)建一個(gè)信號，使用pyqtSignal函數(shù)可以把信號定義為類的屬性。

class pyqtSignal:
    def __init__(self, *types, name: str = ...) -> None: ...

types參數(shù)表示定義信號時(shí)參數(shù)的類型，name參數(shù)表示信號的名稱，默認(rèn)使用類的屬性名稱。
使用pyqtSignal函數(shù)創(chuàng)建一個(gè)或多個(gè)重載的未綁定的信號作為類的屬性，信號只能在QObject的子類中定義。信號必須在類創(chuàng)建時(shí)定義，不能在類創(chuàng)建后作為類的屬性動(dòng)態(tài)添加進(jìn)來。使用pyqtSignal函數(shù)定義信號時(shí)，信號可以傳遞多各參數(shù)，并指定信號傳遞參數(shù)的類型，參數(shù)類型是標(biāo)準(zhǔn)的Python數(shù)據(jù)類型，包括字符串、日期、布爾類型、數(shù)字、列表、字典、元組。

from PyQt5.QtCore import pyqtSignal, QObject

class StandardItem(QObject):
    # 定義信號，信號有兩個(gè)參數(shù)，兩個(gè)參數(shù)的類型分別為str,str，信號名稱為dataChanged
    data_changed = pyqtSignal(str, str, name="dataChanged")

    # 更新信息，發(fā)送信號
    def update(self):
        self.dataChanged.emit("old status", "new status")

3、操作信號

使用connect函數(shù)可以將信號綁定到槽函數(shù)上，使用disconnect函數(shù)可以解除信號與槽函數(shù)的綁定，使用emit函數(shù)可以發(fā)射信號。
QObject.signal.connect(self, slot, type=None, no_receiver_check=False)
建立信號到槽函數(shù)的連接，type為連接類型。
QObject.signal.disconnect(self, slot=None)
斷開信號到槽的連接
emit(self, *args)
發(fā)送信號，args為可變參數(shù)。

import sys
from PyQt5.QtCore import pyqtSignal, QObject, QCoreApplication

class StandardItem(QObject):
    # 定義信號，信號有兩個(gè)參數(shù)，兩個(gè)參數(shù)的類型分別為str,str，信號名稱為dataChanged
    data_changed = pyqtSignal(str, str, name="dataChanged")

    # 更新信息，發(fā)送信號
    def update(self):
        self.dataChanged.emit("old status", "new status")

    # 定義槽函數(shù)
    def onDataChanged(self, old, new):
        print(old)
        print(new)

if __name__ == "__main__":
    app = QCoreApplication(sys.argv)

    item = StandardItem()
    item.dataChanged.connect(item.onDataChanged)
    item.update()

    sys.exit(app.exec_())

# OUTPUT:
# old status
# new status

二、信號與槽應(yīng)用

1、內(nèi)置信號與槽函數(shù)

內(nèi)置信號是QObject對象自動(dòng)定義的信號，內(nèi)置槽函數(shù)是QObject對象自動(dòng)定義的槽函數(shù)，可以通過QObject.signal.connect函數(shù)將QObject對象的內(nèi)置信號連接到QObject對象的槽函數(shù)。

2、內(nèi)置信號與自定義槽函數(shù)

import sys
from PyQt5.QtWidgets import QWidget, QApplication, QPushButton

class MainWindow(QWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.setWindowTitle("MainWindow Demo")
        self.resize(800, 600)

        button = QPushButton("close", self)
        # 連接內(nèi)置信號與自定義槽
        button.clicked.connect(self.onClose)

    # 自定義槽函數(shù)
    def onClose(self):
        self.close()

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()

    sys.exit(app.exec_())

點(diǎn)擊按鈕時(shí)觸發(fā)按鈕內(nèi)置的clicked信號，執(zhí)行綁定的自定義槽函數(shù)onClose。

3、自定義信號與內(nèi)置槽函數(shù)

import sys
from PyQt5.QtCore import pyqtSignal
from PyQt5.QtWidgets import QWidget, QApplication, QPushButton

class MainWindow(QWidget):
    closeSignal = pyqtSignal()

    def __init__(self, parent=None):
        super().__init__(parent)
        self.setWindowTitle("MainWindow Demo")
        self.resize(800, 600)

        button = QPushButton("close", self)
        # 連接內(nèi)置信號與自定義槽
        button.clicked.connect(self.onClose)
        # 連接自定義信號closeSignal與內(nèi)置槽函數(shù)close
        self.closeSignal.connect(self.close)

    # 自定義槽函數(shù)
    def onClose(self):
        # 發(fā)送自定義信號
        self.closeSignal.emit()

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()

    sys.exit(app.exec_())

通過連接內(nèi)置信號clicked到自定義槽函數(shù)onClose，在自定義槽函數(shù)onClose內(nèi)發(fā)送自定義信號closeSignal，并將自定義信號closeSignal與內(nèi)置槽函數(shù)close連接。

4、自定義信號與自定義槽函數(shù)

import sys
from PyQt5.QtCore import pyqtSignal
from PyQt5.QtWidgets import QWidget, QApplication, QPushButton

class MainWindow(QWidget):
    closeSignal = pyqtSignal()

    def __init__(self, parent=None):
        super().__init__(parent)
        self.setWindowTitle("MainWindow Demo")
        self.resize(800, 600)

        button = QPushButton("close", self)
        # 連接內(nèi)置信號與自定義槽
        button.clicked.connect(self.onClicked)
        # 連接自定義信號closeSignal與內(nèi)置槽函數(shù)close
        self.closeSignal.connect(self.onClose)

    # 自定義槽函數(shù)
    def onClicked(self):
        # 發(fā)送自定義信號
        self.closeSignal.emit()

    # 自定義槽函數(shù)
    def onClose(self):
        self.close()

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()

    sys.exit(app.exec_())

三、信號槽應(yīng)用進(jìn)階

1、自定義信號槽

通常通過類變量定義信號對象，在__init__函數(shù)前定義自定義信號。

class TestObject(QObject):
    # 定義無參的信號
    noParametersSignal = pyqtSignal()
    # 定義一個(gè)參數(shù)的信號，參數(shù)類型為int
    oneParameterSignal = pyqtSignal(int)
    # 定義一個(gè)參數(shù)的重載版本的信號，參數(shù)類型可以為int或str
    oneParameterOverloadSignal = pyqtSignal([int], [str])
    # 定義兩個(gè)參數(shù)的重載版本的信號，參數(shù)類型為int,str或int,int
    twoParametersOverloadSignal = pyqtSignal([int, str], [int, int])
    # 定義一個(gè)list參數(shù)類型的信號
    oneParameterSignalList = pyqtSignal(list)
    # 定義一個(gè)dict參數(shù)類型的信號
    oneParameterSignalDict = pyqtSignal(dict)

類的槽函數(shù)定義與類的普通方法定義相同。

class TestObject(QObject):
    # 定義無參的信號
    noParametersSignal = pyqtSignal()
    # 定義一個(gè)參數(shù)的信號，參數(shù)類型為int
    oneParameterSignal = pyqtSignal(int)
    # 定義一個(gè)參數(shù)的重載版本的信號，參數(shù)類型可以為int或str
    oneParameterOverloadSignal = pyqtSignal([int], [str])
    # 定義兩個(gè)參數(shù)的重載版本的信號，參數(shù)類型為int,str或int,int
    twoParametersOverloadSignal = pyqtSignal([int, str], [int, int])

    # 定義無參的槽函數(shù)
    def onNoParameterSlot(self):
        pass

    # 定義一個(gè)參數(shù)的槽函數(shù),參數(shù)為整型nIndex
    def onOneParameterSlot(self, nIndex):
        pass

    # 定義兩個(gè)參數(shù)的槽函數(shù)，參數(shù)為整型nIndex，字符串型sStatus
    def onTwoParametersSlot(self, nIndex, sStatus):
        pass

通過connect方法連接信號與槽函數(shù)，信號與槽函數(shù)可以屬于同一個(gè)QObject對象，也可以是不同的QObject對象。

test = TestObject()
test.noParametersSignal.connect(test.onNoParameterSlot)
test.oneParameterSignal.connect(test.onOneParameterSlot)
test.twoParametersOverloadSignal.connect(test.onTwoParametersSlot)

信號的發(fā)送通過emit方法進(jìn)行發(fā)送。

def update(self):
    self.noParametersSignal.emit()
    self.oneParameterSignal.emit(100)
    self.oneParameterOverloadSignal("Hello, PyQt5")
    self.twoParametersOverloadSignal(100, "Hello, PyQt5")

2、信號槽傳遞自定義參數(shù)

Qt中信號發(fā)出的參數(shù)個(gè)數(shù)必須大于等于槽函數(shù)的參數(shù)個(gè)數(shù)，PyQt使用自定義參數(shù)傳遞解決槽函數(shù)參數(shù)比信號參數(shù)多的問題。使用Lambda表達(dá)式或functools的partial函數(shù)可以傳遞自定義參數(shù)給槽函數(shù)，自定義參數(shù)類型可以是Python任意類型。

import sys
from PyQt5.QtWidgets import QWidget, QApplication, QPushButton, QHBoxLayout
from functools import partial

class MainWindow(QWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        button1 = QPushButton("Button1", self)
        button2 = QPushButton("Button2", self)

        layout = QHBoxLayout()
        layout.addWidget(button1)
        layout.addWidget(button2)
        self.setLayout(layout)

        self.setWindowTitle("MainWindow Demo")
        self.resize(800, 600)

        # lambda
        button1.clicked.connect(lambda: self.onButtonClicked(1))
        button2.clicked.connect(lambda: self.onButtonClicked(2))
        # partial
        button1.clicked.connect(partial(self.onButtonClicked, 1))
        button2.clicked.connect(partial(self.onButtonClicked, 2))

    # 自定義槽函數(shù)
    def onButtonClicked(self, n):
       print("Button {0} is Clicked".format(n))

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()

    sys.exit(app.exec_())

3、信號槽與裝飾器

PyQt中可以通過Python裝飾器定義信號與槽函數(shù)，使用方法如下：

@PyQt5.QtCore.pyqtSlot(bool)
def on_發(fā)送者對象名稱_發(fā)射信號名稱(self, parameter):
    pass

發(fā)送者對象名稱是使用setObjectName為QObject對象設(shè)置的對象名稱，通過信號名稱連接到槽函數(shù)的connectSlotsByName函數(shù)如下：
QtCore.QMetaObject.connectSlotsByName(self, QObject)
connectSlotsByName用于將QObject子孫對象的某些信號根據(jù)名稱連接到某些QObject對象的相應(yīng)槽函數(shù)。

import sys
from PyQt5 import QtCore
from PyQt5.QtWidgets import QWidget, QApplication, QPushButton, QHBoxLayout

class MainWindow(QWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        button1 = QPushButton("Button1", self)
        button1.setObjectName("Button1")
        button2 = QPushButton("Button2", self)
        button2.setObjectName("Button2")

        layout = QHBoxLayout()
        layout.addWidget(button1)
        layout.addWidget(button2)
        self.setLayout(layout)

        self.setWindowTitle("MainWindow Demo")
        self.resize(800, 600)

        QtCore.QMetaObject.connectSlotsByName(self)

    @QtCore.pyqtSlot()
    def on_Button1_clicked(self):
        print("Button1 is clicked")

    @QtCore.pyqtSlot()
    def on_Button2_clicked(self):
        print("Button2 is clicked")

if __name__ == "__main__":
    app = QApplication(sys.argv)
    window = MainWindow()
    window.show()

    sys.exit(app.exec_())

四、事件處理機(jī)制

1、事件機(jī)制與信號槽機(jī)制的區(qū)別

PyQt為事件處理提供了高級別的信號槽機(jī)制和低級別的事件處理機(jī)制，信號槽機(jī)制是事件處理機(jī)制的高級封裝。使用控件時(shí)，不用考慮事件處理機(jī)制，只需要關(guān)心信號槽即可；對于自定義派生控件，必須考慮事件處理機(jī)制，根據(jù)控件的行為需求重新實(shí)現(xiàn)相應(yīng)的事件處理函數(shù)。

2、事件處理的方法

PyQt提供了5種事件處理和過濾方法，分別為：
（1）重新實(shí)現(xiàn)事件處理函數(shù)
常用的事件處理函數(shù)如paintEvent、mouseMoveEvent、mousePressEvent、mouseReleaseEvent等。
（2）重新實(shí)現(xiàn)QObject.event事件分發(fā)函數(shù)
在增加新的事件時(shí)，需要重新實(shí)現(xiàn)QObject.event方法，并增加新事件的分發(fā)路由。
（3）安裝事件過濾器
如果對QObject對象調(diào)用installEventFilter方法，則為QObject對象安裝事件過濾器。QObject對象的所有事件都會(huì)先傳遞到事件過濾器eventFilter函數(shù)，在事件過濾器eventFilter函數(shù)中可以丟棄或修改某些事件，對感興趣的事件使用自定義的事件處理機(jī)制，對其它事件使用默認(rèn)事件處理機(jī)制。事件過濾機(jī)制會(huì)對QObject的所有事件進(jìn)行過濾，因此如果要過濾的事件比較多則會(huì)影響程序性能。
（4）在QApplication安裝事件過濾器
在QApplication對象安裝事件過濾器將會(huì)對所有QObject對象的所有事件進(jìn)行過濾，并且會(huì)首先獲得事件，即將事件發(fā)送給其它任何一個(gè)事件過濾器前，都會(huì)首先發(fā)送給QApplication的事件過濾器。
（5）重新QApplication的notify方法
PyQt使用QApplication對象的notify方法進(jìn)行分發(fā)事件，要想在任何事件過濾器前捕獲事件唯一的方法就是重新實(shí)現(xiàn)QApplication的notify方法。

3、事件處理實(shí)例

QDialog對話框在ESC按鍵按下時(shí)會(huì)自動(dòng)退出，使用事件處理和過濾對按下ESC按鍵進(jìn)行處理。
（1）重新實(shí)現(xiàn)事件處理函數(shù)

import sys
from PyQt5.QtWidgets import QDialog, QApplication
from PyQt5.QtCore import Qt

class Dialog(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)

    # 重新實(shí)現(xiàn)keyPressEvent
    def keyPressEvent(self, event):
        if event.key() != Qt.Key_Escape:
            QDialog.keyPressEvent(self, event)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    dialog = Dialog()
    dialog.exec_()

    sys.exit(app.exec_())

（2）重新實(shí)現(xiàn)event函數(shù)

import sys
from PyQt5.QtWidgets import QDialog, QApplication
from PyQt5.QtCore import Qt
from PyQt5.QtGui import QKeyEvent

class Dialog(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)

    # 重新實(shí)現(xiàn)keyPressEvent
    def event(self, event):
        if event.type() == QKeyEvent.KeyPress and event.key() == Qt.Key_Escape:
            return True
        else:
            return QDialog.event(self, event)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    dialog = Dialog()
    dialog.exec_()

    sys.exit(app.exec_())

（3）QObject安裝事件過濾器

import sys
from PyQt5.QtWidgets import QDialog, QApplication
from PyQt5.QtCore import Qt
from PyQt5.QtGui import QKeyEvent

class Dialog(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.installEventFilter(self)

    def eventFilter(self, watched, event):
        if event.type() == QKeyEvent.KeyPress and event.key() == Qt.Key_Escape:
            return True
        else:
            return QDialog.eventFilter(self, watched, event)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    dialog = Dialog()
    dialog.exec_()

    sys.exit(app.exec_())

（4）QApplication安裝事件過濾器

import sys
from PyQt5.QtWidgets import QDialog, QApplication
from PyQt5.QtCore import Qt
from PyQt5.QtGui import QKeyEvent

class Dialog(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)

    def eventFilter(self, watched, event):
        if event.type() == QKeyEvent.KeyPress and event.key() == Qt.Key_Escape:
            return True
        else:
            return QDialog.eventFilter(self, watched, event)

if __name__ == "__main__":
    app = QApplication(sys.argv)
    dialog = Dialog()
    app.installEventFilter(dialog)
    dialog.exec_()

    sys.exit(app.exec_())