Pynput (Robocorp Fork)

5.0.0 · active · verified Wed Apr 15

This is a maintained fork of the original `pynput` library (by TheMouseOrTheKeyboard), designed specifically for Robocorp's automation needs. It provides cross-platform control and monitoring of user input devices like keyboards and mice, essential for Robotic Process Automation (RPA). Version 5.0.0, released recently, focuses on Python 3.10+ compatibility and Linux environment improvements. Releases align with Robocorp's product development, typically with minor versions for bug fixes and improvements.

Warnings

gotcha Permissions are required for controlling input devices. On macOS, grant 'Accessibility' permissions to your terminal or IDE. On Linux (X11), ensure your user has appropriate X server access.
Fix: Consult your operating system's documentation for granting accessibility/input control permissions to applications or users.
gotcha When using `Listener` objects, `listener.join()` will block the current thread. For non-blocking behavior in GUI applications or concurrent tasks, run listeners in separate threads or manage them asynchronously.
Fix: Use `threading.Thread` to run the listener in the background, or ensure `join()` is called only when the main thread can afford to block.
breaking Older versions of the `pynput-robocorp-fork` (prior to 5.0.0) may have had compatibility issues with Python 3.10 and newer versions.
Fix: Upgrade to `pynput-robocorp-fork` version 5.0.0 or newer to ensure full compatibility with Python 3.10+.
gotcha This is a fork of the original `pynput` library. While it maintains a high degree of API compatibility, it may have subtle differences, specific fixes, or updated dependencies not present in the original `pynput`. Avoid mixing `pynput` and `pynput-robocorp-fork` in the same environment or project.
Fix: Always use `pynput-robocorp-fork` for projects intended for Robocorp environments. Refer to the Robocorp fork's GitHub repository for any specific divergences or feature sets.

Install

pip install pynput-robocorp-fork Install stable version

Imports

Controller
wrong:
```
from pynput.mouse import Controller
```
correct:
```
from pynput.keyboard import Controller
```
Controller exists in both keyboard and mouse modules; ensure you import from the correct one.
Listener
wrong:
```
from pynput import Listener
```
correct:
```
from pynput.keyboard import Listener
```
Listeners are module-specific (keyboard/mouse); import from the specific module.
Key
```
from pynput.keyboard import Key
```
Button
```
from pynput.mouse import Button
```

Quickstart

This example demonstrates how to use the keyboard controller to type a string, press and release a special key (Enter), and perform a key combination (Ctrl+C).

from pynput.keyboard import Controller, Key
import time

keyboard = Controller()

print("Typing 'Hello World'...")
keyboard.type('Hello World')

time.sleep(1)
print("Pressing Enter...")
keyboard.press(Key.enter)
keyboard.release(Key.enter)

time.sleep(1)
print("Pressing Ctrl+C...")
with keyboard.pressed(Key.ctrl):
    keyboard.press('c')
    keyboard.release('c')

print("Keyboard actions completed.")

view raw JSON →