Pythonkeyboard模块非阻塞监听教程

本篇文章给大家分享《Python keyboard 模块：非阻塞按键监听教程》，覆盖了文章的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

keyboard.read_key() 的阻塞特性解析

在开发需要实时响应用户按键的 Python 程序时，keyboard 模块是一个强大的工具。然而，初学者常会遇到一个问题：keyboard.read_key() 函数的行为可能与预期不符。根据 keyboard 模块的官方文档，read_key() 函数是阻塞式的。这意味着当程序执行到 read_key() 调用时，它会暂停当前线程的执行，直到检测到键盘事件发生，并返回该事件的名称或扫描码。

考虑以下一个尝试通过按下“q”键来停止自动跳跃程序的示例：

import keyboard as kbd
from time import sleep

while True:
    kbd.press("space")
    sleep(0.1)
    kbd.release("space")            
    # 问题所在：read_key() 是阻塞的
    if kbd.read_key() == "q":
        break

在这段代码中，每次循环迭代都会执行 kbd.read_key()。由于其阻塞特性，程序会停在那里等待用户按下任何键。只有在用户按下某个键后，read_key() 才会返回，然后程序才能继续执行。如果用户没有按下键，程序就会“卡住”，无法继续执行自动跳跃的逻辑，这显然不是我们希望的非阻塞式按键检测行为。

keyboard.add_hotkey()：实现非阻塞按键监听

为了解决 read_key() 的阻塞问题，keyboard 模块提供了 add_hotkey() 函数，它允许我们以非阻塞的方式监听特定的按键组合。add_hotkey() 的核心思想是注册一个“热键”（hotkey）和一个回调函数（callback）。当指定的热键被按下时，注册的回调函数会在后台被自动调用，而主程序可以继续执行，不受影响。

keyboard.add_hotkey() 的基本语法如下：

keyboard.add_hotkey(hotkey, callback, args=(), suppress=False, timeout=1, trigger_on_release=False)

其中最关键的参数是：

• hotkey: 字符串，表示要监听的按键或按键组合（例如："q", "ctrl+c", "alt+shift+f"）。
• callback: 当 hotkey 被按下时要执行的函数。

通过这种方式，我们可以将按键检测逻辑从主循环中分离出来，使其在后台异步运行。

实战示例：优雅地停止自动循环

现在，我们利用 add_hotkey() 来重构之前的自动跳跃程序，使其能够通过按下“q”键非阻塞地停止。

import keyboard as kbd
from time import sleep

# 定义一个全局标志，用于在回调函数和主循环之间通信
was_q_pressed = False
q_hotkey_id = None # 用于存储热键的ID，以便后续移除

# 定义当“q”键被按下时执行的回调函数
def on_q_press():
    global was_q_pressed
    global q_hotkey_id
    was_q_pressed = True # 设置标志为True
    # 一旦“q”键被按下并处理，就移除这个热键，防止重复触发或资源占用
    if q_hotkey_id:
        kbd.remove_hotkey(q_hotkey_id)
        print("“q”键热键已移除。")

# 注册“q”键的热键和回调函数
# add_hotkey 会返回一个ID，我们可以用它来移除热键
q_hotkey_id = kbd.add_hotkey("q", on_q_press)
print("正在执行自动跳跃程序... 按下 'q' 键停止。")

while True:
    kbd.press("space")
    sleep(0.1)
    kbd.release("space")            

    # 主循环定期检查全局标志
    if was_q_pressed:
        print("检测到 'q' 键按下，程序即将停止。")
        break

    # 为了避免CPU占用过高，可以在没有其他任务时稍作等待
    # sleep(0.01) # 可选，根据实际需求调整

print("程序已停止。")

代码解析：

1. 全局标志 was_q_pressed: 我们引入了一个布尔型全局变量 was_q_pressed。它的作用是在 on_q_press 回调函数和主循环之间建立通信桥梁。当“q”键被按下时，回调函数会修改这个标志的值。
2. 回调函数 on_q_press():
   • 这个函数会在“q”键被按下时自动执行。
   • 它将 was_q_pressed 设置为 True，通知主循环停止。
   • kbd.remove_hotkey(q_hotkey_id) 是一个重要的步骤。一旦热键被触发并完成其任务，通常最好将其移除，以避免不必要的资源占用或在程序逻辑中产生意外行为（例如，如果只想触发一次）。add_hotkey 返回的热键ID用于此目的。
3. 注册热键: q_hotkey_id = kbd.add_hotkey("q", on_q_press) 这一行完成了热键的注册。从这一刻起，keyboard 模块就开始在后台监听“q”键的按下事件。
4. 主循环检查: while True 循环中的 if was_q_pressed: 语句会定期检查这个全局标志。一旦 on_q_press() 函数将 was_q_pressed 设置为 True，主循环就会检测到这个变化，并执行 break 语句，从而优雅地退出循环。

注意事项与最佳实践

• 全局变量管理: 在回调函数中修改全局变量是一种常见的模式，但需要确保变量的名称不会与其他地方冲突，并且其生命周期与程序逻辑相匹配。对于更复杂的场景，可以考虑使用队列（queue.Queue）进行线程间通信，以提高健壮性。
• 热键的生命周期: 及时移除不再需要的热键是良好的编程习惯。如果一个热键只需要触发一次，那么在回调函数中移除它是一个有效的方法。如果程序需要监听多个热键，或者在不同阶段动态地添加/移除热键，则需要更好地管理这些热键的ID。
• 异步执行: add_hotkey() 的回调函数是在 keyboard 模块的内部线程中执行的。这意味着回调函数不会阻塞主程序的执行。然而，如果回调函数执行耗时操作，它可能会阻塞 keyboard 模块自身的事件处理，导致其他按键事件的延迟。因此，回调函数应尽可能保持轻量。
• 资源释放: 确保在程序退出前，所有注册的热键都被移除，或者让程序自然终止，keyboard 模块通常会清理其资源。

总结

通过理解 keyboard.read_key() 的阻塞特性，并恰当地利用 keyboard.add_hotkey() 的非阻塞事件监听机制，我们可以更灵活、更高效地处理 Python 程序中的键盘输入。add_hotkey() 结合回调函数和全局标志的模式，提供了一种优雅的方式来实现程序与用户输入的异步交互，从而避免程序卡顿，提升用户体验。掌握这一技巧，对于开发需要实时响应用户操作的自动化脚本或交互式应用至关重要。

到这里，我们也就讲完了《Pythonkeyboard模块非阻塞监听教程》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！