如何在PyCharm中调试Python多线程事件监听器？

问题描述 #

我编写了基于pynput的键盘监听代码：

from pynput import keyboard
import time

# The key combination to check
COMBINATIONS = []

# The currently active modifiers
current = set()
current_2 = set()

def main():
    def execute():
        print (f"Hotkeys {current} pressed")

    def on_press(key):
        if hasattr(key, 'vk'):
            current.add(key.vk)
            current_2.add(key)
        else:
            current.add(key.value.vk)
            current_2.add(key.name)

    def on_release(key):
        if len(COMBINATIONS) != 1:
            COMBINATIONS.append(set(current))
            COMBINATIONS.append(set(current_2))
            current.clear()
            current_2.clear()
        return False

    with keyboard.Listener(on_press=on_press, on_release=on_release) as listener:
        listener.join()

使用PyCharm社区版调试时，main函数执行后调试器停滞，无法进入on_press()等函数的断点，这类问题在处理Python多线程事件时经常出现，尝试过调整多种设置、切换不同断点均无效，如何才能进入这些线程和函数进行调试？

解决步骤 #

1. 开启多线程调试支持 #

打开PyCharm设置（File > Settings 或 Ctrl+Alt+S），依次进入 Build, Execution, Deployment > Debugger > Data Views，勾选Enable multi-process debugging选项。

2. 修改Listener线程属性 #

pynput的keyboard.Listener默认是守护线程，调试器可能无法自动追踪。显式设置为非守护线程：

with keyboard.Listener(
    on_press=on_press, 
    on_release=on_release,
    daemon=False  # 设为非守护线程
) as listener:
    listener.join()

3. 强制触发断点 #

如果普通断点不生效，可在on_press/on_release函数内插入临时调试语句，PyCharm会自动捕获调试会话：

def on_press(key):
    import pdb; pdb.set_trace()  # 插入该行，运行时自动进入调试
    if hasattr(key, 'vk'):
        current.add(key.vk)
        current_2.add(key)
    else:
        current.add(key.value.vk)
        current_2.add(key.name)

也可以右键断点图标，设置永远为真的条件（比如1==1），确保每次触发函数都会暂停。

4. 检查线程过滤设置 #

打开调试面板的Threads标签，确认没有过滤掉Listener对应的线程，取消所有线程过滤规则，让调试器显示全部线程。

5. 优化主线程阻塞逻辑 #

listener.join()会完全阻塞主线程，调试器可能优先追踪主线程状态。改用循环休眠的方式，给调试器留足切换线程的时间：

with keyboard.Listener(on_press=on_press, on_release=on_release) as listener:
    while listener.is_alive():
        time.sleep(0.1)  # 短暂休眠，避免主线程完全阻塞

内容的提问来源于stack exchange，提问作者user18528883