PySimpleGUI与日志处理器：安全地从后台线程更新GUI的实践指南

import logging
import PySimpleGUI as sg

class OutputHandler(logging.Handler):
    window: sg.Window

    def __init__(self, window: sg.Window):
        super().__init__(logging.DEBUG)
        self.window = window

    def emit(self, record):
        # 这是一个错误的示例：直接在非主线程更新GUI
        print(record.msg)
        # 以下两行代码在非主线程中执行时，会引发 RuntimeError
        self.window["-OUTPUT-"].print(record.msg)
        self.window.refresh()

import logging
import PySimpleGUI as sg

class GuiOutputHandler(logging.Handler):
    def __init__(self, window: sg.Window):
        super().__init__(logging.DEBUG)
        self.window = window

    def emit(self, record):
        # 修正：通过事件机制将消息发送到主线程
        # "LOG_MESSAGE" 是我们自定义的事件键，record.msg 是要传递的值
        self.window.write_event_value("LOG_MESSAGE", record.msg)

import PySimpleGUI as sg
import logging
import threading
import time
import random

# 1. 定义一个自定义的日志处理器，用于将日志消息发送到GUI主线程
class GuiOutputHandler(logging.Handler):
    def __init__(self, window: sg.Window):
        super().__init__(logging.DEBUG)
        self.window = window

    def emit(self, record):
        # 将日志消息作为事件值发送到主线程
        self.window.write_event_value("LOG_MESSAGE", record.msg)

# 2. 模拟一个长时间运行的任务函数
def long_running_task(logger: logging.Logger):
    logger.info("任务开始执行...")
    for i in range(1, 11):
        time.sleep(random.uniform(0.5, 1.5)) # 模拟耗时操作
        logger.info(f"处理进度：{i * 10}%")
        if i == 5:
            logger.warning("任务执行中遇到一个警告，继续处理...")
    logger.info("任务完成！")
    # 任务完成后，可以发送一个事件通知GUI重新启用按钮
    logger.info("---TASK_COMPLETED---") # 使用特殊标记通知GUI

# 3. GUI 布局定义
layout = [
    [sg.Text("PySimpleGUI 多线程日志输出示例", font=('Helvetica', 14))],
    [sg.Multiline(size=(80, 20), key="-OUTPUT-", autoscroll=True, enable_events=True, font=('Courier New', 10))],
    [sg.Button("启动任务", key="-START_TASK-", size=(15, 2)), sg.Button("退出", size=(15, 2))]
]

# 4. 创建 PySimpleGUI 窗口
window = sg.Window("多线程日志输出示例", layout, finalize=True)

# 5. 配置日志系统
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# 清除可能存在的其他处理器，避免重复输出
if logger.hasHandlers():
    logger.handlers.clear()

# 添加自定义的GUI处理器
gui_handler = GuiOutputHandler(window)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
gui_handler.setFormatter(formatter)
logger.addHandler(gui_handler)

# 也可以添加一个控制台处理器，方便调试和备用
console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)

# 6. 主事件循环
while True:
    event, values = window.read()

    if event == sg.WIN_CLOSED or event == "退出":
        break
    elif event == "-START_TASK-":
        # 当点击“启动任务”按钮时，在一个新线程中执行耗时任务
        # 这确保了GUI主线程不会被阻塞，保持界面响应
        threading.Thread(target=long_running_task, args=(logger,), daemon=True).start()
        window["-START_TASK-"].update(disabled=True) # 任务启动后禁用按钮，防止重复点击
    elif event == "LOG_MESSAGE":
        # 在主线程中接收并处理由 GuiOutputHandler 发送的日志消息
        message = values[event]
        if message == "---TASK_COMPLETED---":
            # 接收到任务完成的特殊标记，重新启用按钮
            window["-START_TASK-"].update(disabled=False)
            window["-OUTPUT-"].print("所有后台任务已完成，按钮已重新启用。", text_color='green')
        else:
            # 正常打印日志消息到 Multiline 元素
            window["-OUTPUT-"].print(message)

window.close()