建站提交历史文章，原文写作时间 2021 年 8 月 15 日。

pynput 键盘鼠标事件抑制

前言

最近想用pynput做一个键盘映射，但是遇到的了一些问题，键盘映射有时需要抑制原输出。本人在CSDN找了很久，但是发现没有相关的文章。在查找了官方文档，并做了一些测试后，想写一篇文章来扩充一下。
在这里我提供了两种方案，各有优劣。相比较而言，方法二方便、稳定（推荐 ）；方法一更加灵活，在特殊场合适用。

方案一

pynput的官方文档中有简单提到，Listener类的参数中有一项suppress(抑制)。

“suppress(逻辑型) - 是否抑制事件，将此参数设置成True，就可以阻止事件传递到你的操作系统。”

也就是说，pynput提供的抑制必须在启动监听的时候设置，这里我们以键盘事件为例，因为往往它是我们要拦截的对象，当然鼠标事件的抑制用法也是完全相同的。

1
2
3
4
5
6
7
8
9
10
11
12
13
from pynput import keyboard


def on_press(key):
    pass


def on_release(key):
   pass


with keyboard.Listener(on_press=on_press, on_release=on_release, suppress=True) as lis:
    lis.join()

如上我们抑制了所有键盘事件。
但是问题接踵而至，pynput的抑制原事件的同时，也抑制了包括回调函数内的输出，这并不是我们期待的。
注意以下是错误示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from pynput import keyboard


def on_press(key):
    if key == keyboard.Key.enter:
        c.press(key)
    elif key == keyboard.Key.delete:
        c.press(keyboard.Key.backspace)


def on_release(key):
    # 代码略
  

c = keyboard.Controller()
with keyboard.Listener(on_press=on_press, on_release=on_release, suppress=True) as lis:
    lis.join()

如上图，我们希望enter不被拦截，delete被映射到backspace，但是都失败了。这很好理解，在键盘监听开启的时候，模拟的键盘事件同样会首先传递到监听器，而无法穿透监听器的抑制，监听器无法区分模拟与真实的键盘事件。
那么我们该怎么做？
​pynput提供了一个终止监听的方法 ，在回调函数中使用：

1
2
# return False
# 或者 lis.stop()

思路来了，既然事件无法穿透监听器，那么我们就暂时关闭监听器，注意是暂时。记下我们要执行的事件，终止监听，提交事件，重启监听，Replay…
完整示例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
from pynput import keyboard


def on_press(key):
    if key == keyboard.Key.enter:  # 不抑制enter
        tmp_events.append((key, True))  # 一个事件用按键名+ 按下还是释放 来描述
    elif key == keyboard.Key.delete:  # delete到backspace的映射
        tmp_events.append((keyboard.Key.backspace, True))
    elif key == keyboaed.Key.space:  # 按10下空格
        for __ in range(10):
            tmp_events.append((key, True))
            tmp_events.append((key, False))
    return False


def on_release(key):
    if key == keyboard.Key.enter:
        tmp_events.append((key, False))
    elif key == keyboard.Key.delete:
        tmp_events.append((keyboard.Key.backspace, False))
    # 释放空格不需要添加到列表，因为在on_press我们已经释放了space。
    return False


tmp_events = []  # 存储待执行的事件
c = keyboard.Controller()
while True:
    with keyboard.Listener(on_press=on_press, on_release=on_release, suppress=True) as lis:
        lis.join()
    for event in tmp_events:  # 提交待执行的事件
        if event[1]:
            c.press(event[0])
        else:
            c.release(event[0])

但是这样做有一个特别严重的问题，如果我们同时按下两个键，其中一个事件不会被监听到，也就是其中一个不会被抑制。问题来源于结束监听后的操作花费了大约10ms的时间。

方案二

如果抑制全部事件，我们一定需要结束监听，然后花费一点时间提交我们希望输出的事件。
再查官方文档，发现pynput官方文档解答了这个问题。

“suppress=True抑制所有事件，适用所有造作系统。如果这无法满足你的需求，针对不同系统，有不同的解决方案。”
文档下面简略的写了关于mac与Windows的解决方案。

针对Windows，我完善了官方的代码示例。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
def win32_event_filter(msg, data):
    """
    :param msg: 按下时为256，松开时为257
    :param data: data.vkCode是按键的vk值
    """
    if data.vkCode == 0x58:  # 0x58是x的键值(16进制)
        # 抑制"x"
        lis.suppress_event()
        # lis.suppress_event必须放在最后，因为它在拦截事件的同时有等价于return True的作用
        # lis.suppress_event只在win32_event_filter()中起效


# 不需要on_press()和on_release()


with pynput.keyboard.Listener(win32_event_filter=win32_event_filter) as lis:
       lis.join()

win32_event_filter必须有两个参数：msg和data，而data.vkCode就是要拦截的键的vk值。
这里我们就 不需要on_press()和on_release() 这两个回调了，因为我们发现通过msg已经可以判断按键的状态了。
​至于vk值如何获取，本人不建议pynput官方提供的Microsoft文档网址，因为使用下面的这个函数就可以直接获取。 

1
2
3
4
5
6
7
8
9
10
11
12
def get_vk(key):
    """
    返回key的vk值.
    :param key: 必须是 <class 'pynput.keyboard._win32.KeyCode'> 类, 或者 <enum 'Key'> 类.
    :return: vk值.
    """
    if isinstance(key, pynput.keyboard.Key):
        return key.value.vk
    elif isinstance(key, pynput.keyboard._win32.KeyCode):
        return key.vk
    else:
        return None

通过这种方法，把前面的案例再做一遍。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def get_vk(key):
    if isinstance(key, pynput.keyboard.Key):
        return key.value.vk
    elif isinstance(key, pynput.keyboard._win32.KeyCode):
        return key.vk
    else:
        return None
        

def win32_event_filter(msg, data):
    # data与keyboard.Key不是一个类的实例，因此不能直接划等号，我们使用vk值来识别
    if data.vkCode == get_vk(keyboard.Key.enter):  # 不抑制enter
        pass
    elif data.vkCode == get_vk(keyboard.Key.delete):  # delete到backspace的映射
        if msg == 256:
            ctrl.press(keyboard.Key.backspace)
        else:
            ctrl.release(keyboard.Key.backspace)
        lis.suppress_event()
    elif data.vkCode == get_vk(keyboard.Key.space):  # space敲10下
        if msg == 256:
            for __ in range(9):  # 额外敲9下
                ctrl.press(keyboard.Key.space)
                ctrl.release(keyboard.Key.space)
    else:  # 其他一律拦截
        lis.suppress_event()


ctrl = keyboard.Controller()
with pynput.keyboard.Listener(win32_event_filter=win32_event_filter) as lis:
       lis.join()

THE END.
参考资料：pynput官方文档