python監聽、操作鍵盤滑鼠庫pynput詳細教程

2020 年 5 月 17 日
筆記
python模組介紹

§ 0.0.0 前言

監聽、操作滑鼠、鍵盤是實現自動化的捷徑，比如我實現自動化簽到用到了模擬鍵盤操作。

pynput是監聽、操控滑鼠和鍵盤的跨平台第三方python庫。
你可以通過pip insnall pynput來安裝。安裝時會自動下載依賴庫。

pypi鏈接在此。

接下來我會按「滑鼠按鍵」「監聽滑鼠」「控制滑鼠」，
「鍵盤按鍵」「監聽鍵盤」「控制鍵盤」的順序介紹它的用法。

以下為正文。

§1.0.0 滑鼠按鍵

滑鼠的按鍵在pynput.mouse.Button中，
有lift、right、middle還有unknown四種。

每一個按鍵都有兩個有意義的屬性：name和value。
name是該按鍵的名稱，比如 Button.left.name == ‘left’；
value是記錄上一次點擊位置的元組。

§1.1.0 監聽滑鼠

有兩種方法，一種是函數式、非阻塞型，另一種是語句式、非阻塞型。

先說第一種，這種是常見的教程所說的方法。

§1.1.1 pynput.mouse.Listener

以下是官網的說明示例：

import pynput, time

def on_move(x, y):
    print('Pointer moved to {0}'.format((x, y)))

def on_click(x, y, button, pressed):
    print('{0} at {1}'.format(
        'Pressed' if pressed else 'Released',
        (x, y)))
    if not pressed:
        # Stop listener
        return False

def on_scroll(x, y, dx, dy):
    print('Scrolled {0} at {1}'.format(
        'down' if dy < 0 else 'up',
        (x, y)))

# Collect events until released
with pynput.mouse.Listener(
        on_move=on_move,
        on_click=on_click,
        on_scroll=on_scroll) as listener:
    listener.join()

運行這段程式碼時，移動滑鼠會顯示其坐標，
按下滑鼠按鍵並鬆開後，程式結束。

當三個函數任意一個返回False（（還有就是釋放Exception或繼承自Exception的異常）時，就會結束進程。
可以用listener.start()和listener.stop()代替with語句。

§1.1.2 pynput.mouse.Events

個人認為，這個方法比上一個更直觀。

import pynput

with pynput.mouse.Events() as event:

    for i in event:
    #迭代用法。
        if isinstance(i, pynput.mouse.Events.Move):
            #滑鼠移動事件。
            print(i.x, i.y)
            #不要直接列印`i`，模組這裡有問題，會報錯。

        elif isinstance(i, pynput.mouse.Events.Click):
            #滑鼠點擊事件。
            print(i.x, i.y, i.button, i.pressed)
            #這個i.button就是上文所說的「滑鼠按鍵」中的一個，用is語句判斷即可。

        elif isinstance(i, pynput.mouse.Events.Scroll):
            #滑鼠滾輪。
            print(i.x, i.y, i.dx, i.dy)


        break
    
    i = event.get(1)
    #另一種用法。
    #默認值是None。
    #這個`1`就是最長等待時間，超過這個時間沒有事件，
    #就會報錯。錯誤類型是queue模組的Empty，而非TimeoutError。

§1.2.0 控制滑鼠

§ 1.2.1
先執行pynput.mouse.Controller()獲取控制項。
以下方法都是該控制項的所屬方法。

如下：

import pynput

ctr = pynput.mouse.Controller()

§ 1.2.2

動態屬性position返回滑鼠位置坐標的元組（像這樣： (x, y) ），
通過定義來改變滑鼠位置，比如ctr.position = (500, 500)。

§ 1.2.3

當然，也有move方法，用於移動滑鼠，
用法是ctr.move(dx, dy)。

§ 1.2.4

使用方法click進行模擬點擊，需提供點擊的按鈕，
按鈕在pynput.mouse.Button里，有left、right和middle。
還有可選參數count，是點擊次數，默認為1。

示例：

import pynput

ctr = pynput.mouse.Controller()

ctr.click(pynput.mouse.Button.left)
#左鍵單擊。

ctr.click(pynput.mouse.Button.left, 2)
#左鍵雙擊。

ctr.click(pynput.mouse.Button.right)
#右鍵單擊。

§ 1.2.5

使用press(button)按下button鍵；
方法release(button)釋放鍵，如果按鍵並沒有按下，也不會報錯。

示例：

import pynput

ctr = pynput.mouse.Controller()

ctr.press(pynput.mouse.Button.left)
#按下左鍵。

ctr.move(50, 0)
#右移50單位。

ctr.move(0, 50)
#下移50單位。

ctr.release(pynput.mouse.Button.left)
#釋放左鍵。

§ 1.2.6

模擬滾輪，使用的方法是scroll，提供參數dx和dy。

例：

import pynput

ctr = pynput.mouse.Controller()

