How can you detect keyboard input in Python scripts running from the terminal?

Implementing Keyboard Input Detection in Python Scripts from the Terminal

To detect keyboard input from the terminal while your Python script is running, you have several options, each with its advantages and limitations:

Synchronous/Blocking Key Capture

• Simple input() or raw_input(): Python functions that halt script execution until the user presses Enter, providing the typed text.

<code class="python">typedString = raw_input()</code>

• Simple blocking keypress capture:

<code class="python">import msvcrt
k=msvcrt.getch()</code>

Asynchronous Key Capture

• Callback when key is pressed:

<code class="python">import win32api, time
from win32api import STD_INPUT_HANDLE
from win32console import GetStdHandle, KEY_EVENT, ENABLE_LINE_INPUT, ENABLE_ECHO_INPUT, ENABLE_PROCESSED_INPUT

from keyPress import KeyPress

class CaptureLines():
    def __init__(self):
        self.isCapturingInputLines = False

        self.inputLinesHookCallback = CFUNCTYPE(c_int)(self.inputLinesHook)
        self.pyosInputHookPointer = c_void_p.in_dll(pythonapi, "PyOS_InputHook")
        self.originalPyOsInputHookPointerValue = self.pyosInputHookPointer.value

        self.readHandle = GetStdHandle(STD_INPUT_HANDLE)
        self.readHandle.SetConsoleMode(ENABLE_LINE_INPUT|ENABLE_ECHO_INPUT|ENABLE_PROCESSED_INPUT)


    def inputLinesHook(self):
        self.readHandle.SetConsoleMode(ENABLE_LINE_INPUT|ENABLE_ECHO_INPUT|ENABLE_PROCESSED_INPUT)
        inputChars = self.readHandle.ReadConsole(10000000)
        self.readHandle.SetConsoleMode(ENABLE_LINE_INPUT|ENABLE_PROCESSED_INPUT)

        if inputChars == "\r\n":
            KeyPress("\n")
            return 0

        inputChars = inputChars[:-2]

        inputChars += "\n"

        for c in inputChars:
            KeyPress(c)

        self.inputCallback(inputChars)

        return 0</code>

Polling

• Simple key capture without blocking:

<code class="python">import win32api, time
from win32api import STD_INPUT_HANDLE
from win32console import GetStdHandle, KEY_EVENT, ENABLE_LINE_INPUT, ENABLE_PROCESSED_INPUT

class KeyAsyncReader():
    def __init__(self):
        self.readHandle = GetStdHandle(STD_INPUT_HANDLE)
        self.readHandle.SetConsoleMode(ENABLE_LINE_INPUT|ENABLE_ECHO_INPUT|ENABLE_PROCESSED_INPUT)

    def poll(self):
        return self.readHandle.ReadConsoleInput()</code>

Robots

• Programmatic firing of keyboard events:

<code class="python">import ctypes
from ctypes import wintypes
import time

user32 = ctypes.WinDLL('user32', use_last_error=True)

INPUT_MOUSE    = 0
INPUT_KEYBOARD = 1
INPUT_HARDWARE = 2

KEYEVENTF_EXTENDEDKEY = 0x0001
KEYEVENTF_KEYUP       = 0x0002
KEYEVENTF_UNICODE     = 0x0004
KEYEVENTF_SCANCODE    = 0x0008

MAPVK_VK_TO_VSC = 0

# C struct definitions
wintypes.ULONG_PTR = wintypes.WPARAM

SendInput = ctypes.windll.user32.SendInput

PUL = ctypes.POINTER(ctypes.c_ulong)

class KEYBDINPUT(ctypes.Structure):
    _fields_ = ((&quot;wVk&quot;,         wintypes.WORD),
                (&quot;wScan&quot;,       wintypes.WORD),
                (&quot;dwFlags&quot;,     wintypes.DWORD),
                (&quot;time&quot;,        wintypes.DWORD),
                (&quot;dwExtraInfo&quot;, wintypes.ULONG_PTR))

class MOUSEINPUT(ctypes.Structure):
    _fields_ = ((&quot;dx&quot;,          wintypes.LONG),
                (&quot;dy&quot;,          wintypes.LONG),
                (&quot;mouseData&quot;,   wintypes.DWORD),
                (&quot;dwFlags&quot;,     wintypes.DWORD),
                (&quot;time&quot;,        wintypes.DWORD),
                (&quot;dwExtraInfo&quot;, wintypes.ULONG_PTR))

class HARDWAREINPUT(ctypes.Structure):
    _fields_ = ((&quot;uMsg&quot;,    wintypes.DWORD),
                (&quot;wParamL&quot;, wintypes.WORD),
                (&quot;wParamH&quot;, wintypes.WORD))

class INPUT(ctypes.Structure):
    class _INPUT(ctypes.Union):
        _fields_ = ((&quot;ki&quot;, KEYBDINPUT),
                    (&quot;mi&quot;, MOUSEINPUT),
                    (&quot;hi&quot;, HARDWAREINPUT))
    _anonymous_ = (&quot;_input&quot;,)
    _fields_ = ((&quot;type&quot;,   wintypes.DWORD),
                (&quot;_input&quot;, _INPUT))

LPINPUT = ctypes.POINTER(INPUT)

def _check_count(result, func, args):
    if result == 0:
        raise ctypes.WinError(ctypes.get_last_error())
    return args

user32.SendInput.errcheck = _check_count
user32.SendInput.argtypes = (wintypes.UINT, # nInputs
                             LPINPUT,       # pInputs
                             ctypes.c_int)  # cbSize

def KeyDown(unicodeKey):
    key, unikey, uniflag = GetKeyCode(unicodeKey)
    x = INPUT( type=INPUT_KEYBOARD, ki= KEYBDINPUT( key, unikey, uniflag, 0))
    user32.SendInput(1, ctypes.byref(x), ctypes.sizeof(x))

def KeyUp(unicodeKey):
    key, unikey, uniflag = GetKeyCode(unicodeKey)
    extra = ctypes.c_ulong(0)
    x = INPUT( type=INPUT_KEYBOARD, ki= KEYBDINPUT( key, unikey, uniflag | KEYEVENTF_KEYUP, 0))
    user32.SendInput(1, ctypes.byref(x), ctypes.sizeof(x))

def KeyPress(unicodeKey):
    time.sleep(0.0001)
    KeyDown(unicodeKey)
    time.sleep(0.0001)
    KeyUp(unicodeKey)
    time.sleep(0.0001)


def GetKeyCode(unicodeKey):
    k = unicodeKey
    curKeyCode = 0
    if k == &quot;up&quot;: curKeyCode = 0x26
    elif k == &quot;down&quot;: curKeyCode = 0x28
    elif k == &quot;left&quot;: curKeyCode = 0x25
    elif k == &quot;right&quot;: curKeyCode = 0x27
    elif k == &quot;home&quot;: curKeyCode = 0x24
    elif k == &quot;end&quot;: curKeyCode = 0x23
    elif k == &quot;insert&quot;: curKeyCode = 0x2D
    elif k == &quot;pgup&quot;: curKeyCode = 0x21
    elif k == &quot;pgdn&quot;: curKeyCode = 0x22
    elif k == &quot;delete&quot;: curKeyCode = 0x2E
    elif k == &quot;\n&quot;: curKeyCode = 0x0D

    if curKeyCode == 0:
        return 0, int(unicodeKey.encode(&quot;hex&quot;), 16), KEYEVENTF_UNICODE
    else:
        return curKeyCode, 0, 0</code>

The above is the detailed content of How can you detect keyboard input in Python scripts running from the terminal?. For more information, please follow other related articles on the PHP Chinese website!