詳解PyQt5信號與槽的幾種高級玩法

更新時間：2020年03月24日 11:25:58 作者：博文視點

這篇文章主要介紹了詳解PyQt5信號與槽的幾種高級玩法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

信號（Signal）和槽（Slot）是Qt中的核心機制，也是在PyQt編程中對象之間進(jìn)行通信的機制。本文介紹了幾種PyQt 5信號與槽的幾級玩法。

在Qt中，每一個QObject對象和PyQt中所有繼承自QWidget的控件（這些都是QObject的子對象）都支持信號與槽機制。當(dāng)信號發(fā)射時，連接的槽函數(shù)將會自動執(zhí)行。在PyQt 5中信號與槽通過object.signal.connect()方法連接。

PyQt的窗口控件類中有很多內(nèi)置信號，開發(fā)者也可以添加自定義信號。信號與槽具有如下特點。

一個信號可以連接多個槽。
一個信號可以連接另一個信號。
信號參數(shù)可以是任何Python類型。
一個槽可以監(jiān)聽多個信號。
信號與槽的連接方式可以是同步連接，也可以是異步連接。
信號與槽的連接可能會跨線程。
信號可能會斷開。

在GUI編程中，當(dāng)改變一個控件的狀態(tài)時（如單擊了按鈕），通常需要通知另一個控件，也就是實現(xiàn)了對象之間的通信。在早期的GUI編程中使用的是回調(diào)機制，在Qt中則使用一種新機制——信號與槽。在編寫一個類時，要先定義該類的信號與槽，在類中信號與槽進(jìn)行連接，實現(xiàn)對象之間的數(shù)據(jù)傳輸。信號與槽機制示意圖如圖1所示。

當(dāng)事件或者狀態(tài)發(fā)生改變時，就會發(fā)出信號。同時，信號會觸發(fā)所有與這個事件（信號）相關(guān)的函數(shù)（槽）。信號與槽可以是多對多的關(guān)系。一個信號可以連接多個槽，一個槽也可以監(jiān)聽多個信號。

關(guān)于PyQt API中信號與槽的更詳細(xì)解釋，可以參考官方網(wǎng)站： http://pyqt.sourceforge.net/Docs/PyQt5/signals_slots.html

1 高級自定義信號與槽

所謂高級自定義信號與槽，指的是我們可以以自己喜歡的方式定義信號與槽函數(shù)，并傳遞參數(shù)。自定義信號的一般流程如下：

（1）定義信號。

（2）定義槽函數(shù)。

（3）連接信號與槽函數(shù)。

（4）發(fā)射信號。

1．定義信號

通過類成員變量定義信號對象。

class MyWidget(QWidget): 
  # 無參數(shù)的信號
  Signal_NoParameters = pyqtSignal()   
  # 帶一個參數(shù)(整數(shù))的信號   
  Signal_OneParameter = pyqtSignal(int)     
  # 帶一個參數(shù)(整數(shù)或者字符串)的重載版本的信號    
  Signal_OneParameter_Overload = pyqtSignal([int],[str]) 
  # 帶兩個參數(shù)(整數(shù),字符串)的信號   
    Signal_TwoParameters = pyqtSignal(int,str)  
  # 帶兩個參數(shù)([整數(shù),整數(shù)]或者[整數(shù),字符串])的重載版本的信號   
  Signal_TwoParameters_Overload = pyqtSignal([int,int],[int,str])

2．定義槽函數(shù)

定義一個槽函數(shù)，它有多個不同的輸入?yún)?shù)。

class MyWidget(QWidget): 
  def setValue_NoParameters(self):  
    '''無參數(shù)的槽函數(shù)''' 
    pass 

  def setValue_OneParameter(self,nIndex):  
    '''帶一個參數(shù)(整數(shù))的槽函數(shù)''' 
    pass

def setValue_OneParameter_String(self,szIndex):  
    '''帶一個參數(shù)(字符串)的槽函數(shù)''' 
    pass 

  def setValue_TwoParameters(self,x,y):  
    '''帶兩個參數(shù)(整數(shù),整數(shù))的槽函數(shù)''' 
    pass 

  def setValue_TwoParameters_String(self,x,szY):  
    '''帶兩個參數(shù)(整數(shù),字符串)槽函數(shù)''' 
    pass

3．連接信號與槽函數(shù)

通過connect方法連接信號與槽函數(shù)或者可調(diào)用對象。

