Python keyboard 模块：实现非阻塞式按键检测与程序控制

理解 keyboard.read_key() 的阻塞行为

在使用 python 的 keyboard 模块进行按键监听时，一个常见的误区是直接使用 keyboard.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

这段代码的预期是循环会持续执行，直到按下“q”键才停止。然而，实际运行时，程序会在执行到 if kbd.read_key() == "q": 这一行时完全停滞。这是因为 keyboard.read_key() 函数的特性是阻塞式的。根据 keyboard 模块的官方文档，read_key() 会“阻塞直到键盘事件发生，然后返回该事件的名称或其扫描码”。这意味着它会暂停程序的执行，直到用户按下任意一个键。因此，它无法在主程序持续运行的同时，异步地检测某个按键是否被按下。

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

为了在不阻塞主程序的情况下监听按键事件，keyboard 模块提供了 keyboard.add_hotkey() 函数。这个函数允许我们注册一个热键（或组合键）和一个对应的回调函数。当热键被按下时，回调函数会在后台被触发，而不会中断主程序的执行流程。

其基本原理是：

1. 注册热键与回调函数： 使用 add_hotkey() 将一个按键（或组合键）与一个 Python 函数关联起来。
2. 异步监听： keyboard 模块会在后台持续监听键盘事件。
3. 触发回调： 当注册的热键被按下时，对应的回调函数会被自动调用。
4. 通信机制： 在回调函数中，我们可以通过修改一个全局变量来通知主程序按键已被按下。

下面是使用 add_hotkey() 改进上述自动化程序的示例：

倍塔塞司

AI职业规划、AI职业测评、定制测评、AI工具等多样化职业类AI服务。

9

查看详情

立即学习“Python免费学习笔记（深入）”；

import keyboard as kbd
from time import sleep

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

# 2. 定义回调函数，当“q”键被按下时执行
def on_q_press():
  global was_q_pressed # 声明使用全局变量
  was_q_pressed = True # 设置标志为True
  # 3. 如果只需要触发一次，及时移除热键
  if q_hotkey:
      kbd.remove_hotkey(q_hotkey)
      print("“q”键被按下，程序即将停止。")

# 4. 注册热键和回调函数
# add_hotkey返回一个引用，可以用于之后移除热键
q_hotkey = kbd.add_hotkey("q", on_q_press)

print("程序正在运行，按下“q”键停止...")

# 主程序循环
while True:
    kbd.press("space")
    sleep(0.1)
    kbd.release("space")            

    # 5. 检查全局标志，非阻塞地判断是否停止
    if was_q_pressed:
        break

print("程序已停止。")

代码解析：

1. was_q_pressed = False: 这是一个布尔类型的全局变量，用于在主循环和回调函数之间传递状态信息。初始值为 False，表示“q”键尚未被按下。
2. q_hotkey = None: 这个变量将用于存储 add_hotkey 返回的热键引用。这个引用在后续需要移除热键时会用到。
3. def on_q_press():: 这是当“q”键被按下时会执行的回调函数。
   • global was_q_pressed: 在函数内部修改全局变量时，必须使用 global 关键字明确声明，否则 Python 会将其视为局部变量。
   • was_q_pressed = True: 当“q”键被按下时，回调函数将 was_q_pressed 设置为 True。
   • kbd.remove_hotkey(q_hotkey): 这是一个重要的步骤。如果你的程序只需要在“q”键第一次按下时停止，那么在回调函数中立即移除热键可以防止它被重复触发，并释放相关资源。如果需要多次触发或持续监听，则可以省略此行。
4. q_hotkey = kbd.add_hotkey("q", on_q_press): 这一行是核心。它告诉 keyboard 模块，当用户按下“q”键时，请调用 on_q_press 函数。add_hotkey 会返回一个对象，我们将其存储在 q_hotkey 中以便后续管理。
5. if was_q_pressed:: 在主循环中，我们不再调用阻塞的 read_key()，而是简单地检查 was_q_pressed 标志。由于 on_q_press 是在后台被调用的，这个检查是完全非阻塞的，允许主循环持续执行其自动化任务。

注意事项与最佳实践

• 热键的生命周期管理： 如果一个热键只需要触发一次（例如，用于终止程序），那么在回调函数中调用 kbd.remove_hotkey() 是一个好的实践。这可以避免不必要的资源占用，并确保热键不会在程序逻辑之外被意外触发。如果需要持续监听或多次触发，则不应移除热键。
• 全局变量的使用： 在回调函数中使用全局变量是实现主程序和回调函数之间通信的有效方式。然而，在更复杂的异步或多线程应用中，直接修改全局变量可能导致竞争条件。对于本教程中的简单场景，这种方法是安全且高效的。
• 权限问题： 在某些操作系统（如 Windows）上，keyboard 模块可能需要以管理员权限运行才能正确监听所有键盘事件。如果程序无法检测到按键，请尝试以管理员身份运行。
• 环境兼容性： keyboard 模块主要设计用于桌面环境。在无头服务器或其他特殊环境中，其功能可能受限或需要额外的配置。

总结

通过本教程，我们了解了 keyboard.read_key() 的阻塞特性及其在自动化任务中的局限性。重要的是，我们掌握了如何利用 keyboard.add_hotkey() 函数结合回调机制，实现非阻塞式的按键监听。这种方法不仅能够让主程序流畅运行，还能在需要时响应用户的输入，从而为自动化脚本和交互式程序提供了强大的控制能力。正确理解并应用 add_hotkey() 将使你的 Python 键盘交互程序更加健壮和用户友好。

以上就是Python keyboard 模块：实现非阻塞式按键检测与程序控制的详细内容，更多请关注php中文网其它相关文章！