pynput 0.5.1

Monitor and control user input devices

pynput

This library allows you to control and monitor input devices.

Currently, mouse input and monitoring, and keyboard input are supported.

Controlling the mouse

Use pynput.mouse.Controller like this:

from pynput.mouse import Button, Controller, Listener

d = Controller()

# Read pointer position
print('The current pointer position is {0}'.format(
    d.position))

# Set pointer position
d.position = (10, 20)
print('Now we have moved it to {0}'.format(
    d.position))

# Move pointer relative to current position
d.move(5, -5)

# Press and release
d.press(Button.left)
d.release(Button.left)

# Double click; this is different from pressing and releasing twice on Mac
# OSX
d.click(Button.left, 2)

# Scroll two steps down
d.scroll(0, 2)

Monitoring the mouse

Use pynput.mouse.Listener like this:

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(dx, dy):
    print('Scrolled {0}'.format(
        (x, y)))

# Collect events until released
with Listener(
        on_move=on_move,
        on_click=on_click,
        on_scroll=on_scroll) as l:
    l.join()

A mouse listener is a threading.Thread, and all callbacks will be invoked from the thread.

Call pynput.mouse.Listener.stop from anywhere, or raise pynput.mouse.Listener.StopException or return False from a callback to stop the listener.

Release Notes

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.