app = QApplication(sys.argv)  
widget = MyWidget()  
# 連接無參數(shù)的信號
widget.Signal_NoParameters.connect(self.setValue_NoParameters )                     

# 連接帶一個整數(shù)參數(shù)的信號
widget.Signal_OneParameter.connect(self.setValue_OneParameter)                     

# 連接帶一個整數(shù)參數(shù)，經(jīng)過重載的信號
widget.Signal_OneParameter_Overload[int].
  connect(self.setValue_OneParameter)               

# 連接帶一個整數(shù)參數(shù)，經(jīng)過重載的信號
widget.Signal_OneParameter_Overload[str].
  connect(self.setValue_OneParameter_String )           

# 連接一個信號，它有兩個整數(shù)參數(shù)
widget.Signal_TwoParameters.connect(self.setValue_TwoParameters )                    

# 連接帶兩個參數(shù)(整數(shù),整數(shù))的重載版本的信號
widget.Signal_TwoParameters_Overload[int,int].
  connect(self.setValue_TwoParameters )           

# 連接帶兩個參數(shù)(整數(shù),字符串)的重載版本的信號
widget.Signal_TwoParameters_Overload[int,str].
  connect(self.setValue_TwoParameters_String )       
widget.show()

4．發(fā)射信號

通過emit方法發(fā)射信號。

class MyWidget(QWidget): 

  def mousePressEvent(self, event): 
    # 發(fā)射無參數(shù)的信號
    self.Signal_NoParameters.emit() 
    # 發(fā)射帶一個參數(shù)(整數(shù))的信號
    self.Signal_OneParameter.emit(1) 
    # 發(fā)射帶一個參數(shù)(整數(shù))的重載版本的信號
    self.Signal_OneParameter_Overload.emit(1)
    # 發(fā)射帶一個參數(shù)(字符串)的重載版本的信號
    self.Signal_OneParameter_Overload.emit("abc")
    # 發(fā)射帶兩個參數(shù)(整數(shù),字符串)的信號
    self.Signal_TwoParameters.emit(1,"abc")
    # 發(fā)射帶兩個參數(shù)(整數(shù),整數(shù))的重載版本的信號
    self.Signal_TwoParameters_Overload.emit(1,2)
    # 發(fā)射帶兩個參數(shù)(整數(shù),字符串)的重載版本的信號
    self.Signal_TwoParameters_Overload.emit (1,"abc")

5．實例

本例文件名為PyQt5/Chapter07/qt07_signalSlot02.py，其完整代碼如下：

from PyQt5.QtCore import QObject , pyqtSignal

class CustSignal(QObject):

  #聲明無參數(shù)的信號
  signal1 = pyqtSignal()

  #聲明帶一個int類型參數(shù)的信號
  signal2 = pyqtSignal(int)

  #聲明帶int和str類型參數(shù)的信號
  signal3 = pyqtSignal(int,str)

  #聲明帶一個列表類型參數(shù)的信號
  signal4 = pyqtSignal(list)

  #聲明帶一個字典類型參數(shù)的信號
  signal5 = pyqtSignal(dict)

  #聲明一個多重載版本的信號，包括帶int和str類型參數(shù)的信號和帶str類型參數(shù)的信號
  signal6 = pyqtSignal([int,str], [str])

  def __init__(self,parent=None):
    super(CustSignal,self).__init__(parent)

    #將信號連接到指定槽函數(shù)
    self.signal1.connect(self.signalCall1)
    self.signal2.connect(self.signalCall2)
    self.signal3.connect(self.signalCall3)
    self.signal4.connect(self.signalCall4)
    self.signal5.connect(self.signalCall5)
    self.signal6[int,str].connect(self.signalCall6)
    self.signal6[str].connect(self.signalCall6OverLoad)

    #發(fā)射信號
    self.signal1.emit()
    self.signal2.emit(1)
    self.signal3.emit(1,"text")
    self.signal4.emit([1,2,3,4])
    self.signal5.emit({"name":"wangwu","age":"25"})
    self.signal6[int,str].emit(1,"text")
    self.signal6[str].emit("text")

  def signalCall1(self):
    print("signal1 emit")

  def signalCall2(self,val):
    print("signal2 emit,value:",val)

  def signalCall3(self,val,text):
    print("signal3 emit,value:",val,text)

  def signalCall4(self,val):
    print("signal4 emit,value:",val)

  def signalCall5(self,val):
    print("signal5 emit,value:",val)

  def signalCall6(self,val,text):
    print("signal6 emit,value:",val,text)

  def signalCall6OverLoad(self,val):
    print("signal6 overload emit,value:",val)

