Python Tricks —— 使用 keyboard 录制键盘事件

之前在某本书上看到一个程序，可以通过 Python 记录下全局范围内的键盘事件，使用的是 ctypes 库。
后来几经尝试，始终不能成功运行。原来它只支持 Python2 和 32 位的 Windows 系统。。。Excuse me？
于是在网上查找可行的替代方案，比如 pyHook 。呃，不合胃口。安装比较繁琐（有依赖库且不能通过 pip 命令安装），只支持 Windows 系统，况且又是十年前就没再更新的项目。。。看了下函数调用也算不上简洁直观。

后来又多番搜索，终于找到了一个名为 keyboard 的 Python 库，可以绑定全局事件、录制及模拟键盘输入、设置热键等。
尤其是安装和使用足够简单，比较合我的心意（毕竟 Github 上将近 1.5K 的小星星）。

一、特性

• 全局范围内的键盘事件绑定。即程序可以后台运行，捕捉其他软件下的按键动作。
• 跨平台，支持 Windows 、Linux 以及 MacOS 系统。支持 Python2 和 Python3 。
• 纯 Python 代码，无需编译 C 语言模块。无依赖库，安装简单（只是复制文件就可以）。
• 通过独立的线程捕捉事件，不阻塞主程序的运行。
• 很详细的文档，参见项目主页的 README 。

其实我真的有点感觉，这才是我心目中比较“现代”的工具。

二、录制及模拟按键动作

就像前面提到的，安装 keyboard 的流程非常简单，无需考虑任何兼容性或者依赖问题，只需要一条简短的命令：
$ pip install keyboard

可以使用下面的代码录制 10 秒钟的键盘事件，并将其回放一遍（即重复按下之前操作的按键）：

import keyboard
import time

keyboard.start_recording()
time.sleep(10)
events = keyboard.stop_recording()
keyboard.replay(events)

record 10s

可以使用如下代码制作一个简单的“键盘录制器”（打印输出全局范围内的按键动作，并将按键顺序保存在文本文件中）：

import keyboard

def print_pressed_keys(e):
    line = ', '.join(str(code) for code in keyboard._pressed_events)
    print(line)

    with open('keylogger.txt', 'a+') as f:
        f.write(line + '\n')

keyboard.hook(print_pressed_keys)
keyboard.wait()

keylogger

PS：上述代码中的 code 并不是对应按键的 ASCII 码，而是根据键盘布局为按键指定的数值（如 a 键为 30，b 键为 42 等等），可以通过自行测试确认具体的对应关系。
如同时按下两个或多个按键，则上述程序会以 code, code... 的形式输出。

三、热键捕获及绑定

可以使用如下代码录制热键并为该热键绑定上特定的触发事件：

import keyboard

print('Press and release your desired hotkey: ')
hotkey = keyboard.read_hotkey()
print('Hotkey selected: ', hotkey)

def on_triggered():
    print("Triggered!")

keyboard.add_hotkey(hotkey, on_triggered)
print("Press ESC to stop.")

hotkey

其他的使用方式就不再一一列举了，可以参考 keyboard 项目的 Github 主页。
几种常见的使用示例也已经包含在项目代码的 examples 目录下。

参考

keyboard