python - 如何从 Python 日志记录模块获取非阻塞/实时行为？ (输出到 PyQt QTextBrowser)

Question

描述:我编写了一个自定义日志处理程序，用于捕获日志事件并将它们写入 QTextBrowser 对象(工作示例代码如下所示)。

问题:按下按钮会调用 someProcess()。这会将两个字符串写入 logger 对象。但是，字符串仅在 someProcess() 返回后出现。

问题:如何让记录的字符串立即/实时出现在 QTextBrowser 对象中？ (即，一旦 logger 输出方法被调用)

from PyQt4 import QtCore, QtGui
import sys
import time
import logging
logger = logging.getLogger(__name__)

class ConsoleWindowLogHandler(logging.Handler):
    def __init__(self, textBox):
        super(ConsoleWindowLogHandler, self).__init__()
        self.textBox = textBox

    def emit(self, logRecord):
        self.textBox.append(str(logRecord.getMessage()))

def someProcess():
    logger.error("line1")
    time.sleep(5)
    logger.error("line2")

if __name__ == "__main__":
    app = QtGui.QApplication(sys.argv)
    window = QtGui.QWidget()
    textBox = QtGui.QTextBrowser()
    button = QtGui.QPushButton()
    button.clicked.connect(someProcess)
    vertLayout = QtGui.QVBoxLayout()
    vertLayout.addWidget(textBox)
    vertLayout.addWidget(button)
    window.setLayout(vertLayout)
    window.show()
    consoleHandler = ConsoleWindowLogHandler(textBox)
    logger.addHandler(consoleHandler)
    sys.exit(app.exec_())

编辑:感谢@abarnert 的回答，我设法使用 QThread 编写了这段工作代码。我将 QThread 子类化，以便在后台线程中运行某些函数 someProcess。对于信号，我不得不求助于旧式 Signal and Slots(我不确定如何使用新式)。我创建了一个虚拟 QObject，以便能够从日志记录处理程序发出信号。

from PyQt4 import QtCore, QtGui
import sys
import time
import logging
logger = logging.getLogger(__name__)

#------------------------------------------------------------------------------
class ConsoleWindowLogHandler(logging.Handler):
    def __init__(self, sigEmitter):
        super(ConsoleWindowLogHandler, self).__init__()
        self.sigEmitter = sigEmitter

    def emit(self, logRecord):
        message = str(logRecord.getMessage())
        self.sigEmitter.emit(QtCore.SIGNAL("logMsg(QString)"), message)

#------------------------------------------------------------------------------
class Window(QtGui.QWidget):
    def __init__(self):
        super(Window, self).__init__()

        # Layout
        textBox = QtGui.QTextBrowser()
        self.button = QtGui.QPushButton()
        vertLayout = QtGui.QVBoxLayout()
        vertLayout.addWidget(textBox)
        vertLayout.addWidget(self.button)
        self.setLayout(vertLayout)

        # Connect button
        self.button.clicked.connect(self.buttonPressed)

        # Thread
        self.bee = Worker(self.someProcess, ())
        self.bee.finished.connect(self.restoreUi)
        self.bee.terminated.connect(self.restoreUi)

        # Console handler
        dummyEmitter = QtCore.QObject()
        self.connect(dummyEmitter, QtCore.SIGNAL("logMsg(QString)"),
                     textBox.append)
        consoleHandler = ConsoleWindowLogHandler(dummyEmitter)
        logger.addHandler(consoleHandler)

    def buttonPressed(self):
        self.button.setEnabled(False)
        self.bee.start()

    def someProcess(self):
        logger.error("starting")
        for i in xrange(10):
            logger.error("line%d" % i)
            time.sleep(2)

    def restoreUi(self):
        self.button.setEnabled(True)

#------------------------------------------------------------------------------
class Worker(QtCore.QThread):
    def __init__(self, func, args):
        super(Worker, self).__init__()
        self.func = func
        self.args = args

    def run(self):
        self.func(*self.args)

#------------------------------------------------------------------------------
if __name__ == "__main__":
    app = QtGui.QApplication(sys.argv)
    window = Window()
    window.show()
    sys.exit(app.exec_())

Answer 1

这里真正的问题是您在主线程中休眠会阻塞整个 GUI 5 秒钟。您不能那样做，否则将不会显示任何更新，用户将无法与您的应用交互，等等。日志记录问题只是该主要问题的次要子后果。

如果您的真实程序正在从第三方模块调用一些代码，这需要 5 秒或执行某些阻塞操作，它会遇到完全相同的问题。

一般来说，有两种方法可以在不阻塞 GUI(或其他基于事件循环的)应用程序的情况下进行缓慢、阻塞的操作:

1. 在后台线程中完成工作。根据您的 GUI 框架，从后台线程，您通常不能直接在 GUI 上调用函数或修改其对象；相反，您必须使用某种机制将消息发布到事件循环。在 Qt 中，您通常通过信号槽机制来执行此操作。参见 this question了解详情。

2. 将作业分解为快速返回的非阻塞作业或仅保证非常短期的阻塞作业，每个作业在返回前安排下一个作业。 (对于某些 GUI 框架，您可以通过调用诸如 safeYield 之类的东西或递归地调用事件循环来执行等效的内联操作，但您不会在 Qt 中执行此操作。)

   <

鉴于 someProcess 是一些您无法修改的外部代码，它要么需要几秒钟才能完成，要么会造成阻塞，您不能使用选项 2。因此，选项 1 是:在后台线程中运行它。

幸运的是，这很容易。 Qt 有办法做到这一点，但 Python 的方法更简单:

t = threading.Thread(target=someProcess)
t.start()

现在，您需要更改 ConsoleWindowLogHandler.emit，而不是直接修改 textBox，而是发送信号以在主线程中完成该操作。参见 Threads and QObjects有关所有细节和一些很好的例子。

更具体地说:Mandelbrot 示例使用了一个 RenderThread，它实际上并不绘制任何东西，而是发送一个 renderedImage 信号； MandelbrotWidget 然后有一个 updatePixmap 插槽，它连接到 renderedImage 信号。同样，您的日志处理程序实际上不会更新文本框，而是发送一个 gotLogMessage 信号；那么您将拥有一个 LogTextWidget 和一个连接到该信号的 updateLog 插槽。当然，对于您的简单情况，您可以将它们放在一个类中，只要您使用信号槽连接而不是直接方法调用将两侧连接起来即可。

您可能希望将 t 保留在某处并在关闭期间加入，或者设置 t.daemon = True。

无论哪种方式，如果您想知道 someProcess 何时完成，您需要使用其他方式在完成时与您的主线程进行通信——同样，对于 Qt，通常的答案是发出信号。这还可以让您从 someProcess 返回结果。而且您不需要修改 someProcess 来执行此操作；只需定义一个调用 someProcess 并发出结果信号的包装函数，然后从后台线程调用该包装函数。