if __name__ == '__main__': 
  custSignal = CustSignal()

運行結(jié)果如下：

signal1 emit
signal2 emit,value: 1
signal3 emit,value: 1 text
signal4 emit,value: [1, 2, 3, 4]
signal5 emit,value: {'name': 'wangwu', 'age': '25'}
signal6 emit,value: 1 text
signal6 overload emit,value: text

2 使用自定義參數(shù)

在PyQt編程過程中，經(jīng)常會遇到給槽函數(shù)傳遞自定義參數(shù)的情況，比如有一個信號與槽函數(shù)的連接是

button1.clicked.connect(show_page)

我們知道對于clicked信號來說，它是沒有參數(shù)的；對于show_page函數(shù)來說，希望它可以接收參數(shù)。希望show_page函數(shù)像如下這樣：

def show_page(self, name):
print(name," 點擊啦")

于是就產(chǎn)生一個問題——信號發(fā)出的參數(shù)個數(shù)為0，槽函數(shù)接收的參數(shù)個數(shù)為1，由于0<1，這樣運行起來一定會報錯（原因是信號發(fā)出的參數(shù)個數(shù)一定要大于槽函數(shù)接收的參數(shù)個數(shù)）。解決這個問題就是本節(jié)的重點：自定義參數(shù)的傳遞。

本書提供了兩種解決方法，其中一種解決方法是使用lambda表達(dá)式。本例文件名為PyQt5/Chapter07/qt07_ winSignalSlot04.py ，其完整代碼如下：

from PyQt5.QtWidgets import QMainWindow, QPushButton , QWidget , QMessageBox, QApplication, QHBoxLayout
import sys 

class WinForm(QMainWindow): 
  def __init__(self, parent=None): 
    super(WinForm, self).__init__(parent) 
    button1 = QPushButton('Button 1') 
    button2 = QPushButton('Button 2') 

    button1.clicked.connect(lambda: self.onButtonClick(1)) 
    button2.clicked.connect(lambda: self.onButtonClick(2))

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

    main_frame = QWidget() 
    main_frame.setLayout(layout)    
    self.setCentralWidget(main_frame) 

  def onButtonClick(self, n): 
    print('Button {0} 被按下了'.format(n)) 
    QMessageBox.information(self, "信息提示框", 'Button {0} clicked'.format(n))

if __name__ == "__main__": 
  app = QApplication(sys.argv) 
  form = WinForm() 
  form.show() 
  sys.exit(app.exec_())

運行腳本，顯示效果如圖2和圖3所示。

代碼分析：

單擊“Button 1”按鈕，將彈出一個信息提示框，提示信息為“Button 1 clicked”。Python控制臺的輸出信息為：

Button 1 被按下了

這里重點解釋onButtonClick()函數(shù)是怎樣處理從兩個按鈕傳來的信號的。使用lambda表達(dá)式傳遞按鈕數(shù)字給槽函數(shù)，當(dāng)然也可以傳遞其他任何東西，甚至是按鈕控件本身（假設(shè)槽函數(shù)打算把傳遞信號的按鈕修改為不可用的話）。

另一種解決方法是使用functools中的partial函數(shù)。本例文件名為PyQt5/Chapter07/qt07_winSignalSlot05.py，其核心代碼如下：

button1.clicked.connect(partial(self.onButtonClick, 1))     
button2.clicked.connect(partial(self.onButtonClick, 2))

采用哪種方法好一點呢？這屬于風(fēng)格問題，筆者比較喜歡使用lambda表達(dá)式，因為其條理清晰，而且靈活。

3 裝飾器信號與槽

所謂裝飾器信號與槽，就是通過裝飾器的方法來定義信號和槽函數(shù)。具體的使用方法如下：

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

這種方法有效的前提是下面的函數(shù)已經(jīng)執(zhí)行：

QMetaObject.connectSlotsByName(QObject)

在上面代碼中，“發(fā)送者對象名稱”就是使用setObjectName函數(shù)設(shè)置的名稱，因此自定義槽函數(shù)的命名規(guī)則也可以看成：on + 使用setObjectName設(shè)置的名稱 + 信號名稱。接下來看具體的使用方法。

