pynput
======
This library allows you to control and monitor input devices.
Currently, mouse and keyboard input and monitoring are supported.
See `here <https://pynput.readthedocs.io/en/latest/>`_ for the full
documentation.
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 macOS
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} at {1}'.format(
'down' if dy < 0 else 'up',
(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()
# ...or, in a non-blocking fashion:
listener = mouse.Listener(
on_move=on_move,
on_click=on_click,
on_scroll=on_scroll)
listener.start()
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.
When using the non-blocking version above, the current thread will continue
executing. This might be necessary when integrating with other GUI frameworks
that incorporate a main-loop, but when run from a script, this will cause the
program to terminate immediately.
The mouse listener thread
~~~~~~~~~~~~~~~~~~~~~~~~~
The listener callbacks are invoked directly from an operating thread on some
platforms, notably *Windows*.
This means that long running procedures and blocking operations should not be
invoked from the callback, as this risks freezing input for all processes.
A possible workaround is to just dispatch incoming messages to a queue, and let
a separate thread handle them.
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]))
Toggling event listening for the mouse listener
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once ``pynput.mouse.Listener.stop`` has been called, the listener cannot be
restarted, since listeners are instances of ``threading.Thread``.
If your application requires toggling listening events, you must either add an
internal flag to ignore events when not required, or create a new listener when
resuming listening.
Synchronous event listening for the mouse listener
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To simplify scripting, synchronous event listening is supported through the
utility class ``pynput.mouse.Events``. This class supports reading single
events in a non-blocking fashion, as well as iterating over all events.
To read a single event, use the following code::
from pynput import mouse
# The event listener will be running in this block
with mouse.Events() as events:
# Block at most one second
event = events.get(1.0)
if event is None:
print('You did not interact with the mouse within one second')
else:
print('Received event {}'.format(event))
To iterate over mouse events, use the following code::
from pynput import mouse
# The event listener will be running in this block
with mouse.Events() as events:
for event in events:
if event.button == mouse.Button.right:
break
else:
print('Received event {}'.format(event))
Please note that the iterator method does not support non-blocking operation,
so it will wait for at least one mouse event.
The events will be instances of the inner classes found in
``pynput.mouse.Events``.
Ensuring consistent coordinates between listener and controller on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Recent versions of _Windows_ support running legacy applications scaled when
the system scaling has been increased beyond 100%. This allows old applications
to scale, albeit with a blurry look, and avoids tiny, unusable user interfaces.
This scaling is unfortunately inconsistently applied to a mouse listener and a
controller: the listener will receive physical coordinates, but the controller
has to work with scaled coordinates.
This can be worked around by telling Windows that your application is DPI
aware. This is a process global setting, so _pynput_ cannot do it
automatically. Do enable DPI awareness, run the following code::
import ctypes
PROCESS_PER_MONITOR_DPI_AWARE = 2
ctypes.windll.shcore.SetProcessDpiAwareness(PROCESS_PER_MONITOR_DPI_AWARE)
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()
# ...or, in a non-blocking fashion:
listener = keyboard.Listener(
on_press=on_press,
on_release=on_release)
listener.start()
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.
When using the non-blocking version above, the current thread will continue
executing. This might be necessary when integrating with other GUI frameworks
that incorporate a main-loop, but when run from a script, this will cause the
program to terminate immediately.
The keyboard listener thread
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The listener callbacks are invoked directly from an operating thread on some
platforms, notably *Windows*.
This means that long running procedures and blocking operations should not be
invoked from the callback, as this risks freezing input for all processes.
A possible workaround is to just dispatch incoming messages to a queue, and let
a separate thread handle them.
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]))
Toggling event listening for the keyboard listener
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once ``pynput.keyboard.Listener.stop`` has been called, the listener cannot be
restarted, since listeners are instances of ``threading.Thread``.
If your application requires toggling listening events, you must either add an
internal flag to ignore events when not required, or create a new listener when
resuming listening.
Synchronous event listening for the keyboard listener
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To simplify scripting, synchronous event listening is supported through the
utility class ``pynput.keyboard.Events``. This class supports reading single
events in a non-blocking fashion, as well as iterating over all events.
To read a single event, use the following code::
from pynput import keyboard
# The event listener will be running in this block
with keyboard.Events() as events:
# Block at most one second
event = events.get(1.0)
if event is None:
print('You did not press a key within one second')
else:
print('Received event {}'.format(event))
To iterate over keyboard events, use the following code::
from pynput import keyboard
# The event listener will be running in this block
with keyboard.Events() as events:
for event in events:
if event.key == keyboard.Key.esc:
break
else:
print('Received event {}'.format(event))
Please note that the iterator method does not support non-blocking operation,
so it will wait for at least one keyboard event.
The events will be instances of the inner classes found in
``pynput.keyboard.Events``.
Global hotkeys
~~~~~~~~~~~~~~
A common use case for keyboard monitors is reacting to global hotkeys. Since a
listener does not maintain any state, hotkeys involving multiple keys must
store this state somewhere.
*pynput* provides the class ``pynput.keyboard.HotKey`` for this purpose. It
contains two methods to update the state, designed to be easily interoperable
with a keyboard listener: ``pynput.keyboard.HotKey.press`` and
``pynput.keyboard.HotKey.release`` which can be directly passed as listener
callbacks.
The intended usage is as follows::
from pynput import keyboard
def on_activate():
print('Global hotkey activated!')
def for_canonical(f):
return lambda k: f(l.canonical(k))
hotkey = keyboard.HotKey(
keyboard.HotKey.parse('<ctrl>+<alt>+h'),
on_activate)
with keyboard.Listener(
on_press=for_canonical(hotkey.press),
on_release=for_canonical(hotkey.release)) as l:
l.join()
This will create a hotkey, and then use a listener to update its state. Once
all the specified keys are pressed simultaneously, ``on_activate`` will be
invoked.
Note that keys are passed through ``pynput.keyboard.Listener.canonical`` before
being passed to the ``HotKey`` instance. This is to remove any modifier state
from the key events, and to normalise modifiers with more than one physical
button.
The method ``pynput.keyboard.HotKey.parse`` is a convenience function to
transform shortcut strings to key collections. Please see its documentation for
more information.
To register a number of global hotkeys, use the convenience class
``pynput.keyboard.GlobalHotKeys``::
from pynput import keyboard
def on_activate_h():
print('<ctrl>+<alt>+h pressed')
def on_activate_i():
print('<ctrl>+<alt>+i pressed')
with keyboard.GlobalHotKeys({
'<ctrl>+<alt>+h': on_activate_h,
'<ctrl>+<alt>+i': on_activate_i}) as h:
h.join()
Release Notes
=============
v1.7.7 (2024-05-10) - Various fixes
-----------------------------------
* Small corrections to the documentation.
* Handle explicit timeout when calling ``join`` on listeners.
* Correct regression in hot key handling for special keys.
* Reverted changes to lazy loading of ``CoreFoundation`` and ``Quartz``, since
this still does not appear to work. Thanks to *Zach Zaiman*!
* Let the type of values in ``Key`` be ``KeyCode`` so that type checkers are
not confused. Thanks to *Amund Eggen Svandal*!
* Do not crash in ``__del__`` on *Xorg* if display creation fails. Thanks to
*Gabriele Pongelli*!
* Correct support for emojis on *Windows*. Thanks to *Yunus Emre*!
v1.7.6 (2022-01-01) - Various fixes
-----------------------------------
* Allow passing virtual key codes to the parser for global hot keys.
* Stop the recording context asynchronously on *Xorg*.
* Do not pass ``None`` to ``objc.objc_object``. Thanks to *yejunxi*!
* Do not crash when pressing the *alt* key on *uinput*. Thanks to *Caldas
Lopes*!
* Use the correct option prefix for listeners derived from the backend
implementations. Thanks to *Yu Wang*!
v1.7.5 (2021-11-19) - Various fixes
-----------------------------------
* Corrected crashes on *Xorg* when a listener was configured to suppress
system events. Thanks to *jpramosi*!
* Improved handling of keyboard controller on *Windows*. The controller now
has a greater change of working with applications using lower level events.
Thanks to *bhudax*!
* Updated *macOS* implementation to use new version of *pyobjc*.
v1.7.4 (2021-10-10) - Various fixes
-----------------------------------
* Detect whether permissions are lacking on *macOS*. Thanks to *Dane Finlay*!
* Eagerly import symbols from ``CoreFoundation`` and ``Quartz``. Thanks to
*Ronald Oussoren*!
* Improved handling of ``dumpkeys`` utility. Thanks to *Markus Niedermann*!
* Removed ambiguous license file.
v1.7.3 (2021-02-10) - Various fixes
-----------------------------------
* Corrected *keysym* handling on *Xorg*; not all groups were loaded, and the
fallback to our internal tables was never triggered. Thanks to *Philipp
Klaus*!
* Updated the version of *Quartz* used for the *macOS* backend to allow
*pynput* to be installed on *Big Sur*. Thanks to *Michael Madden*!
* Added missing function keys on *Windows*. Thanks to *Dave Atkinson*!
* Corrected scroll speed for mouse controller on *macOS*. Thanks to *Albert
Zeyer*!
* Corrected media keys for *Xorg*. Thanks to *Gabriele N. Tornetta*!
* Corrected parameter name in documentation. Thanks to *Jinesi Yelizati*!
v1.7.2 (2020-12-21) - Corrected uinput key mapping
--------------------------------------------------
* Corrected mapping of virtual key codes to characters for the *uinput*
backend.
* Corrected spelling errors. Thanks to *Martin Michlmayr*!
* Corrected and improved documentation.
v1.7.1 (2020-08-30) - Corrected release notes
---------------------------------------------
* Corrected thanks for arbitrary unicode character support for *Xorg*.
v1.7.0 (2020-08-30) - A new backend and many new features and bug fixes
-----------------------------------------------------------------------
* Added a new *uinput* based keyboard backend for *Linux*, when no *X* server
is available.
* Allow typing arbitrary unicode characters on *Xorg* backend. Thanks to
*gdiShun*!
* Allow overriding the automatically selected backend with an environment
variable, and added a dummy backend.
* Added support for mouse side button on *Windows*. Thanks to *danielkovarik*!
* Added convenience method to tap keys.
* Allow specifying raw virtual key codes in hotkeys.
* Improved error messages when a backend cannot be loaded.
* Include more information in stringification of events.
* Corrected return value of ``Events.get`` to that specified by the
documentation.
* Corrected keyboard listener not to type random characters on certain
keyboard layouts.
* Corrected errors when pressing certain keys on *Windows*, where the
operating system reports that they are dead but no combining version exists.
* Improved documentation.
v1.6.8 (2020-02-28) - Various fixes
-----------------------------------
* Updated documentation.
* Corrected lint warnings and tests.
* Do not use internal types in ``argtypes`` for ``win32`` functions; this
renders them uncallable for other code running in the same runtime.
* Include scan codes in events on *Windows*. Thanks to *bhudax*!
* Correctly apply transformation to scroll event values on *Windows*. Thanks
to *DOCCA0*!
v1.6.7 (2020-02-17) - Various fixes
-----------------------------------
* Corrected infinite scrolling on *macOS* when providing non-integer deltas.
Thanks to *Iván Munsuri Ibáñez*!
* Corrected controller and listener handling of media keys on *macOS*. Thanks
to *Iván Munsuri Ibáñez*!
v1.6.6 (2020-01-23) - Corrected hot key documentation
-----------------------------------------------------
* The code examples for the simple ``pynput.keyboard.HotKey`` now work. Thanks
to *jfongattw*!
v1.6.5 (2020-01-08) - Corrected media key mappings
--------------------------------------------------
* Corrected media key mappings on *macOS*. Thanks to *Luis Nachtigall*!
v1.6.4 (2020-01-03) - Corrected imports yet again
-------------------------------------------------
* Corrected imports for keyboard Controller. Thanks to *rhystedstone*!
v1.6.3 (2019-12-28) - Corrected imports again
---------------------------------------------
* Corrected imports for keyboard Controller. Thanks to *Matt Iversen*!
v1.6.2 (2019-12-28) - Corrected imports
---------------------------------------
* Corrected imports for keyboard Controller. Thanks to *Matt Iversen*!
v1.6.1 (2019-12-27) - Corrections for *Windows*
-----------------------------------------------
* Corrected global hotkeys on *Windows*.
* Corrected pressed / released state for keyboard listener on *Windows*.
Thanks to *segalion*!
v1.6.0 (2019-12-11) - Global Hotkeys
------------------------------------
* Added support for global hotkeys.
* Added support for streaming listener events synchronously.
v1.5.2 (2019-12-06) - Corrected media key names for *Xorg*
----------------------------------------------------------
* Removed media flag from *Xorg* keys.
v1.5.1 (2019-12-06) - Corrected media key names for *macOS*
-----------------------------------------------------------
* Corrected attribute names for media keys on *macOS*. Thanks to *ah3243*!
v1.5.0 (2019-12-04) - Various improvements
------------------------------------------
* Corrected keyboard listener on *Windows*. Thanks to *akiratakasaki*,
*segalion*, *SpecialCharacter*!
* Corrected handling of some special keys, including arrow keys, when combined
with modifiers on *Windows*. Thanks to *tuessetr*!
* Updated documentation to include information about DPI scaling on *Windows*.
Thanks to *david-szarka*!
* Added experimental support for media keys. Thanks to *ShivamJoker*,
*StormTersteeg*!
v1.4.5 (2019-11-05) - Corrected errors on *Python 3.8*
------------------------------------------------------
* Corrected errors about using `in` operator for enums on *Python 3.8* on
*macOS*.
v1.4.4 (2019-09-24) - Actually corrected keyboard listener on macOS
-------------------------------------------------------------------
* Included commit to correctly fall back on
``CGEventKeyboardGetUnicodeString``.
* Corrected deprecation warnings about ``Enum`` usage on *Python 3.8*.
v1.4.3 (2019-09-24) - Corrected keyboard listener on macOS again
----------------------------------------------------------------
* Correctly fall back on ``CGEventKeyboardGetUnicodeString``.
* Updated documentation.
v1.4.2 (2019-03-22) - Corrected keyboard listener on macOS
----------------------------------------------------------
* Use ``CGEventKeyboardGetUnicodeString`` in *macOS* keyboard listener to send
correct characters.
* Include keysym instead of key code in *Xorg* keyboard listener.
* Corrected logging to not include expected ``StopException``.
* Updated and corrected documentation.
v1.4.1 (2018-09-07) - Logging
-----------------------------
* Log unhandled exceptions raised by listener callbacks.
v1.4 (2018-07-03) - Event suppression
-------------------------------------
* Added possibility to fully suppress events when listening.
* Added support for typing some control characters.
* Added support for mouse drag events on *OSX*. Thanks to *jungledrum*!
* Include the key code in keyboard listener events.
* Correctly handle the numeric key pad on *Xorg* with *num lock* active.
Thanks to *TheoRet*!
* Corrected handling of current thread keyboard layout on *Windows*. Thanks to
*Schmettaling*!
* Corrected stopping of listeners on *Xorg*.
* Corrected import of ``Xlib.keysymdef.xkb`` on *Xorg*. Thanks to *Glandos*!
v1.3.10 (2018-02-05) - Do not crash under *Xephyr*
--------------------------------------------------
* Do not crash when ``Xlib.display.Display.get_input_focus`` returns an
integer, as it may when running under *Xephyr*. Thanks to *Eli Skeggs*!
v1.3.9 (2018-01-12) - Correctly handle the letter *A* on *OSX*
--------------------------------------------------------------
* Corrected check for virtual key code when generating keyboard events on
*OSX*. This fixes an issue where pressing *A* with *shift* explicitly pressed
would still type a minuscule letter.
v1.3.8 (2017-12-08) - Do not crash on some keyboard layouts on *OSX*
--------------------------------------------------------------------
* Fall back on a different method to retrieve the keyboard layout on *OSX*.
This helps for some keyboard layouts, such as *Chinese*. Thanks to
*haoflynet*!
v1.3.7 (2017-08-23) - *Xorg* corrections
----------------------------------------
* Include mouse buttons up to *30* for *Xorg*.
v1.3.6 (2017-08-13) - *win32* corrections
-----------------------------------------
* Corrected double delivery of fake keyboard events on *Windows*.
* Corrected handling of synthetic unicode keys on *Windows*.
v1.3.5 (2017-06-07) - Corrected dependencies again
--------------------------------------------------
* Reverted changes in *1.3.3*.
* Corrected platform specifier for *Python 2* on *Linux*.
v1.3.4 (2017-06-05) - *Xorg* corrections
----------------------------------------
* Corrected bounds check for values on *Xorg*.
v1.3.3 (2017-06-05) - Make dependencies non-optional
----------------------------------------------------
* Made platform dependencies non-optional.
v1.3.2 (2017-05-15) - Fix for button click on Mac
-------------------------------------------------
* Corrected regression from previous release where button clicks would
crash the *Mac* mouse listener.
v1.3.1 (2017-05-12) - Fixes for unknown buttons on Linux
--------------------------------------------------------
* Fall back on `Button.unknown` for unknown mouse buttons in *Xorg* mouse
listener.
v1.3 (2017-04-10) - 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 (2017-01-06) - 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.7 (2017-01-02) - Handle middle button on Windows
-----------------------------------------------------
* Listen for and dispatch middle button mouse clicks on *Windows*.
v1.1.6 (2016-11-24) - 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 (2016-11-17) - Corrected modifier key combinations on Linux
------------------------------------------------------------------
* Corrected handling of modifier keys to allow them to be composable on
*Linux*.
v1.1.4 (2016-10-30) - Small bugfixes
------------------------------------
* Corrected error generation when ``GetKeyboardState`` fails.
* Make sure to apply shift state to borrowed keys on *X*.
* Use *pylint*.
v1.1.3 (2016-09-27) - Changed Xlib backend library
--------------------------------------------------
* Changed *Xlib* library.
v1.1.2 (2016-09-26) - Added missing type for Python 2
-----------------------------------------------------
* Added missing ``LPDWORD`` for *Python 2* on *Windows*.
v1.1.1 (2016-09-26) - 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 (2016-06-22) - 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 (2016-04-19) - Universal wheel
-------------------------------------
* Make sure to build a universal wheel for all python versions.
v1.0.5 (2016-04-11) - Fixes for dragging on OSX
-----------------------------------------------
* Corrected dragging on *OSX*.
* Added scroll speed constant for *OSX* to correct slow scroll speed.
v1.0.4 (2016-04-11) - Fixes for clicking and scrolling on Windows
-----------------------------------------------------------------
* Corrected name of mouse input field when sending click and scroll events.
v1.0.3 (2016-04-05) - Fixes for Python 3 on Windows
---------------------------------------------------
* Corrected use of ``ctypes`` on Windows.
v1.0.2 (2016-04-03) - Fixes for thread identifiers
--------------------------------------------------
* Use thread identifiers to identify threads, not Thread instances.
v1.0.1 (2016-04-03) - Fixes for Python 3
----------------------------------------
* Corrected bugs which prevented the library from being used on *Python 3*.
v1.0 (2016-02-28) - Stable Release
----------------------------------
* Changed license to *LGPL*.
* Corrected minor bugs and inconsistencies.
* Corrected and extended documentation.
v0.6 (2016-02-08) - 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 (2016-01-26) - Do not die on dead keys
---------------------------------------------
* Corrected handling of dead keys.
* Corrected documentation.
v0.5 (2016-01-18) - Keyboard Modifiers
--------------------------------------
* Added support for modifiers.
v0.4 (2015-12-22) - Keyboard Controller
---------------------------------------
* Added keyboard controller.
v0.3 (2015-12-22) - Cleanup
---------------------------
* Moved ``pynput.mouse.Controller.Button`` to top-level.
v0.2 (2015-10-28) - Initial Release
-----------------------------------
* Support for controlling the mouse on *Linux*, *Mac OSX* and *Windows*.
* Support for monitoring the mouse on *Linux*, *Mac OSX* and *Windows*.
Raw data
{
"_id": null,
"home_page": "https://github.com/moses-palmer/pynput",
"name": "pynput",
"maintainer": null,
"docs_url": "https://pythonhosted.org/pynput/",
"requires_python": null,
"maintainer_email": null,
"keywords": "control mouse, mouse input, control keyboard, keyboard input",
"author": "Moses Palm\u00e9r",
"author_email": "moses.palmer@gmail.com",
"download_url": null,
"platform": null,
"description": "pynput\n======\n\nThis library allows you to control and monitor input devices.\n\nCurrently, mouse and keyboard input and monitoring are supported.\n\nSee `here <https://pynput.readthedocs.io/en/latest/>`_ for the full\ndocumentation.\n\n\nControlling the mouse\n---------------------\n\nUse ``pynput.mouse.Controller`` like this::\n\n from pynput.mouse import Button, Controller\n\n mouse = Controller()\n\n # Read pointer position\n print('The current pointer position is {0}'.format(\n mouse.position))\n\n # Set pointer position\n mouse.position = (10, 20)\n print('Now we have moved it to {0}'.format(\n mouse.position))\n\n # Move pointer relative to current position\n mouse.move(5, -5)\n\n # Press and release\n mouse.press(Button.left)\n mouse.release(Button.left)\n\n # Double click; this is different from pressing and releasing\n # twice on macOS\n mouse.click(Button.left, 2)\n\n # Scroll two steps down\n mouse.scroll(0, 2)\n\n\nMonitoring the mouse\n--------------------\n\nUse ``pynput.mouse.Listener`` like this::\n\n from pynput import mouse\n\n def on_move(x, y):\n print('Pointer moved to {0}'.format(\n (x, y)))\n\n def on_click(x, y, button, pressed):\n print('{0} at {1}'.format(\n 'Pressed' if pressed else 'Released',\n (x, y)))\n if not pressed:\n # Stop listener\n return False\n\n def on_scroll(x, y, dx, dy):\n print('Scrolled {0} at {1}'.format(\n 'down' if dy < 0 else 'up',\n (x, y)))\n\n # Collect events until released\n with mouse.Listener(\n on_move=on_move,\n on_click=on_click,\n on_scroll=on_scroll) as listener:\n listener.join()\n\n # ...or, in a non-blocking fashion:\n listener = mouse.Listener(\n on_move=on_move,\n on_click=on_click,\n on_scroll=on_scroll)\n listener.start()\n\nA mouse listener is a ``threading.Thread``, and all callbacks will be invoked\nfrom the thread.\n\nCall ``pynput.mouse.Listener.stop`` from anywhere, raise ``StopException`` or\nreturn ``False`` from a callback to stop the listener.\n\nWhen using the non-blocking version above, the current thread will continue\nexecuting. This might be necessary when integrating with other GUI frameworks\nthat incorporate a main-loop, but when run from a script, this will cause the\nprogram to terminate immediately.\n\n\nThe mouse listener thread\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe listener callbacks are invoked directly from an operating thread on some\nplatforms, notably *Windows*.\n\nThis means that long running procedures and blocking operations should not be\ninvoked from the callback, as this risks freezing input for all processes.\n\nA possible workaround is to just dispatch incoming messages to a queue, and let\na separate thread handle them.\n\n\nHandling mouse listener errors\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf a callback handler raises an exception, the listener will be stopped. Since\ncallbacks run in a dedicated thread, the exceptions will not automatically be\nreraised.\n\nTo be notified about callback errors, call ``Thread.join`` on the listener\ninstance::\n\n from pynput import mouse\n\n class MyException(Exception): pass\n\n def on_click(x, y, button, pressed):\n if button == mouse.Button.left:\n raise MyException(button)\n\n # Collect events until released\n with mouse.Listener(\n on_click=on_click) as listener:\n try:\n listener.join()\n except MyException as e:\n print('{0} was clicked'.format(e.args[0]))\n\n\nToggling event listening for the mouse listener\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOnce ``pynput.mouse.Listener.stop`` has been called, the listener cannot be\nrestarted, since listeners are instances of ``threading.Thread``.\n\nIf your application requires toggling listening events, you must either add an\ninternal flag to ignore events when not required, or create a new listener when\nresuming listening.\n\n\nSynchronous event listening for the mouse listener\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo simplify scripting, synchronous event listening is supported through the\nutility class ``pynput.mouse.Events``. This class supports reading single\nevents in a non-blocking fashion, as well as iterating over all events.\n\nTo read a single event, use the following code::\n\n from pynput import mouse\n\n # The event listener will be running in this block\n with mouse.Events() as events:\n # Block at most one second\n event = events.get(1.0)\n if event is None:\n print('You did not interact with the mouse within one second')\n else:\n print('Received event {}'.format(event))\n\nTo iterate over mouse events, use the following code::\n\n from pynput import mouse\n\n # The event listener will be running in this block\n with mouse.Events() as events:\n for event in events:\n if event.button == mouse.Button.right:\n break\n else:\n print('Received event {}'.format(event))\n\nPlease note that the iterator method does not support non-blocking operation,\nso it will wait for at least one mouse event.\n\nThe events will be instances of the inner classes found in\n``pynput.mouse.Events``.\n\n\nEnsuring consistent coordinates between listener and controller on Windows\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nRecent versions of _Windows_ support running legacy applications scaled when\nthe system scaling has been increased beyond 100%. This allows old applications\nto scale, albeit with a blurry look, and avoids tiny, unusable user interfaces.\n\nThis scaling is unfortunately inconsistently applied to a mouse listener and a\ncontroller: the listener will receive physical coordinates, but the controller\nhas to work with scaled coordinates.\n\nThis can be worked around by telling Windows that your application is DPI\naware. This is a process global setting, so _pynput_ cannot do it\nautomatically. Do enable DPI awareness, run the following code::\n\n import ctypes\n\n\n PROCESS_PER_MONITOR_DPI_AWARE = 2\n\n ctypes.windll.shcore.SetProcessDpiAwareness(PROCESS_PER_MONITOR_DPI_AWARE)\n\n\nControlling the keyboard\n------------------------\n\nUse ``pynput.keyboard.Controller`` like this::\n\n from pynput.keyboard import Key, Controller\n\n keyboard = Controller()\n\n # Press and release space\n keyboard.press(Key.space)\n keyboard.release(Key.space)\n\n # Type a lower case A; this will work even if no key on the\n # physical keyboard is labelled 'A'\n keyboard.press('a')\n keyboard.release('a')\n\n # Type two upper case As\n keyboard.press('A')\n keyboard.release('A')\n with keyboard.pressed(Key.shift):\n keyboard.press('a')\n keyboard.release('a')\n\n # Type 'Hello World' using the shortcut type method\n keyboard.type('Hello World')\n\n\nMonitoring the keyboard\n-----------------------\n\nUse ``pynput.keyboard.Listener`` like this::\n\n from pynput import keyboard\n\n def on_press(key):\n try:\n print('alphanumeric key {0} pressed'.format(\n key.char))\n except AttributeError:\n print('special key {0} pressed'.format(\n key))\n\n def on_release(key):\n print('{0} released'.format(\n key))\n if key == keyboard.Key.esc:\n # Stop listener\n return False\n\n # Collect events until released\n with keyboard.Listener(\n on_press=on_press,\n on_release=on_release) as listener:\n listener.join()\n\n # ...or, in a non-blocking fashion:\n listener = keyboard.Listener(\n on_press=on_press,\n on_release=on_release)\n listener.start()\n\nA keyboard listener is a ``threading.Thread``, and all callbacks will be\ninvoked from the thread.\n\nCall ``pynput.keyboard.Listener.stop`` from anywhere, raise ``StopException``\nor return ``False`` from a callback to stop the listener.\n\nThe ``key`` parameter passed to callbacks is a ``pynput.keyboard.Key``, for\nspecial keys, a ``pynput.keyboard.KeyCode`` for normal alphanumeric keys, or\njust ``None`` for unknown keys.\n\nWhen using the non-blocking version above, the current thread will continue\nexecuting. This might be necessary when integrating with other GUI frameworks\nthat incorporate a main-loop, but when run from a script, this will cause the\nprogram to terminate immediately.\n\n\nThe keyboard listener thread\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe listener callbacks are invoked directly from an operating thread on some\nplatforms, notably *Windows*.\n\nThis means that long running procedures and blocking operations should not be\ninvoked from the callback, as this risks freezing input for all processes.\n\nA possible workaround is to just dispatch incoming messages to a queue, and let\na separate thread handle them.\n\n\nHandling keyboard listener errors\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf a callback handler raises an exception, the listener will be stopped. Since\ncallbacks run in a dedicated thread, the exceptions will not automatically be\nreraised.\n\nTo be notified about callback errors, call ``Thread.join`` on the listener\ninstance::\n\n from pynput import keyboard\n\n class MyException(Exception): pass\n\n def on_press(key):\n if key == keyboard.Key.esc:\n raise MyException(key)\n\n # Collect events until released\n with keyboard.Listener(\n on_press=on_press) as listener:\n try:\n listener.join()\n except MyException as e:\n print('{0} was pressed'.format(e.args[0]))\n\n\nToggling event listening for the keyboard listener\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOnce ``pynput.keyboard.Listener.stop`` has been called, the listener cannot be\nrestarted, since listeners are instances of ``threading.Thread``.\n\nIf your application requires toggling listening events, you must either add an\ninternal flag to ignore events when not required, or create a new listener when\nresuming listening.\n\n\nSynchronous event listening for the keyboard listener\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo simplify scripting, synchronous event listening is supported through the\nutility class ``pynput.keyboard.Events``. This class supports reading single\nevents in a non-blocking fashion, as well as iterating over all events.\n\nTo read a single event, use the following code::\n\n from pynput import keyboard\n\n # The event listener will be running in this block\n with keyboard.Events() as events:\n # Block at most one second\n event = events.get(1.0)\n if event is None:\n print('You did not press a key within one second')\n else:\n print('Received event {}'.format(event))\n\nTo iterate over keyboard events, use the following code::\n\n from pynput import keyboard\n\n # The event listener will be running in this block\n with keyboard.Events() as events:\n for event in events:\n if event.key == keyboard.Key.esc:\n break\n else:\n print('Received event {}'.format(event))\n\nPlease note that the iterator method does not support non-blocking operation,\nso it will wait for at least one keyboard event.\n\nThe events will be instances of the inner classes found in\n``pynput.keyboard.Events``.\n\n\nGlobal hotkeys\n~~~~~~~~~~~~~~\n\nA common use case for keyboard monitors is reacting to global hotkeys. Since a\nlistener does not maintain any state, hotkeys involving multiple keys must\nstore this state somewhere.\n\n*pynput* provides the class ``pynput.keyboard.HotKey`` for this purpose. It\ncontains two methods to update the state, designed to be easily interoperable\nwith a keyboard listener: ``pynput.keyboard.HotKey.press`` and\n``pynput.keyboard.HotKey.release`` which can be directly passed as listener\ncallbacks.\n\nThe intended usage is as follows::\n\n from pynput import keyboard\n\n def on_activate():\n print('Global hotkey activated!')\n\n def for_canonical(f):\n return lambda k: f(l.canonical(k))\n\n hotkey = keyboard.HotKey(\n keyboard.HotKey.parse('<ctrl>+<alt>+h'),\n on_activate)\n with keyboard.Listener(\n on_press=for_canonical(hotkey.press),\n on_release=for_canonical(hotkey.release)) as l:\n l.join()\n\nThis will create a hotkey, and then use a listener to update its state. Once\nall the specified keys are pressed simultaneously, ``on_activate`` will be\ninvoked.\n\nNote that keys are passed through ``pynput.keyboard.Listener.canonical`` before\nbeing passed to the ``HotKey`` instance. This is to remove any modifier state\nfrom the key events, and to normalise modifiers with more than one physical\nbutton.\n\nThe method ``pynput.keyboard.HotKey.parse`` is a convenience function to\ntransform shortcut strings to key collections. Please see its documentation for\nmore information.\n\nTo register a number of global hotkeys, use the convenience class\n``pynput.keyboard.GlobalHotKeys``::\n\n from pynput import keyboard\n\n def on_activate_h():\n print('<ctrl>+<alt>+h pressed')\n\n def on_activate_i():\n print('<ctrl>+<alt>+i pressed')\n\n with keyboard.GlobalHotKeys({\n '<ctrl>+<alt>+h': on_activate_h,\n '<ctrl>+<alt>+i': on_activate_i}) as h:\n h.join()\n\n\nRelease Notes\n=============\n\nv1.7.7 (2024-05-10) - Various fixes\n-----------------------------------\n* Small corrections to the documentation.\n* Handle explicit timeout when calling ``join`` on listeners.\n* Correct regression in hot key handling for special keys.\n* Reverted changes to lazy loading of ``CoreFoundation`` and ``Quartz``, since\n this still does not appear to work. Thanks to *Zach Zaiman*!\n* Let the type of values in ``Key`` be ``KeyCode`` so that type checkers are\n not confused. Thanks to *Amund Eggen Svandal*!\n* Do not crash in ``__del__`` on *Xorg* if display creation fails. Thanks to\n *Gabriele Pongelli*!\n* Correct support for emojis on *Windows*. Thanks to *Yunus Emre*!\n\n\nv1.7.6 (2022-01-01) - Various fixes\n-----------------------------------\n* Allow passing virtual key codes to the parser for global hot keys.\n* Stop the recording context asynchronously on *Xorg*.\n* Do not pass ``None`` to ``objc.objc_object``. Thanks to *yejunxi*!\n* Do not crash when pressing the *alt* key on *uinput*. Thanks to *Caldas\n Lopes*!\n* Use the correct option prefix for listeners derived from the backend\n implementations. Thanks to *Yu Wang*!\n\n\nv1.7.5 (2021-11-19) - Various fixes\n-----------------------------------\n* Corrected crashes on *Xorg* when a listener was configured to suppress\n system events. Thanks to *jpramosi*!\n* Improved handling of keyboard controller on *Windows*. The controller now\n has a greater change of working with applications using lower level events.\n Thanks to *bhudax*!\n* Updated *macOS* implementation to use new version of *pyobjc*.\n\n\nv1.7.4 (2021-10-10) - Various fixes\n-----------------------------------\n* Detect whether permissions are lacking on *macOS*. Thanks to *Dane Finlay*!\n* Eagerly import symbols from ``CoreFoundation`` and ``Quartz``. Thanks to\n *Ronald Oussoren*!\n* Improved handling of ``dumpkeys`` utility. Thanks to *Markus Niedermann*!\n* Removed ambiguous license file.\n\n\nv1.7.3 (2021-02-10) - Various fixes\n-----------------------------------\n* Corrected *keysym* handling on *Xorg*; not all groups were loaded, and the\n fallback to our internal tables was never triggered. Thanks to *Philipp\n Klaus*!\n* Updated the version of *Quartz* used for the *macOS* backend to allow\n *pynput* to be installed on *Big Sur*. Thanks to *Michael Madden*!\n* Added missing function keys on *Windows*. Thanks to *Dave Atkinson*!\n* Corrected scroll speed for mouse controller on *macOS*. Thanks to *Albert\n Zeyer*!\n* Corrected media keys for *Xorg*. Thanks to *Gabriele N. Tornetta*!\n* Corrected parameter name in documentation. Thanks to *Jinesi Yelizati*!\n\n\nv1.7.2 (2020-12-21) - Corrected uinput key mapping\n--------------------------------------------------\n* Corrected mapping of virtual key codes to characters for the *uinput*\n backend.\n* Corrected spelling errors. Thanks to *Martin Michlmayr*!\n* Corrected and improved documentation.\n\n\nv1.7.1 (2020-08-30) - Corrected release notes\n---------------------------------------------\n* Corrected thanks for arbitrary unicode character support for *Xorg*.\n\n\nv1.7.0 (2020-08-30) - A new backend and many new features and bug fixes\n-----------------------------------------------------------------------\n* Added a new *uinput* based keyboard backend for *Linux*, when no *X* server\n is available.\n* Allow typing arbitrary unicode characters on *Xorg* backend. Thanks to\n *gdiShun*!\n* Allow overriding the automatically selected backend with an environment\n variable, and added a dummy backend.\n* Added support for mouse side button on *Windows*. Thanks to *danielkovarik*!\n* Added convenience method to tap keys.\n* Allow specifying raw virtual key codes in hotkeys.\n* Improved error messages when a backend cannot be loaded.\n* Include more information in stringification of events.\n* Corrected return value of ``Events.get`` to that specified by the\n documentation.\n* Corrected keyboard listener not to type random characters on certain\n keyboard layouts.\n* Corrected errors when pressing certain keys on *Windows*, where the\n operating system reports that they are dead but no combining version exists.\n* Improved documentation.\n\n\nv1.6.8 (2020-02-28) - Various fixes\n-----------------------------------\n* Updated documentation.\n* Corrected lint warnings and tests.\n* Do not use internal types in ``argtypes`` for ``win32`` functions; this\n renders them uncallable for other code running in the same runtime.\n* Include scan codes in events on *Windows*. Thanks to *bhudax*!\n* Correctly apply transformation to scroll event values on *Windows*. Thanks\n to *DOCCA0*!\n\n\nv1.6.7 (2020-02-17) - Various fixes\n-----------------------------------\n* Corrected infinite scrolling on *macOS* when providing non-integer deltas.\n Thanks to *Iva\u0301n Munsuri Iba\u0301n\u0303ez*!\n* Corrected controller and listener handling of media keys on *macOS*. Thanks\n to *Iva\u0301n Munsuri Iba\u0301n\u0303ez*!\n\n\nv1.6.6 (2020-01-23) - Corrected hot key documentation\n-----------------------------------------------------\n* The code examples for the simple ``pynput.keyboard.HotKey`` now work. Thanks\n to *jfongattw*!\n\n\nv1.6.5 (2020-01-08) - Corrected media key mappings\n--------------------------------------------------\n* Corrected media key mappings on *macOS*. Thanks to *Luis Nachtigall*!\n\n\nv1.6.4 (2020-01-03) - Corrected imports yet again\n-------------------------------------------------\n* Corrected imports for keyboard Controller. Thanks to *rhystedstone*!\n\n\nv1.6.3 (2019-12-28) - Corrected imports again\n---------------------------------------------\n* Corrected imports for keyboard Controller. Thanks to *Matt Iversen*!\n\n\nv1.6.2 (2019-12-28) - Corrected imports\n---------------------------------------\n* Corrected imports for keyboard Controller. Thanks to *Matt Iversen*!\n\n\nv1.6.1 (2019-12-27) - Corrections for *Windows*\n-----------------------------------------------\n* Corrected global hotkeys on *Windows*.\n* Corrected pressed / released state for keyboard listener on *Windows*.\n Thanks to *segalion*!\n\nv1.6.0 (2019-12-11) - Global Hotkeys\n------------------------------------\n* Added support for global hotkeys.\n* Added support for streaming listener events synchronously.\n\n\nv1.5.2 (2019-12-06) - Corrected media key names for *Xorg*\n----------------------------------------------------------\n* Removed media flag from *Xorg* keys.\n\n\nv1.5.1 (2019-12-06) - Corrected media key names for *macOS*\n-----------------------------------------------------------\n* Corrected attribute names for media keys on *macOS*. Thanks to *ah3243*!\n\n\nv1.5.0 (2019-12-04) - Various improvements\n------------------------------------------\n* Corrected keyboard listener on *Windows*. Thanks to *akiratakasaki*,\n *segalion*, *SpecialCharacter*!\n* Corrected handling of some special keys, including arrow keys, when combined\n with modifiers on *Windows*. Thanks to *tuessetr*!\n* Updated documentation to include information about DPI scaling on *Windows*.\n Thanks to *david-szarka*!\n* Added experimental support for media keys. Thanks to *ShivamJoker*,\n *StormTersteeg*!\n\n\nv1.4.5 (2019-11-05) - Corrected errors on *Python 3.8*\n------------------------------------------------------\n* Corrected errors about using `in` operator for enums on *Python 3.8* on\n *macOS*.\n\n\nv1.4.4 (2019-09-24) - Actually corrected keyboard listener on macOS\n-------------------------------------------------------------------\n* Included commit to correctly fall back on\n ``CGEventKeyboardGetUnicodeString``.\n* Corrected deprecation warnings about ``Enum`` usage on *Python 3.8*.\n\n\nv1.4.3 (2019-09-24) - Corrected keyboard listener on macOS again\n----------------------------------------------------------------\n* Correctly fall back on ``CGEventKeyboardGetUnicodeString``.\n* Updated documentation.\n\n\nv1.4.2 (2019-03-22) - Corrected keyboard listener on macOS\n----------------------------------------------------------\n* Use ``CGEventKeyboardGetUnicodeString`` in *macOS* keyboard listener to send\n correct characters.\n* Include keysym instead of key code in *Xorg* keyboard listener.\n* Corrected logging to not include expected ``StopException``.\n* Updated and corrected documentation.\n\n\nv1.4.1 (2018-09-07) - Logging\n-----------------------------\n* Log unhandled exceptions raised by listener callbacks.\n\n\nv1.4 (2018-07-03) - Event suppression\n-------------------------------------\n* Added possibility to fully suppress events when listening.\n* Added support for typing some control characters.\n* Added support for mouse drag events on *OSX*. Thanks to *jungledrum*!\n* Include the key code in keyboard listener events.\n* Correctly handle the numeric key pad on *Xorg* with *num lock* active.\n Thanks to *TheoRet*!\n* Corrected handling of current thread keyboard layout on *Windows*. Thanks to\n *Schmettaling*!\n* Corrected stopping of listeners on *Xorg*.\n* Corrected import of ``Xlib.keysymdef.xkb`` on *Xorg*. Thanks to *Glandos*!\n\n\nv1.3.10 (2018-02-05) - Do not crash under *Xephyr*\n--------------------------------------------------\n* Do not crash when ``Xlib.display.Display.get_input_focus`` returns an\n integer, as it may when running under *Xephyr*. Thanks to *Eli Skeggs*!\n\n\nv1.3.9 (2018-01-12) - Correctly handle the letter *A* on *OSX*\n--------------------------------------------------------------\n* Corrected check for virtual key code when generating keyboard events on\n *OSX*. This fixes an issue where pressing *A* with *shift* explicitly pressed\n would still type a minuscule letter.\n\n\nv1.3.8 (2017-12-08) - Do not crash on some keyboard layouts on *OSX*\n--------------------------------------------------------------------\n* Fall back on a different method to retrieve the keyboard layout on *OSX*.\n This helps for some keyboard layouts, such as *Chinese*. Thanks to\n *haoflynet*!\n\n\nv1.3.7 (2017-08-23) - *Xorg* corrections\n----------------------------------------\n* Include mouse buttons up to *30* for *Xorg*.\n\n\nv1.3.6 (2017-08-13) - *win32* corrections\n-----------------------------------------\n* Corrected double delivery of fake keyboard events on *Windows*.\n* Corrected handling of synthetic unicode keys on *Windows*.\n\n\nv1.3.5 (2017-06-07) - Corrected dependencies again\n--------------------------------------------------\n* Reverted changes in *1.3.3*.\n* Corrected platform specifier for *Python 2* on *Linux*.\n\n\nv1.3.4 (2017-06-05) - *Xorg* corrections\n----------------------------------------\n* Corrected bounds check for values on *Xorg*.\n\n\nv1.3.3 (2017-06-05) - Make dependencies non-optional\n----------------------------------------------------\n* Made platform dependencies non-optional.\n\n\nv1.3.2 (2017-05-15) - Fix for button click on Mac\n-------------------------------------------------\n* Corrected regression from previous release where button clicks would\n crash the *Mac* mouse listener.\n\n\nv1.3.1 (2017-05-12) - Fixes for unknown buttons on Linux\n--------------------------------------------------------\n* Fall back on `Button.unknown` for unknown mouse buttons in *Xorg* mouse\n listener.\n\n\nv1.3 (2017-04-10) - Platform specific features\n----------------------------------------------\n* Added ability to stop event propagation on *Windows*. This will prevent\n events from reaching other applications.\n* Added ability to ignore events on *Windows*. This is a workaround for systems\n where the keyboard monitor interferes with normal keyboard events.\n* Added ability to modify events on *OSX*. This allows intercepting and\n altering input events before they reach other applications.\n* Corrected crash on *OSX* when some types of third party input sources are\n installed.\n\n\nv1.2 (2017-01-06) - Improved error handling\n-------------------------------------------\n* Allow catching exceptions thrown from listener callbacks. This changes the\n API, as joining a listener now potentially raises unhandled exceptions,\n and unhandled exceptions will stop listeners.\n* Added support for the numeric keypad on *Linux*.\n* Improved documentation.\n* Thanks to *jollysean* and *gilleswijnker* for their input!\n\n\nv1.1.7 (2017-01-02) - Handle middle button on Windows\n-----------------------------------------------------\n* Listen for and dispatch middle button mouse clicks on *Windows*.\n\n\nv1.1.6 (2016-11-24) - Corrected context manager for pressing keys\n-----------------------------------------------------------------\n* Corrected bug in ``pynput.keyboard.Controller.pressed`` which caused it to\n never release the key. Many thanks to Toby Southwell!\n\n\nv1.1.5 (2016-11-17) - Corrected modifier key combinations on Linux\n------------------------------------------------------------------\n* Corrected handling of modifier keys to allow them to be composable on\n *Linux*.\n\n\nv1.1.4 (2016-10-30) - Small bugfixes\n------------------------------------\n* Corrected error generation when ``GetKeyboardState`` fails.\n* Make sure to apply shift state to borrowed keys on *X*.\n* Use *pylint*.\n\n\nv1.1.3 (2016-09-27) - Changed Xlib backend library\n--------------------------------------------------\n* Changed *Xlib* library.\n\n\nv1.1.2 (2016-09-26) - Added missing type for Python 2\n-----------------------------------------------------\n* Added missing ``LPDWORD`` for *Python 2* on *Windows*.\n\n\nv1.1.1 (2016-09-26) - Fixes for listeners and controllers on Windows\n--------------------------------------------------------------------\n* Corrected keyboard listener on *Windows*. Modifier keys and other keys\n changing the state of the keyboard are now handled correctly.\n* Corrected mouse click and release on *Windows*.\n* Corrected code samples.\n\n\nv1.1 (2016-06-22) - Simplified usage on Linux\n---------------------------------------------\n* Propagate import errors raised on Linux to help troubleshoot missing\n ``Xlib`` module.\n* Declare ``python3-xlib`` as dependency on *Linux* for *Python 3*.\n\n\nv1.0.6 (2016-04-19) - Universal wheel\n-------------------------------------\n* Make sure to build a universal wheel for all python versions.\n\n\nv1.0.5 (2016-04-11) - Fixes for dragging on OSX\n-----------------------------------------------\n* Corrected dragging on *OSX*.\n* Added scroll speed constant for *OSX* to correct slow scroll speed.\n\n\nv1.0.4 (2016-04-11) - Fixes for clicking and scrolling on Windows\n-----------------------------------------------------------------\n* Corrected name of mouse input field when sending click and scroll events.\n\n\nv1.0.3 (2016-04-05) - Fixes for Python 3 on Windows\n---------------------------------------------------\n* Corrected use of ``ctypes`` on Windows.\n\n\nv1.0.2 (2016-04-03) - Fixes for thread identifiers\n--------------------------------------------------\n* Use thread identifiers to identify threads, not Thread instances.\n\n\nv1.0.1 (2016-04-03) - Fixes for Python 3\n----------------------------------------\n* Corrected bugs which prevented the library from being used on *Python 3*.\n\n\nv1.0 (2016-02-28) - Stable Release\n----------------------------------\n* Changed license to *LGPL*.\n* Corrected minor bugs and inconsistencies.\n* Corrected and extended documentation.\n\n\nv0.6 (2016-02-08) - Keyboard Monitor\n------------------------------------\n* Added support for monitoring the keyboard.\n* Corrected wheel packaging.\n* Corrected deadlock when stopping a listener in some cases on *X*.\n* Corrected key code constants on *Mac OSX*.\n* Do not intercept events on *Mac OSX*.\n\n\nv0.5.1 (2016-01-26) - Do not die on dead keys\n---------------------------------------------\n* Corrected handling of dead keys.\n* Corrected documentation.\n\n\nv0.5 (2016-01-18) - Keyboard Modifiers\n--------------------------------------\n* Added support for modifiers.\n\n\nv0.4 (2015-12-22) - Keyboard Controller\n---------------------------------------\n* Added keyboard controller.\n\n\nv0.3 (2015-12-22) - Cleanup\n---------------------------\n* Moved ``pynput.mouse.Controller.Button`` to top-level.\n\n\nv0.2 (2015-10-28) - Initial Release\n-----------------------------------\n* Support for controlling the mouse on *Linux*, *Mac OSX* and *Windows*.\n* Support for monitoring the mouse on *Linux*, *Mac OSX* and *Windows*.\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "Monitor and control user input devices",
"version": "1.7.7",
"project_urls": {
"Homepage": "https://github.com/moses-palmer/pynput"
},
"split_keywords": [
"control mouse",
" mouse input",
" control keyboard",
" keyboard input"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef1dfdef3fdc9dc8dedc65898c8ad0e8922a914bb89c5308887e45f9aafaec36",
"md5": "fe67cdca125445d1d5dc7f6ebfb877ef",
"sha256": "afc43f651684c98818de048abc76adf9f2d3d797083cb07c1f82be764a2d44cb"
},
"downloads": -1,
"filename": "pynput-1.7.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe67cdca125445d1d5dc7f6ebfb877ef",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 90243,
"upload_time": "2024-05-10T13:30:04",
"upload_time_iso_8601": "2024-05-10T13:30:04.238607Z",
"url": "https://files.pythonhosted.org/packages/ef/1d/fdef3fdc9dc8dedc65898c8ad0e8922a914bb89c5308887e45f9aafaec36/pynput-1.7.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 13:30:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moses-palmer",
"github_project": "pynput",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pynput"
}
JSON