ctr.scroll(0, 50)
#向上滾動50單位。

ctr.scroll(0, -50)
#向下滾動50單位。

以上是滑鼠操作，
以下是鍵盤操作。

§ 2.0.0 鍵盤按鍵

鍵盤的按鍵獲取比滑鼠的麻煩些，但是沒有滑鼠用得多。
因此我先說給常用的使用方法，再說獲取。

§ 2.0.1 使用方法

首先，當獲取事件後，要判斷按鍵是「特殊按鍵」還是「普通按鍵」，
需判斷其是否具有name屬性，有則是特殊按鍵。
這個屬性記錄屬性的名稱，比如ctrl對應著'ctrl'、'ctrl_l'或是'ctrl_r'。
普通按鍵中，取而代之的是.char。

註：大寫字母與小寫字母有不同的按鍵。

還有其他功能。這裡就不多說了。

§ 2.0.2 獲取

首先，特殊按鍵在pynput.keyboard.Key「模組」中可以直接找到。
比如ctrl對應pynput.keyboard.Key.ctrl還有.ctrl_l以及.ctrl_r。

然後，普通按鍵可以通過pynput.keyboard.KeyCode.from_char取得（特殊按鍵不可以，使用時會出現ArgumentError）。
如a可以運行pynput.keyboard.KeyCode.from_char('a')獲得。

二者都可以用pynput.keyboard.KeyCode.from_vk通過按鍵的映射碼取得。

§ 2.1.0 監聽鍵盤

主要有兩種方法，類似於滑鼠的，我的講述順序同前文。
還有一種是對Listener的封裝，用於快捷鍵，我放在最後一個說。

§ 2.1.1 pynput.keyboard.Listener

官網示例：

from pynput import keyboard

def on_press(key):
    '按下按鍵時執行。'
    try:
        print('alphanumeric key {0} pressed'.format(
            key.char))
    except AttributeError:
        print('special key {0} pressed'.format(
            key))
    #通過屬性判斷按鍵類型。

def on_release(key):
    '鬆開按鍵時執行。'
    print('{0} released'.format(
        key))
    if key == keyboard.Key.esc:
        # Stop listener
        return False

# Collect events until released
with keyboard.Listener(
        on_press=on_press,
        on_release=on_release) as listener:
    listener.join()

當兩個函數中任意一個返回False（還有就是釋放Exception或繼承自Exception的異常）時，就會結束進程。
可以用listener.start()和listener.stop()代替with語句。

§ 2.1.2 pynput.keyboard.Events


import pynput

with pynput.keyboard.Events() as event:

    for i in event:
    #迭代用法。
        key_event = i
        break
    
    key_event = event.get()
    #get用法。
    #可以提供一個實數作為最長等待時間（單位秒），超過這個時間沒有事件，
    #就會報錯。錯誤類型是queue模組的Empty，而非TimeoutError。

#判斷事件情況：

if isinstance(key_event, pynput.keyboard.Events.Press):
    print('按下按鍵', end = '')
elif isinstance(key_event, pynput.keyboard.Events.Release):
    print('鬆開按鍵', end = '')

#判斷按鍵：

#*這個事件的`key`屬性*對應才是*Listener方法獲得的按鍵`'key'`*。

try:
    print(key_event.key.name)
except AttributeError:
    #說明這個是普通按鍵。
    print(key_event.key.char)
else:
    #兩種判斷方式，第一種是我自創的，第二種是官網上的。
    if (key_event.key.name).startswith('ctrl'):
        #通過名稱判斷。
        print('發生了ctrl鍵事件。')
    elif key_event.key is pynput.keyboard.Key.esc:
        print('發生了esc鍵事件。')

§ 2.1.3 pynput.keyboard.GlobalHotKeys

（還有’pynput.keyboard.HotKey’可以實現相似功能，但很麻煩）

官網示例，esc那個是我寫的。

from pynput import keyboard

def on_activate_h():
    print('<ctrl>+<alt>+h pressed')

def on_activate_i():
    print('<ctrl>+<alt>+i pressed')

def esc():
    print('<esc> pressed')
    return False

def esc_shift():
    print('<esc>+<shift> pressed')
    raise Exception

with keyboard.GlobalHotKeys({
        '<ctrl>+<alt>+h': on_activate_h,
        '<ctrl>+<alt>+i': on_activate_i,
        '<esc>':          esc,
        '<esc>+<shift>':  esc_shift}) as h:
    h.join()

當按下esc鍵時，函數被觸發，但運行未停止。
觀察源碼，發現雖然該類繼承自Listener，但會對執行的函數有封裝，封裝後只返回None。
所以無法通過return False結束進程。

§ 2.2.0 控制鍵盤

§ 2.2.1

先獲取控制項：ctr = pynput.keyboard.Controller()。
以下所說的方法均是指該控制項的方法。

§ 2.2.2