本例文件名為PyQt5/Chapter07/qt07_connSlotsByName.py，其完整代碼如下：

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

class CustWidget( QWidget ):

  def __init__(self, parent=None):
    super(CustWidget, self).__init__(parent)

    self.okButton = QPushButton("OK", self)
    #使用setObjectName設(shè)置對象名稱
    self.okButton.setObjectName("okButton")
    layout = QHBoxLayout()
    layout.addWidget(self.okButton)
    self.setLayout(layout)
    QtCore.QMetaObject.connectSlotsByName(self)

  @QtCore.pyqtSlot()  
  def on_okButton_clicked(self):
    print( "單擊了OK按鈕")

if __name__ == "__main__":    
  app = QApplication(sys.argv)
  win = CustWidget()
  win.show()
  app.exec_()

運行腳本，顯示效果如圖4所示。單擊“OK”按鈕，控制臺打印出預(yù)期的調(diào)試信息。

有的讀者可能注意到，我們一直沒有解釋下面這行代碼的含義：

QMetaObject.connectSlotsByName(QObject)

事實上，它是在PyQt 5中根據(jù)信號名稱自動連接到槽函數(shù)的核心代碼。通過前面章節(jié)中的例子可以知道，使用pyuic5命令生成的代碼中會帶有這么一行代碼，接下來對其進(jìn)行解釋。

這行代碼用來將QObject中的子孫對象的某些信號按照其objectName連接到相應(yīng)的槽函數(shù)。這句話讀起來有些拗口，這里舉個例子進(jìn)行簡單說明。以上面例子中的代碼為例：

假設(shè)代碼QtCore.QMetaObject.connectSlotsByName(self)已經(jīng)執(zhí)行，則下面的代碼：

@QtCore.pyqtSlot()  
def on_okButton_clicked(self):
  print( "單擊了OK按鈕")

會被自動識別為下面的代碼（注意，函數(shù)中去掉了on，因為on會受到connectSlotsByName的影響，加上on運行時會出現(xiàn)問題）：

def __init__(self, parent=None):
    self.okButton.clicked.connect(self.okButton_clicked)
  def okButton_clicked(self):
    print("單擊了OK按鈕")

這部分代碼放在PyQt5/Chapter07/qt07_connSlotsByName_2.py文件中：

# -*- coding: utf-8 -*-

"""
  【簡介】
  信號與槽的自動連接例子
"""

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

class CustWidget( QWidget ):

  def __init__(self, parent=None):
    super(CustWidget, self).__init__(parent)

    self.okButton = QPushButton("OK", self)
    #使用setObjectName設(shè)置對象名稱
    self.okButton.setObjectName("okButton")    
    layout = QHBoxLayout()
    layout.addWidget(self.okButton)
    self.setLayout(layout)        
    QtCore.QMetaObject.connectSlotsByName(self)
    self.okButton.clicked.connect(self.okButton_clicked)

  def okButton_clicked(self):
    print( "單擊了OK按鈕")

if __name__ == "__main__":    
  app = QApplication(sys.argv)
  win = CustWidget()
  win.show()
  sys.exit(app.exec_())

運行上述代碼，發(fā)現(xiàn)結(jié)果和圖4一樣。

4 信號與槽的斷開和連接

有時候基于某些原因，想要臨時或永久斷開某個信號與槽的連接。這就是本節(jié)案例想要達(dá)到的目的。

本例文件名為PyQt5/Chapter07/qt07_signalSlot03.py，其完整代碼如下：

from PyQt5.QtCore import QObject , pyqtSignal

class SignalClass(QObject):

   # 聲明無參數(shù)的信號
  signal1 = pyqtSignal()

  # 聲明帶一個int類型參數(shù)的信號
  signal2 = pyqtSignal(int)

  def __init__(self,parent=None):
    super(SignalClass,self).__init__(parent)

    # 將信號signal1連接到sin1Call和sin2Call這兩個槽函數(shù)
    self.signal1.connect(self.sin1Call)
    self.signal1.connect(self.sin2Call)

    # 將信號signal2連接到信號signal1
    self.signal2.connect(self.signal1)

    # 發(fā)射信號
    self.signal1.emit()
    self.signal2.emit(1)

    # 斷開signal1、signal2信號與各槽函數(shù)的連接
    self.signal1.disconnect(self.sin1Call)
    self.signal1.disconnect(self.sin2Call)
    self.signal2.disconnect(self.signal1)

    # 將信號signal1和signal2連接到同一個槽函數(shù)sin1Call
    self.signal1.connect(self.sin1Call)
    self.signal2.connect(self.sin1Call)

    # 再次發(fā)射信號
    self.signal1.emit()
    self.signal2.emit(1)

  def sin1Call(self):
    print("signal-1 emit")

  def sin2Call(self):
    print("signal-2 emit")

