Monitor and control user input devices
Project description
pynput
This library allows you to control and monitor input devices.
Currently, mouse and keyboard input and monitoring are supported.
Controlling the mouse
Use pynput.mouse.Controller like this:
from pynput.mouse import Button, Controller mouse = Controller() # Read pointer position print('The current pointer position is {0}'.format( mouse.position)) # Set pointer position mouse.position = (10, 20) print('Now we have moved it to {0}'.format( mouse.position)) # Move pointer relative to current position mouse.move(5, -5) # Press and release mouse.press(Button.left) mouse.release(Button.left) # Double click; this is different from pressing and releasing # twice on Mac OSX mouse.click(Button.left, 2) # Scroll two steps down mouse.scroll(0, 2)
Monitoring the mouse
Use pynput.mouse.Listener like this:
from pynput import mouse def on_move(x, y): print('Pointer moved to {0}'.format( (x, y))) def on_click(x, y, button, pressed): print('{0} at {1}'.format( 'Pressed' if pressed else 'Released', (x, y))) if not pressed: # Stop listener return False def on_scroll(x, y, dx, dy): print('Scrolled {0}'.format( (x, y))) # Collect events until released with mouse.Listener( on_move=on_move, on_click=on_click, on_scroll=on_scroll) as listener: listener.join()
A mouse listener is a threading.Thread, and all callbacks will be invoked from the thread.
Call pynput.mouse.Listener.stop from anywhere, raise StopException or return False from a callback to stop the listener.
Handling mouse listener errors
If a callback handler raises an exception, the listener will be stopped. Since callbacks run in a dedicated thread, the exceptions will not automatically be reraised.
To be notified about callback errors, call Thread.join on the listener instance:
from pynput import mouse class MyException(Exception): pass def on_click(x, y, button, pressed): if button == mouse.Button.left: raise MyException(button) # Collect events until released with mouse.Listener( on_click=on_click) as listener: try: listener.join() except MyException as e: print('{0} was clicked'.format(e.args[0]))
Controlling the keyboard
Use pynput.keyboard.Controller like this:
from pynput.keyboard import Key, Controller keyboard = Controller() # Press and release space keyboard.press(Key.space) keyboard.release(Key.space) # Type a lower case A; this will work even if no key on the # physical keyboard is labelled 'A' keyboard.press('a') keyboard.release('a') # Type two upper case As keyboard.press('A') keyboard.release('A') with keyboard.pressed(Key.shift): keyboard.press('a') keyboard.release('a') # Type 'Hello World' using the shortcut type method keyboard.type('Hello World')
Monitoring the keyboard
Use pynput.keyboard.Listener like this:
from pynput import keyboard def on_press(key): try: print('alphanumeric key {0} pressed'.format( key.char)) except AttributeError: print('special key {0} pressed'.format( key)) def on_release(key): print('{0} released'.format( key)) if key == keyboard.Key.esc: # Stop listener return False # Collect events until released with keyboard.Listener( on_press=on_press, on_release=on_release) as listener: listener.join()
A keyboard listener is a threading.Thread, and all callbacks will be invoked from the thread.
Call pynput.keyboard.Listener.stop from anywhere, raise StopException or return False from a callback to stop the listener.
The key parameter passed to callbacks is a pynput.keyboard.Key, for special keys, a pynput.keyboard.KeyCode for normal alphanumeric keys, or just None for unknown keys.
Handling keyboard listener errors
If a callback handler raises an exception, the listener will be stopped. Since callbacks run in a dedicated thread, the exceptions will not automatically be reraised.
To be notified about callback errors, call Thread.join on the listener instance:
from pynput import keyboard class MyException(Exception): pass def on_press(key): if key == keyboard.Key.esc: raise MyException(key) # Collect events until released with keyboard.Listener( on_press=on_press) as listener: try: listener.join() except MyException as e: print('{0} was pressed'.format(e.args[0]))
Release Notes
v1.3.4 - Xorg corrections
Corrected bounds check for values on Xorg.
v1.3.3 - Make dependencies non-optional
Made platform depdendencies non-optional.
v1.3 - Platform specific features
Added ability to stop event propagation on Windows. This will prevent events from reaching other applications.
Added ability to ignore events on Windows. This is a workaround for systems where the keyboard monitor interferes with normal keyboard events.
Added ability to modify events on OSX. This allows intercepting and altering input events before they reach other applications.
Corrected crash on OSX when some types of third party input sources are installed.
v1.2 - Improved error handling
Allow catching exceptions thrown from listener callbacks. This changes the API, as joining a listener now potentially raises unhandled exceptions, and unhandled exceptions will stop listeners.
Added support for the numeric keypad on Linux.
Improved documentation.
Thanks to jollysean and gilleswijnker for their input!
v1.1.6 - Corrected context manager for pressing keys
Corrected bug in pynput.keyboard.Controller.pressed which caused it to never release the key. Many thanks to Toby Southwell!
v1.1.5 - Corrected modifier key combinations on Linux
Corrected handling of modifier keys to allow them to be composable on Linux.
v1.1.4 - Small bugfixes
Corrected error generation when GetKeyboardState fails.
Make sure to apply shift state to borrowed keys on X.
Use pylint.
v1.1.3 - Changed Xlib backend library
Changed Xlib library.
v1.1.2 - Added missing type for Python 2
Added missing LPDWORD for Python 2 on Windows.
v1.1.1 - Fixes for listeners and controllers on Windows
Corrected keyboard listener on Windows. Modifier keys and other keys changing the state of the keyboard are now handled correctly.
Corrected mouse click and release on Windows.
Corrected code samples.
v1.1 - Simplified usage on Linux
Propagate import errors raised on Linux to help troubleshoot missing Xlib module.
Declare python3-xlib as dependency on Linux for Python 3.
v1.0.6 - Universal wheel
Make sure to build a universal wheel for all python versions.
v1.0.5 - Fixes for dragging on OSX
Corrected dragging on OSX.
Added scroll speed constant for OSX to correct slow scroll speed.
v1.0.4 - Fixes for clicking and scrolling on Windows
Corrected name of mouse input field when sending click and scroll events.
v1.0.3 - Fixes for Python 3 on Windows
Corrected use of ctypes on Windows.
v1.0.2 - Fixes for thread identifiers
Use thread identifiers to identify threads, not Thread instances.
v1.0.1 - Fixes for Python 3
Corrected bugs which prevented the library from being used on Python 3.
v1.0 - Stable Release
Changed license to LGPL.
Corrected minor bugs and inconsistencies.
Corrected and extended documentation.
v0.6 - Keyboard Monitor
Added support for monitoring the keyboard.
Corrected wheel packaging.
Corrected deadlock when stopping a listener in some cases on X.
Corrected key code constants on Mac OSX.
Do not intercept events on Mac OSX.
v0.5.1 - Do not die on dead keys
Corrected handling of dead keys.
Corrected documentation.
v0.5 - Keyboard Modifiers
Added support for modifiers.
v0.4 - Keyboard Controller
Added keyboard controller.
v0.3 - Cleanup
Moved pynput.mouse.Controller.Button to top-level.
v0.2 - Initial Release
Support for controlling the mouse on Linux, Mac OSX and Windows.
Support for monitoring the mouse on Linux, Mac OSX and Windows.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for pynput-1.3.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8358329e105b1476bab03756b53f060a1b0bdee944ad4a91c83df4bc3b40595b |
|
MD5 | 71679d7bc4cfcdbe1001b16f59a336d1 |
|
BLAKE2b-256 | aad37ee26101c5006ab4341ca56575e420ccc6078a1181f080cb709ccccc1f42 |