HOWTO · Python
Python でキーボード入力をシミュレートする
Python でキーボード入力をシミュレートする方法を学びます。
このページの内容
Python スクリプトからテキストを入力するには、keyboard パッケージまたは PyAutoGUI を使います。前者では、テキスト入力に write()、キーイベントの送信に press_and_release() を使います。PyAutoGUI では、テキスト入力と個々のキーイベントに write()、keyDown()、keyUp()、press() を使います。選んだライブラリを pip install keyboard または pip install pyautogui でインストールしてください。
どちらのライブラリも、現在フォーカスされているフィールドに入力を送ります。どちらの例も、アプリケーションやフィールドを選択するものではありません。先に入力先を準備し、意図しないウィンドウに機密情報を入力しないようにしてください。シミュレートしたテキストは入力先のアプリケーションに表示され、ターミナルには出力されません。次の標準ライブラリの例は、後述する操作の手順を表示するものであり、keyboard のイベントを送信するものではありません。
テキスト文字列とキーイベントは、種類の異なる入力として扱います。通常の単語や句読点にはテキスト入力の呼び出しを使い、Enter などの名前付きキーや修飾キーとの組み合わせを入力先に送る場合はキーイベントの呼び出しを使います。スクリプトを始める前に入力先を準備し、手順を調整するときは無害なテスト用フィールドを使ってください。サンプルの手順では、まずテキストを入力し、次に Enter、修飾キーを使ったキーイベント、最後に残りの文字を入力する順序が分かります。使用するフォームやエディターに合わせて、操作の順序を変えたり不要な操作を削除したりしてください。
次の例を実行します。
このセクションのコードと表示されるラベルや出力は英語のままです。
text = "Python is an amazing programming language."
actions = [("type", text), ("press", "enter"), ("press", "shift+p"), ("type", "ython")]
for action, value in actions:
print(f"{action}: {value}")
type: Python is an amazing programming language.
press: enter
press: shift+p
type: ython
keyboard ライブラリでキーボード入力をシミュレートする
パッケージを pip install keyboard でインストールします。文を入力して Enter を押し、その後、最初の文字を Shift キーを押した状態で入力して Python とするには、パッケージ固有の次の呼び出しを順番に実行します。keyboard.write("Python is an amazing programming language.")、keyboard.press_and_release("enter")、keyboard.press_and_release("shift+p")、keyboard.write("ython") です。これらの呼び出しには、インストール済みのパッケージと、フォーカスされた対話型テキストフィールドが必要です。そのため、ここでは実行済みの例ではなく、APIの使い方として示しています。実行前にキャレットの位置を決めてください。入力先には文が入力され、Enter による改行の後、次の行に Python が入力されます。write() は入力するテキストを受け取り、press_and_release() は名前付きキーまたはキーの組み合わせを押してから離します。ここでは shift+p によって Python の先頭を大文字にします。これらの呼び出しはウィンドウを選択したりキャレットを移動したりしません。Enter を押すとフォームが送信されたりコントロールが動作したりすることがあるため、入力先に Enter を送る必要がない場合は、その呼び出しを省いてください。テキスト入力だけでよければ、write() の呼び出しだけで十分です。APIの詳細は keyboard のドキュメントを参照してください。
PyAutoGUI でキーボード入力をシミュレートする
pip install pyautogui で PyAutoGUI をインストールします。文を入力した後、Shift を押しながら a、b、c を押し、続けて小文字の xyz を入力するには、パッケージ固有の次の呼び出しを順に実行します。pyautogui.write("Python is an amazing programming language.")、pyautogui.keyDown("shift")、pyautogui.press("a")、pyautogui.press("b")、pyautogui.press("c")、pyautogui.keyUp("shift")、pyautogui.write("xyz") です。これらの呼び出しには、インストール済みのパッケージと対話型のテキスト入力先が必要です。そのため、ここでは実行済みの例ではなく、APIの使い方として示しています。実行前にテキストフィールドへ確実にフォーカスしてください。入力先には Python is an amazing programming language.ABCxyz が入力されます。keyDown("shift") は3回の個別の press() 呼び出しの間 Shift を押した状態にするため、文字は大文字になります。keyUp("shift") で Shift を離してから xyz を入力します。write() は指定した文字列を入力します。keyDown() はキーを押した状態にし、keyUp() がそのキーを離します。press() は、1文字など個別のキーを押してから離すイベントを送ります。修飾キーを複数のキー入力にわたって押したままにするには、press() を任意のキー組み合わせ用の関数として扱うのではなく、対象の呼び出しを keyDown() と keyUp() で囲みます。テキスト入力だけなら write() で十分です。修飾キーの動作が必要な場合に、キーイベントの手順を使ってください。詳しくは PyAutoGUI のドキュメントを参照してください。
手順を変更するときは、修飾キーが必要なキー入力だけを keyDown() と keyUp() で囲んでください。keyUp() の後の呼び出しでは、その修飾キーは押されていません。単純な文を入力するだけなら、キーイベントの呼び出しをすべて省きます。こうすると、スクリプトをテキスト入力に絞ることができ、予期しない文字が入力されたときに原因となった操作を特定しやすくなります。