if __name__ == '__main__': 
  signal = SignalClass()

運行結(jié)果如下：

signal-1 emit
signal-2 emit
signal-1 emit
signal-2 emit
signal-1 emit
signal-1 emit

5 多線程中信號與槽的使用

最簡單的多線程使用方法是利用QThread函數(shù)，如下代碼（見PyQt5/Chapter07/ qt07_signalSlot04.py）展示了QThread函數(shù)和信號與槽簡單的結(jié)合方法。其完整代碼如下：

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

class Main(QWidget):
  def __init__(self, parent = None):
    super(Main,self).__init__(parent)

    # 創(chuàng)建一個線程實例并設(shè)置名稱、變量、信號與槽
    self.thread = MyThread()
    self.thread.setIdentity("thread1")
    self.thread.sinOut.connect(self.outText)
    self.thread.setVal(6)

  def outText(self,text):
    print(text)

class MyThread(QThread):
  sinOut = pyqtSignal(str)

  def __init__(self,parent=None):
    super(MyThread,self).__init__(parent)
    self.identity = None

  def setIdentity(self,text):
    self.identity = text

  def setVal(self,val):
    self.times = int(val)
    # 執(zhí)行線程的run方法
    self.start()

  def run(self):
    while self.times > 0 and self.identity:
      # 發(fā)射信號
      self.sinOut.emit(self.identity+"==>"+str(self.times))
      self.times -= 1

if __name__ == '__main__': 
  app = QApplication(sys.argv)
  main = Main()
  main.show()
  sys.exit(app.exec_())

運行結(jié)果如下：

thread1==>6
thread1==>5
thread1==>4
thread1==>3
thread1==>2
thread1==>1

有時在開發(fā)程序時經(jīng)常會執(zhí)行一些耗時的操作，這樣就會導(dǎo)致界面卡頓，這也是多線程的應(yīng)用范圍之一——為了解決這個問題，我們可以創(chuàng)建多線程，使用主線程更新界面，使用子線程實時處理數(shù)據(jù)，最后將結(jié)果顯示到界面上。

本例中，定義了一個后臺線程類BackendThread來模擬后臺耗時操作，在這個線程類中定義了信號update_date。使用BackendThread線程類在后臺處理數(shù)據(jù)，每秒發(fā)射一次自定義信號update_date。

在初始化窗口界面時，定義后臺線程類BackendThread，并把線程類的信號update_date連接到槽函數(shù)handleDisplay()。這樣后臺線程每發(fā)射一次信號，就可以把最新的時間值實時顯示在前臺窗口的QLineEdit文本對話框中。

本例文件名為PyQt5/Chapter07/qt07_signalSlotThreaad.py，其完整代碼如下：

from PyQt5.QtCore import QThread , pyqtSignal, QDateTime 
from PyQt5.QtWidgets import QApplication, QDialog, QLineEdit
import time
import sys

class BackendThread(QThread):
  # 通過類成員對象定義信號
  update_date = pyqtSignal(str)

  # 處理業(yè)務(wù)邏輯
  def run(self):
    while True:
      data = QDateTime.currentDateTime()
      currTime = data.toString("yyyy-MM-dd hh:mm:ss")
      self.update_date.emit( str(currTime) )
      time.sleep(1)

class Window(QDialog):
  def __init__(self):
    QDialog.__init__(self)
    self.setWindowTitle('PyQt 5界面實時更新例子')
    self.resize(400, 100)
    self.input = QLineEdit(self)
    self.input.resize(400, 100)
    self.initUI()

  def initUI(self):
    # 創(chuàng)建線程
    self.backend = BackendThread()
    # 連接信號
    self.backend.update_date.connect(self.handleDisplay)
    # 開始線程
    self.backend.start()

  # 將當(dāng)前時間輸出到文本框
  def handleDisplay(self, data):
    self.input.setText(data)

if __name__ == '__main__':
  app = QApplication(sys.argv)
  win = Window()
  win.show() 
  sys.exit(app.exec_())

運行腳本，顯示效果如圖5所示。