- 1. Introduction
- 2. Program
Based on one of the questions on the forum, I wrote an example on using QThread in PyQt5, as well as using the moveToThread method to move the class object of the inherited QObject to another thread.
In this example, a certain algorithm is executed, which returns the text through the signal, as well as the color of the text to the main GUI. This data is added to the QTextBrowser with a color setting.
The program will look as follows
Introduction
There are two main approaches for using QThread in Qt :
- Create a new class that inherits from QThread and override the run method
- Create a new class that inherits from QObject , write a run method that will execute some code, and transfer the instance of this class to another thread using the moveToThread method
The first method is recommended to be used only if you really need to override the stream class in order to create special functionality in the stream class. If you need to execute some code in another thread, then for this you need to create a separate class that will be transferred to another thread using the moveToThread method.
Also, I want to note right away that you cannot transfer GUI objects to other threads. Qt programs have two kinds of threads:
- Main stream. GUI thread
- Workflows. Worker threads
All GUI objects should create and work only in a GUI thread, while various other algorithms can be executed in worker threads.
As mentioned, each program has one thread when it is started. This thread is called the "main thread" (also known as the "GUI thread" in Qt applications). The Qt GUI must run in this thread. All widgets and several related classes, for example QPixmap, don't work in secondary threads. A secondary thread is commonly referred to as a "worker thread" because it is used to offload processing work from the main thread.
That is, if, even if something works for you in another thread, it will be only an accident that will sooner or later make itself felt. And your program will stop working. Never pass other GUI objects to other threads.
Program
Now consider the code of our program. Please note that the algorithm of actions will be as follows
- We write a class that inherits from QObject and has a run method for executing code in another thread
- In the window constructor, create a stream object
- In the window constructor, create an object that will be transferred to another thread
- Transfer the object to another stream
- We connect signals and slots
- Run the thread
It is advisable to perform all the initialization of the object and stream in this sequence, if you do not already have sufficient experience.
However, then you would not read this article.
If you swap steps 4 and 5, then you first connect the signals and slots, and then transfer the object to another stream, which will break the signal / slot connection. The application window will stop working. Or the application may just crash.
import sys import time from PyQt5 import QtCore, QtWidgets from PyQt5.QtGui import QColor class Ui_Form(object): def setupUi(self, Form): Form.setObjectName("Form") Form.resize(453, 408) self.verticalLayout = QtWidgets.QVBoxLayout(Form) self.verticalLayout.setObjectName("verticalLayout") self.verticalLayout_2 = QtWidgets.QVBoxLayout() self.verticalLayout_2.setObjectName("verticalLayout_2") self.textBrowser = QtWidgets.QTextBrowser(Form) self.textBrowser.setObjectName("textBrowser") self.verticalLayout_2.addWidget(self.textBrowser) self.verticalLayout.addLayout(self.verticalLayout_2) self.horizontalLayout = QtWidgets.QHBoxLayout() self.horizontalLayout.setObjectName("horizontalLayout") spacerItem = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Minimum) self.horizontalLayout.addItem(spacerItem) self.pushButton = QtWidgets.QPushButton(Form) self.pushButton.setObjectName("pushButton") self.horizontalLayout.addWidget(self.pushButton) spacerItem1 = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Minimum) self.horizontalLayout.addItem(spacerItem1) self.verticalLayout.addLayout(self.horizontalLayout) self.retranslateUi(Form) QtCore.QMetaObject.connectSlotsByName(Form) def retranslateUi(self, Form): _translate = QtCore.QCoreApplication.translate Form.setWindowTitle(_translate("Form", "Example")) self.pushButton.setText(_translate("Form", "Input")) # Object, which will be moved to another thread class BrowserHandler(QtCore.QObject): running = False newTextAndColor = QtCore.pyqtSignal(str, object) # method which will execute algorithm in another thread def run(self): while True: # send signal with new text and color from aonther thread self.newTextAndColor.emit( '{} - thread 2 variant 1.\n'.format(str(time.strftime("%Y-%m-%d-%H.%M.%S", time.localtime()))), QColor(0, 0, 255) ) QtCore.QThread.msleep(1000) # send signal with new text and color from aonther thread self.newTextAndColor.emit( '{} - thread 2 variant 2.\n'.format(str(time.strftime("%Y-%m-%d-%H.%M.%S", time.localtime()))), QColor(255, 0, 0) ) QtCore.QThread.msleep(1000) class MyWindow(QtWidgets.QWidget): def __init__(self, parent=None): super().__init__() self.ui = Ui_Form() self.ui.setupUi(self) # use button to invoke slot with another text and color self.ui.pushButton.clicked.connect(self.addAnotherTextAndColor) # create thread self.thread = QtCore.QThread() # create object which will be moved to another thread self.browserHandler = BrowserHandler() # move object to another thread self.browserHandler.moveToThread(self.thread) # after that, we can connect signals from this object to slot in GUI thread self.browserHandler.newTextAndColor.connect(self.addNewTextAndColor) # connect started signal to run method of object in another thread self.thread.started.connect(self.browserHandler.run) # start thread self.thread.start() @QtCore.pyqtSlot(str, object) def addNewTextAndColor(self, string, color): self.ui.textBrowser.setTextColor(color) self.ui.textBrowser.append(string) def addAnotherTextAndColor(self): self.ui.textBrowser.setTextColor(QColor(0, 255, 0)) self.ui.textBrowser.append('{} - thread 2 variant 3.\n'.format(str(time.strftime("%Y-%m-%d-%H.%M.%S", time.localtime())))) if __name__ == '__main__': app = QtWidgets.QApplication(sys.argv) window = MyWindow() window.show() sys.exit(app.exec())
Огромное спасибо!
простите за беспокойсто. Разобрался )) Спасибо Вам огромное. По сути у Вас тольько и разобрался с сигналами и слотами
в продолжение, хотелось бы уточнить такой вопрос. Испускаемые сигналы - они глобальны? то есть на сгенерированный pyqtSignal в классе А, можно ли "подписаться" в классах B,C,D своими слотами? То есть по одному сигналу, может ли каждый класс выполнять что-то свое?
Да, можно. к одному сигналу можно быть подключено какое угодно количество слотов в каком угодно наборе объектов.
спасибо Вам большое
Hello. Let's say I want to send some variables to "run" define. How can we do that? I modified your code, I tried something like below, but the GUI is frozen that way. I could not be able to understand it. Can you please give me some advice?
Здравствуйте.
Разрешите пару вопросов...
1. Зачем нужен running = False ?
2. Можно ли (нужно?) принудительно завершать поток?
Ещё раз спасибо огромное! Ваш ресурс пожалуй лучший по Qt и PyQt на русском (и не только) языке!
День добрый
А можете, пожалуйста, уточнить каким образом можно принудительно завершить поток?
Вызвать либо метод quit() либо эквивалентный его вариант - метод exit(0)
Спасибо большое
Не уверен, что кто-то ответил спустя столько времени, но все же. Возможно кто-то отправлять сигнал из gui во второй поток, активируя там функцию run повторно? На примере чата. На каждон отправленое сообщение из gui активировать по новой функцию Run(), в которой бекенд обработки сообщений. Просто каждый раз завершать поток и стартовать его заного - очень долго. Как использовать поток повторно, после завершения метода run?
Вы можете использовать переменную running, которой можете контролировать выполнение функции run
Главное, это правильно обработать установку переменной running в рамках вашей программы
Сначала так и использовал, но в случае установки флага running в состояние выхода из цикла, run() завершается, поток все еще живет, но заново запустить run, обращаясь к этому методу так же, как и при старте потока, уже не могу. Возможно я как-то не так это делаю ._.
Да, вы правы. Я не подумал об этом.
В этом случае я бы попытался написать программу по другому.
Например, добавить в BrowserHandler очередь сообщений, а метод run не завершать, а заставить его обрабатывать сообщения каждый раз, когда что-то добавляется в очередь сообщений. Это будет наиболее правильное решение.
Решение хорошее, сейчас так и делаю. Но все равно остается открытым вопрос подвязки ивента из вне. Проще говоря, не хочется гонять вечный цикл в run, постоянго проверяя изменения очереди (пусть даже поставим QThread.msleep(100) на каждый виток цикла). А как заставить run шевелиться только по отправке сообщения,
Попробуйте принудительно вызывать сигнал started у потока. Это является потокобезопасным. И в данном случае вызов сигнала started должно запустить выполнения метода run, а потом продолжить выполнение главного потока.