[Python] keyboardモジュールの使い方 – キー操作を受け付ける

keyboardモジュールは、Pythonでキーボード操作を簡単に扱うためのライブラリです。

キー入力の検知や自動入力、ホットキーの設定などが可能です。

キー操作を受け付けるには、keyboard.is_pressed('キー')で特定のキーが押されているか確認したり、keyboard.add_hotkey('キー',関数)でホットキーに機能を割り当てたりします。

また、keyboard.read_event()でキーイベントを取得し、keyboard.wait('キー')で特定のキーが押されるまで待機することもできます。

keyboardモジュールとは

keyboardモジュールは、Pythonでキーボードの操作を簡単に扱うためのライブラリです。

このモジュールを使用することで、キーの押下やリリースを検知したり、特定のキーに対してホットキーを設定したりすることができます。

特に、ユーザーインターフェースの自動化や、ゲームのマクロ機能の実装などに役立ちます。

主な機能

• キーの押下やリリースの検知
• ホットキーの設定
• 自動入力の実現
• キーの状態の取得

インストール方法

keyboardモジュールは、Pythonのパッケージ管理ツールであるpipを使用して簡単にインストールできます。

以下のコマンドを実行してください。

pip install keyboard

このモジュールは、Windows、macOS、Linuxの各プラットフォームで動作しますが、特にWindows環境での使用が推奨されています。

基本的な使い方

keyboardモジュールを使うことで、キーボードの操作を簡単に扱うことができます。

ここでは、基本的な機能をいくつか紹介します。

キーの押下を検知する

特定のキーが押されたときに何かを実行するには、keyboard.is_pressed()関数を使用します。

以下のサンプルコードでは、'a'キーが押されたときにメッセージを表示します。

import keyboard
while True:
    if keyboard.is_pressed('a'):  # 'a'キーが押されたら
        print(' `a` キーが押されました！')
        break  # ループを終了

`a` キーが押されました！

キーのリリースを検知する

キーがリリースされたときに何かを実行するには、keyboard.on_release()関数を使用します。

以下のサンプルコードでは、'b'キーがリリースされたときにメッセージを表示します。

import keyboard
def on_release(key):
    if key.name == 'b':  # 'b'キーがリリースされたら
        print(' `b` キーがリリースされました！')
        return False  # イベントを停止
keyboard.on_release(on_release)  # リリースイベントを監視
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

`b` キーがリリースされました！

キーの状態を取得する

特定のキーが現在押されているかどうかを確認するには、keyboard.is_pressed()を使用します。

以下のサンプルコードでは、'c'キーの状態を確認し、押されている場合はメッセージを表示します。

import keyboard
import time
while True:
    if keyboard.is_pressed('c'):  # 'c'キーが押されているか確認
        print(' `c` キーが押されています！')
    time.sleep(0.1)  # 0.1秒待機

`c` キーが押されています！

これらの基本的な使い方を理解することで、keyboardモジュールを使ったキーボード操作の自動化やイベント処理が可能になります。

ホットキーの設定

keyboardモジュールを使用すると、特定のキーの組み合わせ(ホットキー)を設定し、そのホットキーが押されたときに特定のアクションを実行することができます。

これにより、効率的な操作が可能になります。

以下に、ホットキーの設定方法を説明します。

ホットキーの基本的な設定

keyboard.add_hotkey()関数を使用して、ホットキーを設定します。

以下のサンプルコードでは、'ctrl + h'が押されたときにメッセージを表示します。

import keyboard
def show_message():
    print('ホットキーが押されました！')
# 'ctrl + h'をホットキーとして設定
keyboard.add_hotkey('ctrl + h', show_message)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

ホットキーが押されました！

複数のホットキーを設定する

複数のホットキーを設定することも可能です。

以下のサンプルコードでは、'ctrl + a'と'ctrl + b'の2つのホットキーを設定しています。

import keyboard
def action_a():
    print(' `ctrl + a` が押されました！')
def action_b():
    print(' `ctrl + b` が押されました！')
# ホットキーの設定
keyboard.add_hotkey('ctrl + a', action_a)
keyboard.add_hotkey('ctrl + b', action_b)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

`ctrl + a` が押されました！
`ctrl + b` が押されました！

