Python PyQt シグナルとスロット機構

シグナルとスロット(Signals and Slots)は、PyQt でオブジェクト間通信に使用されるメカニズムであり、Qt フレームワークの中心的な機能の1つです。このメカニズムは、異なるオブジェクトが互いの具体的な実装を知ることなく通信できる、柔軟で型安全な方法を提供します。

簡単に言うと:

  • シグナル(Signal):特定のイベントが発生したときに送信される通知
  • スロット(Slot):シグナルを受け取り応答する関数

なぜシグナルとスロットが必要なのか?

従来の GUI プログラミングでは、通常コールバック関数を使用してユーザー操作を処理します。PyQt のシグナルとスロット機構はコールバック関数と比較して以下の利点があります:

  1. 疎結合:シグナルを送信するオブジェクトは、どのオブジェクトがそれを受け取るかを知る必要がない
  2. 型安全性:シグナルとスロットのパラメータ型は接続時にチェックされる
  3. 多対多の関係:1つのシグナルは複数のスロットに接続でき、1つのスロットは複数のシグナルを受け取ることができる
  4. スレッドセーフ:スレッド間通信をサポート

基本的な使い方

シグナルの作成

カスタム QObject サブクラスでは、使用できますpyqtSignal()を使ってシグナルを定義します:

サンプル

from PyQt5.QtCore import QObject, pyqtSignal

class MyEmitter(QObject):
    # パラメータのないシグナルを定義
    signal1 = pyqtSignal()
   
    # 文字列パラメータを持つシグナルを定義
    signal2 = pyqtSignal(str)
   
    # 複数のパラメータを持つシグナルを定義
    signal3 = pyqtSignal(int, str)

シグナルの発射

シグナルを定義したら、シグナルのemit()メソッドを呼び出して発射できます:

サンプル

emitter = MyEmitter()
emitter.signal1.emit()           # パラメータのないシグナルを発射
emitter.signal2.emit("Hello")    # 文字列パラメータを持つシグナルを発射
emitter.signal3.emit(123, "abc") # 複数のパラメータを持つシグナルを発射

スロット関数の作成

スロット関数は任意の Python 呼び出し可能オブジェクトであり、通常はインスタンスメソッドです:

サンプル

class MyReceiver:
    def slot1(self):
        print("slot1 called")
   
    def slot2(self, text):
        print(f"slot2 called with: {text}")
   
    def slot3(self, number, text):
        print(f"slot3 called with: {number}, {text}")

シグナルとスロットの接続

シグナルのconnect()メソッドを使用してシグナルをスロットに接続します:

サンプル

emitter = MyEmitter()
receiver = MyReceiver()

# シグナルとスロットを接続
emitter.signal1.connect(receiver.slot1)
emitter.signal2.connect(receiver.slot2)
emitter.signal3.connect(receiver.slot3)

実際の応用例

例1: ボタンクリックイベント

サンプル

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

def on_button_clicked():
    print("Button was clicked!")

app = QApplication([])

window = QWidget()
layout = QVBoxLayout()

button = QPushButton("Click Me")
button.clicked.connect(on_button_clicked)  # シグナルとスロットを接続

layout.addWidget(button)
window.setLayout(layout)
window.show()

app.exec_()

例2: カスタムシグナル

サンプル

from PyQt5.QtCore import QObject, pyqtSignal

class Worker(QObject):
    progressChanged = pyqtSignal(int)  # int パラメータを持つシグナルを定義
   
    def do_work(self):
        for i in range(101):
            self.progressChanged.emit(i)  # シグナルを発射

class Window(QWidget):
    def __init__(self):
        super().__init__()
        self.worker = Worker()
        self.worker.progressChanged.connect(self.update_progress)
       
    def update_progress(self, value):
        print(f"Progress: {value}%")

window = Window()
window.worker.do_work()

上級の使い方

接続の解除

次を使用してdisconnect()メソッドでシグナルとスロットの接続を解除できます:

サンプル

emitter.signal1.disconnect(receiver.slot1)

シグナルのブロック

オブジェクトがすべてのシグナルを発射するのを一時的に防ぎます:

サンプル

emitter.blockSignals(True)  # シグナルをブロック
# ここで発射されたシグナルは渡されない
emitter.blockSignals(False) # ブロックを解除

シグナルとスロットの接続タイプ

PyQt は複数の接続タイプをサポートしており、Qt.ConnectionTypeで指定します:

  1. Qt.AutoConnection(デフォルト)
  2. Qt.DirectConnection
  3. Qt.QueuedConnection
  4. Qt.BlockingQueuedConnection
  5. Qt.UniqueConnection

サンプル

from PyQt5.QtCore import Qt

emitter.signal1.connect(receiver.slot1, Qt.QueuedConnection)

よくある問題と解決策

問題1: シグナルがスロット関数をトリガーしない

考えられる原因:

  1. シグナルとスロットが正しく接続されていない
  2. 受信オブジェクトが破棄された
  3. シグナルがブロックされている

解決策:

  1. 接続コードが正しいか確認する
  2. 受信オブジェクトがまだ存在することを確認する
  3. シグナルをブロックするコードがないか確認する

問題2: パラメータの型が一致しない

考えられる原因:シグナルとスロットのパラメータの型または数が一致しない

解決策:

  1. シグナルとスロットのパラメータ定義を確認する
  2. デコレータを使用する@pyqtSlotスロットのパラメータ型を明示的に指定する

サンプル

from PyQt5.QtCore import pyqtSlot

class MyReceiver:
    @pyqtSlot(int)
    def slot(self, value):
        print(value)

ベストプラクティス

  1. 明確な命名:シグナルとスロットに説明的な名前を付ける
  2. パラメータを明確に:シグナルとスロットのパラメータ型を明確に指定する
  3. リソース管理:不要になった接続はすぐに解除する
  4. スレッドセーフ:スレッド間通信に使用しますQueuedConnection
  5. ドキュメントの充実:カスタムシグナルとスロットに docstring を追加する

シグナルとスロット機構は PyQt プログラミングの中核であり、それを習得することで GUI アプリケーション開発の効率と品質が大幅に向上します。これらの例を実践し、ベストプラクティスに従うことで、応答性が高く構造が明確な PyQt アプリケーションを構築できるようになります。

その他の拡張