通過方法press來按下按鍵，
你需要提供一個「長度為1的字元」或是「前文所說的按鍵對象」。

溫馨提示，此方法測試有風險，如果發現電腦打字、操作異常，
很可能是因為模擬按下了某個鍵未鬆開。
可以重啟控制台或電腦。

§ 2.2.3

通過release釋放按鍵，
和press方法一樣，需要提供一個「長度為1的字元」或是「前文所說的按鍵對象」。

示例：

'''
這段程式會按「下ctrl+shilf+s」快捷鍵，停頓3秒後按下esc鍵。
簡單模擬了「另存為」操作。
'''

import pynput, time

ctr = pynput.keyboard.Controller()

ctr.press(pynput.keyboard.KeyCode.from_vk(17))
#通過按鍵的映射碼 按下ctrl鍵。

ctr.press(pynput.keyboard.Key.shift)
#通過按鍵對象 按下shift鍵。

ctr.press('s')
#通過長度為1的字元 按下s鍵。


#掃尾，釋放剛才按下的鍵。後面我會說更簡單、優雅的辦法。
ctr.release(pynput.keyboard.Key.ctrl)
ctr.release(pynput.keyboard.Key.shift)
ctr.release('s')

time.sleep(0.3)

ctr.press(pynput.keyboard.Key.esc)
ctr.release(pynput.keyboard.Key.esc)

§ 2.2.4

pressed方法就是我說的「更簡單、優雅」的方法。
使用時提供要按下的鍵，再用with語句「封裝」上。
效果是進入語句塊時順序按下提供按鍵，退出語句塊時逆序釋放按鍵。

如下：

import pynput, time

ctr = pynput.keyboard.Controller()

with ctr.pressed(
        pynput.keyboard.Key.ctrl,
        pynput.keyboard.Key.shift,
        's'):
    pass

time.sleep(0.3)

with ctr.pressed(pynput.keyboard.Key.esc):
    pass

§ 2.2.5

type在英語中除了「類型」還有「打字」之意。
該方法接收字元串，然後打出每個字元。
據測試，向它提供一個「按鍵列表」也可以正常使用。

例：

import pynput

ctr = pynput.keyboard.Controller()

ctr.type('Hello world!')

ctr.type([pynput.keyboard.Key.esc])
#按下esc再鬆開。

以上是正文。

一些建議

該模組滑鼠、鍵盤的監聽操作均由多執行緒實現。
所以，可以利用多執行緒共享記憶體的特徵編程；二要注意不要頻繁啟動監聽，這樣對系統開支極大。

還有就是對滑鼠位置監聽要求不是很高時（比如實時向用戶顯示滑鼠位置），可以每次循環sleep一下。

閑談

之前和別人聊天，他說他在不需要時把電腦的麥拔下來、攝影機擋上。
我說用Fn快捷鍵禁掉麥克風更方便。
現在想想，黑客可以通過模擬按鍵解禁麥克風啊。
雖然這個模組沒有Fn鍵，但別的呢？

最後

這份算是最全的了。原創不易，純手打。

轉載請註明作者和鏈接哦。

感謝閱讀！

Tags: python模組介紹

python監聽、操作鍵盤滑鼠庫pynput詳細教程

§ 0.0.0 前言

§1.0.0 滑鼠按鍵

§1.1.0 監聽滑鼠

§1.1.1 pynput.mouse.Listener

§1.1.2 pynput.mouse.Events

§1.2.0 控制滑鼠

§ 2.0.0 鍵盤按鍵

§ 2.0.1 使用方法

§ 2.0.2 獲取

§ 2.1.0 監聽鍵盤

§ 2.1.1 pynput.keyboard.Listener

§ 2.1.2 pynput.keyboard.Events

§ 2.1.3 pynput.keyboard.GlobalHotKeys

§ 2.2.0 控制鍵盤

一些建議

閑談

最後

VirMach 便宜 VPS

QNews

python監聽、操作鍵盤滑鼠庫pynput詳細教程

§ 0.0.0 前言

§1.0.0 滑鼠按鍵

§1.1.0 監聽滑鼠

§1.1.1 pynput.mouse.Listener

§1.1.2 pynput.mouse.Events

§1.2.0 控制滑鼠

§ 2.0.0 鍵盤按鍵

§ 2.0.1 使用方法

§ 2.0.2 獲取

§ 2.1.0 監聽鍵盤

§ 2.1.1 pynput.keyboard.Listener

§ 2.1.2 pynput.keyboard.Events

§ 2.1.3 pynput.keyboard.GlobalHotKeys

§ 2.2.0 控制鍵盤

一些建議

閑談

最後

分享此文：

Related Posts

Java JDK環境變數如何配置？Java基礎！

未經投影的地理坐標系如何顯示為平面地圖

Flutter RenderBox指南——繪製篇

華為麒麟710要滿血了？中芯國際12nm製程已試產：性能提升10%

VirMach 便宜 VPS

QNews

熱門搜尋