ホットキーの解除

設定したホットキーを解除するには、keyboard.remove_hotkey()関数を使用します。

以下のサンプルコードでは、'ctrl + h'のホットキーを解除します。

import keyboard
def show_message():
    print('ホットキーが押されました！')
# 'ctrl + h'をホットキーとして設定
keyboard.add_hotkey('ctrl + h', show_message)
# ホットキーを解除する
keyboard.remove_hotkey('ctrl + h')
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

(何も出力されない)

ホットキーを設定することで、特定の操作を迅速に実行できるようになります。

これにより、作業の効率が大幅に向上します。

キー操作の待機

keyboardモジュールでは、特定のキー操作を待機する機能が提供されています。

これにより、ユーザーが特定のキーを押すのを待ってから次の処理を実行することができます。

以下に、キー操作の待機方法をいくつか紹介します。

特定のキーが押されるまで待機する

keyboard.wait()関数を使用すると、指定したキーが押されるまでプログラムを待機させることができます。

以下のサンプルコードでは、'space'キーが押されるまで待機し、その後メッセージを表示します。

import keyboard
print(' `space` キーを押してください...')
keyboard.wait('space')  # 'space'キーが押されるまで待機
print(' `space` キーが押されました！')

`space` キーを押してください...
`space` キーが押されました！

複数のキーを待機する

複数のキーを待機する場合は、keyboard.wait()にリストを渡すことができます。

以下のサンプルコードでは、'a'または'b'キーが押されるまで待機します。

import keyboard
print(' `a` または `b` キーを押してください...')
keyboard.wait(['a', 'b'])  # 'a'または'b'キーが押されるまで待機
print(' `a` または `b` キーが押されました！')

`a` または `b` キーを押してください...
`a` または `b` キーが押されました！

キー操作を非同期で待機する

keyboardモジュールでは、非同期的にキー操作を待機することも可能です。

keyboard.on_press()関数を使用して、特定のキーが押されたときにコールバック関数を実行することができます。

以下のサンプルコードでは、'esc'キーが押されたときにプログラムを終了します。

import keyboard
def on_key_press(key):
    print(f' `{key.name}` キーが押されました！')
    if key.name == 'esc':  # 'esc'キーが押されたらプログラムを終了
        return False
# キーが押されたときのイベントを監視
keyboard.on_press(on_key_press)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

`esc` キーが押されました！

キー操作の待機機能を活用することで、ユーザーの入力に応じた柔軟なプログラムを作成することができます。

これにより、インタラクティブなアプリケーションや自動化ツールの開発が容易になります。

自動入力の実現

keyboardモジュールを使用すると、特定のキーを自動的に入力することができます。

これにより、テキストフィールドへの自動入力や、特定のキー操作を自動化することが可能になります。

以下に、自動入力の実現方法をいくつか紹介します。

テキストの自動入力

keyboard.write()関数を使用すると、指定したテキストを自動的に入力することができます。

以下のサンプルコードでは、'Hello, World!'というテキストを自動的に入力します。

import keyboard
import time
# 少し待機してから自動入力を開始
time.sleep(3)  # 3秒待機
keyboard.write('Hello, World!')  # テキストを自動入力

(3秒後に `Hello, World!` が入力される)

特定のキーを自動的に押す

特定のキーを自動的に押すには、keyboard.press()およびkeyboard.release()関数を使用します。

以下のサンプルコードでは、'enter'キーを自動的に押してリリースします。

import keyboard
import time
# 少し待機してから自動操作を開始
time.sleep(3)  # 3秒待機
keyboard.press('enter')  # 'enter'キーを押す
keyboard.release('enter')  # 'enter'キーをリリース

(3秒後に `enter` キーが押される)

複数のキーを自動的に押す

複数のキーを同時に押す場合は、keyboard.press()を使用してキーを押し、keyboard.release()でリリースします。

以下のサンプルコードでは、'ctrl'と'c'を同時に押してコピー操作を実行します。

import keyboard
import time
# 少し待機してから自動操作を開始
time.sleep(3)  # 3秒待機
keyboard.press('ctrl')  # 'ctrl'キーを押す
keyboard.press('c')  # 'c'キーを押す
keyboard.release('c')  # 'c'キーをリリース
keyboard.release('ctrl')  # 'ctrl'キーをリリース

