✔️ 本記事の内容
本記事では、PythonライブラリのPyAutoGUIによるキーボード操作ついて解説しています。
対象は、Pythonでキーボード操作したい方、単純な作業を自動化したい方などです。
参考プログラムを載せてありますので、自分で実際に動かしてみましょう。
PyAutoGUIとは
PyAutoGUIは、Pythonのライブラリで、GUI（グラフィカルユーザーインターフェース）の操作を自動化できます。
例としては、マウス操作やキーボード操作などがあり、カーソルを移動させたり、クリックしたり、文字を入力したりと様々なことが出来ます。
ちなみにですが、筆者はこの機能を使用し、会社の勤怠入力など単純でつまらない作業を自動化し、有意義な時間を過ごしております。
PyAutoGUIについて大まかに知りたい方は以下の記事を参照ください。
文字列入力：write()
主要なキーボード関数は write() である。この関数は、渡された文字列の文字を入力する。各キー入力に停止時間を追加するには、interval キーワード引数に int または float を渡します。
pyautogui.write('Hello world!') # prints out "Hello world!" instantly
pyautogui.write('Hello world!', interval=0.25) # prints out "Hello world!" with a quarter second delay after each char
※write()で押せるのは1文字キーだけなので、ShiftキーやF1キーなどは次項を参照してください。
キー入力：press()、keyDown()、keyUp()
これらのキーを押すには、press()関数を呼び出し、enter、esc、f1などのpyautogui.KEYBOARD_KEYSから文字列を渡します。
pyautogui.press('enter') # press the Enter key
pyautogui.press('f1') # press the F1 key
pyautogui.press('left') # press the left arrow key
press()関数は、実際にはkeyDown()関数とkeyUp()関数に置き換えることが出来ます。また、これらの関数は単独で呼び出すこともできます。例えば、Shiftキーを押しながら左矢印キーを3回押すには、次のようになります。
pyautogui.keyDown('shift') # hold down the shift key
pyautogui.press('left') # press the left arrow key
pyautogui.press('left') # press the left arrow key
pyautogui.press('left') # press the left arrow key
pyautogui.keyUp('shift') # release the shift key
文字列のリストを引数に渡すことで、write() と同じように複数キーを押すことが出来ます。
pyautogui.press(['left', 'left', 'left']) # press the left arrow key three times
押す回数を設定することもできます
pyautogui.press('left', presses=3)
interval キーワード引数に int または float を渡すことで、各入力の間に停止時間を追加できます。
pyautogui.press('left', presses=3, interval=0.5)
hold()コンテキストマネージャ
hold()にshift、ctrl、altのような文字列を渡すと、コンテキストブロックの間保持することが出来ます。
with pyautogui.hold('shift'):
pyautogui.press(['left', 'left', 'left'])
以下のコードと同様です。
pyautogui.keyDown('shift') # hold down the shift key
pyautogui.press('left') # press the left arrow key
pyautogui.press('left') # press the left arrow key
pyautogui.press('left') # press the left arrow key
pyautogui.keyUp('shift') # release the shift key
ショートカットキー：hotkey()
hotkey()に複数のキー文字列を渡すことで、ショートカットキーを使うことができます。
一見、press()との違いが分かりにくいが、hotkey()は同時押しという点で異なります。
pyautogui.hotkey('ctrl', 'shift', 'esc')
つまりは、以下のコードと同様です。
pyautogui.keyDown('ctrl')
pyautogui.keyDown('shift')
pyautogui.keyDown('esc')
pyautogui.keyUp('esc')
pyautogui.keyUp('shift')
pyautogui.keyUp('ctrl')
interval キーワード引数に int または float を渡すことで、各入力の間に停止時間を追加できます。
使用可能なキー文字列
pyautogui.KEYBOARD_KEYSを実行した結果を以下に表示します。
これがpress()、keyDown()、keyUp()、hotkey()関数に渡す有効なキーです。
['\t', '\n', '\r', ' ', '!', '"', '#', '$', '%', '&', "'", '(',
')', '*', '+', ',', '-', '.', '/', '0', '1', '2', '3', '4', '5', '6', '7',
'8', '9', ':', ';', '<', '=', '>', '?', '@', '[', '\\', ']', '^', '_', '`',
'a', 'b', 'c', 'd', 'e','f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o',
'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '{', '|', '}', '~',
'accept', 'add', 'alt', 'altleft', 'altright', 'apps', 'backspace',
'browserback', 'browserfavorites', 'browserforward', 'browserhome',
'browserrefresh', 'browsersearch', 'browserstop', 'capslock', 'clear',
'convert', 'ctrl', 'ctrlleft', 'ctrlright', 'decimal', 'del', 'delete',
'divide', 'down', 'end', 'enter', 'esc', 'escape', 'execute', 'f1', 'f10',
'f11', 'f12', 'f13', 'f14', 'f15', 'f16', 'f17', 'f18', 'f19', 'f2', 'f20',
'f21', 'f22', 'f23', 'f24', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9',
'final', 'fn', 'hanguel', 'hangul', 'hanja', 'help', 'home', 'insert', 'junja',
'kana', 'kanji', 'launchapp1', 'launchapp2', 'launchmail',
'launchmediaselect', 'left', 'modechange', 'multiply', 'nexttrack',
'nonconvert', 'num0', 'num1', 'num2', 'num3', 'num4', 'num5', 'num6',
'num7', 'num8', 'num9', 'numlock', 'pagedown', 'pageup', 'pause', 'pgdn',
'pgup', 'playpause', 'prevtrack', 'print', 'printscreen', 'prntscrn',
'prtsc', 'prtscr', 'return', 'right', 'scrolllock', 'select', 'separator',
'shift', 'shiftleft', 'shiftright', 'sleep', 'space', 'stop', 'subtract', 'tab',
'up', 'volumedown', 'volumemute', 'volumeup', 'win', 'winleft', 'winright', 'yen',
'command', 'option', 'optionleft', 'optionright']
