Take full control of your mouse with this small Python library. Hook global events, register hotkeys, simulate mouse movement and clicks, and much more.
Huge thanks to Kirill Pavlov for donating the package name. If you are looking for the Cheddargetter.com client implementation, pip install mouse==0.5.0.
- Global event hook on all mice devices (captures events regardless of focus).
- Listen and sends mouse events.
- Works with Windows and Linux (requires sudo).
- Works with MacOS (requires granting accessibility permissions to terminal/python in System Preferences -> Security & Privacy)
- Pure Python, no C modules to be compiled.
- Zero dependencies on Windows and Linux. Trivial to install and deploy, just copy the files.
- Python 2 and 3.
- Includes high level API (e.g. record and play.
- Events automatically captured in separate thread, doesn't block main program.
- Tested and documented.
This program makes no attempt to hide itself, so don't use it for keyloggers.
Install the PyPI package:
$ sudo pip install mouse
or clone the repository (no installation required, source files are sufficient):
$ git clone https://github.com/boppreh/mouse
Then check the API docs to see what features are available.
- Events generated under Windows don't report device id (
event.device == None). #21 - To avoid depending on X the Linux parts reads raw device files (
/dev/input/input*) but this requires root. - Other applications, such as some games, may register hooks that swallow all key events. In this case
mousewill be unable to report events.
- mouse.ButtonEvent
- mouse.DOUBLE
- mouse.DOWN
- mouse.LEFT
- mouse.MIDDLE
- mouse.MoveEvent
- mouse.RIGHT
- mouse.UP
- mouse.WheelEvent
- mouse.X
- mouse.X2
- mouse.version
- mouse.is_pressed
- mouse.press (aliases:
hold) - mouse.release
- mouse.click
- mouse.double_click
- mouse.right_click
- mouse.wheel
- mouse.move
- mouse.drag
- mouse.on_button
- mouse.on_click
- mouse.on_double_click
- mouse.on_right_click
- mouse.on_middle_click
- mouse.wait
- mouse.get_position
- mouse.hook
- mouse.unhook
- mouse.unhook_all
- mouse.record
- mouse.play (aliases:
replay)
ButtonEvent(event_type, button, time)
Alias for field number 1
Return number of occurrences of value.
Alias for field number 0
Return first index of value.
Raises ValueError if the value is not present.
Alias for field number 2
= 'double'= 'down'= 'left'= 'middle'MoveEvent(x, y, time)
Return number of occurrences of value.
Return first index of value.
Raises ValueError if the value is not present.
Alias for field number 2
Alias for field number 0
Alias for field number 1
= 'right'= 'up'WheelEvent(delta, time)
Return number of occurrences of value.
Alias for field number 0
Return first index of value.
Raises ValueError if the value is not present.
Alias for field number 1
= 'x'= 'x2'= '0.7.1'Returns True if the given button is currently pressed.
Presses the given button (but doesn't release).
Releases the given button.
Sends a click with the given button.
Sends a double click with the given button.
Sends a right click with the given button.
Scrolls the wheel delta clicks. Sign indicates direction.
Moves the mouse. If absolute, to position (x, y), otherwise move relative
to the current position. If duration is non-zero, animates the movement.
The fps of the animation is determined by 'steps_per_second', default is 120.
Holds the left mouse button, moving from start to end position, then
releases. absolute and duration are parameters regarding the mouse
movement.
mouse.on_button(callback, args=(), buttons=('left', 'middle', 'right', 'x', 'x2'), types=('up', 'down', 'double'))
Invokes callback with args when the specified event happens.
Invokes callback with args when the left button is clicked.
Invokes callback with args when the left button is double clicked.
Invokes callback with args when the right button is clicked.
Invokes callback with args when the middle button is clicked.
Blocks program execution until the given button performs an event.
Returns the (x, y) mouse position.
Installs a global listener on all available mouses, invoking callback
each time it is moved, a key status changes or the wheel is spun. A mouse
event is passed as argument, with type either mouse.ButtonEvent,
mouse.WheelEvent or mouse.MoveEvent.
Returns the given callback for easier development.
Removes a previously installed hook.
Removes all hooks registered by this application. Note this may include
hooks installed by high level functions, such as record.
Records all mouse events until the user presses the given button.
Then returns the list of events recorded. Pairs well with play(events).
Note: this is a blocking function.
Note: for more details on the mouse hook and events see hook.
Plays a sequence of recorded events, maintaining the relative time
intervals. If speed_factor is <= 0 then the actions are replayed as fast
as the OS allows. Pairs well with record().
The parameters include_* define if events of that type should be included
in the replay or ignored.