(3秒後に `ctrl + c` が押される)

自動入力の応用例

自動入力機能は、テスト自動化やデータ入力の効率化に役立ちます。

例えば、特定のアプリケーションに対して定型文を自動的に入力するスクリプトを作成することができます。

これにより、手動での入力作業を大幅に削減できます。

自動入力機能を活用することで、作業の効率化や自動化が実現でき、時間を節約することが可能になります。

応用的な使い方

keyboardモジュールは、基本的なキー操作だけでなく、さまざまな応用的な使い方が可能です。

ここでは、いくつかの応用例を紹介します。

マクロ機能の実装

マクロ機能を実装することで、複数のキー操作を一度に実行することができます。

以下のサンプルコードでは、'ctrl + m'をホットキーとして設定し、特定のテキストを自動的に入力するマクロを作成します。

import keyboard
def macro():
    keyboard.write('これはマクロによる自動入力です。')
    keyboard.press('enter')  # 自動的に `enter` キーを押す
    keyboard.release('enter')
# 'ctrl + m'をホットキーとして設定
keyboard.add_hotkey('ctrl + m', macro)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + m` を押すと「これはマクロによる自動入力です。」が入力される)

キーの状態を監視する

特定のキーの状態を監視し、押されたときにアクションを実行することができます。

以下のサンプルコードでは、'f'キーが押されたときにメッセージを表示します。

import keyboard
def on_key_press(key):
    if key.name == 'f':
        print(' `f` キーが押されました！')
# キーが押されたときのイベントを監視
keyboard.on_press(on_key_press)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

`f` キーが押されました！

特定のアプリケーションでの操作

特定のアプリケーションでの操作を自動化することも可能です。

以下のサンプルコードでは、特定のウィンドウがアクティブなときに自動入力を行います。

import keyboard
import time
import pygetwindow as gw
# 特定のウィンドウ名
window_name = 'メモ帳'  # メモ帳のウィンドウ名を指定
# ウィンドウがアクティブになるまで待機
while True:
    if window_name in [w.title for w in gw.getWindowsWithTitle(window_name)]:
        break
    time.sleep(1)  # 1秒待機
# ウィンドウがアクティブになったら自動入力
keyboard.write('ウィンドウがアクティブになりました！')

(指定したウィンドウがアクティブになると「ウィンドウがアクティブになりました！」が入力される)

キー操作の記録と再生

keyboardモジュールを使用して、キー操作を記録し、後で再生することも可能です。

以下のサンプルコードでは、キー操作を記録し、'ctrl + r'で再生します。

import keyboard
recorded_keys = []
def record_key(key):
    recorded_keys.append(key.name)
# キーが押されたときのイベントを監視
keyboard.on_press(record_key)
def replay_keys():
    for key in recorded_keys:
        keyboard.press(key)  # キーを押す
        keyboard.release(key)  # キーをリリース
# 'ctrl + r'をホットキーとして設定
keyboard.add_hotkey('ctrl + r', replay_keys)
# プログラムが終了するまで待機
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + r` を押すと記録されたキー操作が再生される)

これらの応用的な使い方を活用することで、keyboardモジュールを使った高度な自動化やインタラクティブなアプリケーションの開発が可能になります。

注意点と制限

keyboardモジュールを使用する際には、いくつかの注意点や制限があります。

これらを理解しておくことで、より安全かつ効果的にモジュールを活用することができます。

管理者権限の必要性

keyboardモジュールは、キーボードの低レベルの操作を行うため、特にWindows環境では管理者権限が必要です。

プログラムを実行する際には、必ず管理者として実行するようにしてください。

一部のOSでの制限

keyboardモジュールは、Windows、macOS、Linuxで動作しますが、特にWindowsでの動作が最も安定しています。

macOSやLinuxでは、一部の機能が制限される場合があります。

特に、特定のキーのフックやホットキーの設定がうまく機能しないことがあります。

セキュリティリスク

キーボードの操作を監視したり、自動入力を行ったりするため、悪意のあるプログラムに利用される可能性があります。

信頼できる環境でのみ使用し、他人のコンピュータやプライバシーに影響を与えないように注意してください。

他のアプリケーションとの競合

keyboardモジュールを使用している間、他のアプリケーションが同時にキーボードの入力を受け付けることができない場合があります。

特に、ゲームや特定のソフトウェアでは、キーボードのフックが競合することがあります。

このため、特定のアプリケーションでの使用時には注意が必要です。

キーの押下速度の制限

自動入力やキー操作の再生を行う際、キーの押下速度が速すぎると、アプリケーションが正しく反応しないことがあります。

time.sleep()を使用して、キー操作の間に適切な待機時間を設けることが推奨されます。

プラットフォーム依存性

keyboardモジュールは、プラットフォームに依存するため、異なるOS間での互換性に注意が必要です。

特に、特定のキーやホットキーの動作が異なる場合があるため、プログラムを移植する際には十分なテストが必要です。

これらの注意点と制限を理解し、適切にkeyboardモジュールを使用することで、より安全で効果的なプログラムを作成することができます。

keyboardモジュールの活用例

keyboardモジュールは、さまざまなシナリオで活用することができます。

以下に、具体的な活用例をいくつか紹介します。

自動化ツールの作成

日常的な作業を自動化するツールを作成することができます。

例えば、特定のアプリケーションで定型文を自動的に入力するツールを作成することができます。

以下のサンプルコードでは、'ctrl + a'を押すと、定型文が自動的に入力されます。

import keyboard
def auto_input():
    keyboard.write('お疲れ様です。こちらが定型文です。')
    keyboard.press('enter')
    keyboard.release('enter')
keyboard.add_hotkey('ctrl + a', auto_input)
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + a` を押すと定型文が入力される)

ゲームのマクロ機能

ゲーム内での特定の操作を自動化するためのマクロ機能を実装することができます。

例えば、特定のキーの組み合わせを押すことで、複数のアクションを一度に実行することができます。

以下のサンプルコードでは、'ctrl + g'を押すと、特定のキー操作が自動的に実行されます。

import keyboard
def game_macro():
    keyboard.press('w')  # 前進
    keyboard.press('space')  # ジャンプ
    keyboard.release('space')
    keyboard.release('w')
keyboard.add_hotkey('ctrl + g', game_macro)
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + g` を押すと前進しジャンプする)

キーボードショートカットのカスタマイズ

特定のアプリケーションでのキーボードショートカットをカスタマイズすることができます。

例えば、特定のキーを押すことで、特定の機能を呼び出すことができます。

以下のサンプルコードでは、'ctrl + s'を押すと、ファイルを保存する機能を実行します。

import keyboard
def save_file():
    print('ファイルを保存しました。')
keyboard.add_hotkey('ctrl + s', save_file)
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + s` を押すと「ファイルを保存しました。」と表示される)

キー操作の記録と再生

ユーザーのキー操作を記録し、後で再生するツールを作成することができます。

以下のサンプルコードでは、キー操作を記録し、'ctrl + r'を押すことで再生します。

import keyboard
recorded_keys = []
def record_key(key):
    recorded_keys.append(key.name)
keyboard.on_press(record_key)
def replay_keys():
    for key in recorded_keys:
        keyboard.press(key)
        keyboard.release(key)
keyboard.add_hotkey('ctrl + r', replay_keys)
keyboard.wait('esc')  # 'esc'キーが押されるまで待機

( `ctrl + r` を押すと記録されたキー操作が再生される)

ユーザーインターフェースの自動化

特定のユーザーインターフェースを自動化するために、keyboardモジュールを使用することができます。

例えば、特定のアプリケーションのボタンを自動的にクリックするために、キーボード操作を利用することができます。

これらの活用例を参考にすることで、keyboardモジュールを使ったさまざまな自動化や効率化のアイデアを実現することができます。

まとめ

この記事では、Pythonのkeyboardモジュールを使ったキーボード操作の基本から応用までを紹介しました。

特に、ホットキーの設定や自動入力、キー操作の待機など、実際のプログラムで役立つ機能に焦点を当てています。

これを機に、日常の作業を自動化したり、特定のアプリケーションでの操作を効率化したりするために、keyboardモジュールを活用してみてはいかがでしょうか。