libs.mouse

Lib to control the mouse.

Common

• speed -- the speed of mouse movements in the range 1 (fastest) to 100 (slowest). A speed of 0 will move the mouse instantly. Default speed is 10.

• button -- specifies on which mouse button to perform an action. Posible values are: 1, "l", "left" - for left; 2, "r", "right" - for right; 3, "m", "middle" - for middle. Default is 1.

• Methods suppot chaining.

Supported platforms:

• All (thanks to PyMouse).

Examples

from libs import mouse

# moving:
mouse.move(100, 100)     # move mouse cursor to point (100, 100) with default speed
mouse.speed = 5          # make movements faster by default
mouse.move(200, 200)     # now with `speed` = 5
point1 = (100, 100)      # some "list-point"
mouse.move(point, 50)    # move to `point1` very slow
point2 = [200, 200]      # some "tuple-point"
mouse.move(point2, 0)    # move to `point2` immediately

# imitate drag'n'drop:
mouse.move(item)         # move cursor to item
mouse.down()             # press down left mouse button
mouse.sleep(0.5)         # wait a bit
mouse.move(dest)         # drag item to destination
mouse.up()               # release mouse button

# the same with chaining:
mouse.move(item).down().sleep(0.5).move(dest).up()  # who stole my `mouse.`'s??

# clicks:
mouse.click()            # simple clicking with left mouse button by default
mouse.click("right")     # trigger context menu on some item
mouse.click("r")         # the same
mouse.click(2)           # the same

print mouse.position     # > (340, 685)
print mouse.pos          # > (340, 685)

API

• mouse.speed = 10
  Defines default mouse movement speed. Read & Write property.

• mouse.move(x, y, [speed = 10])
mouse.move(point, [speed = 10])
  Move mouse cursor to a given x, y or point with a given speed.
  Returns self.

• mouse.down([button = "left"])
  Press given mouse button.
  Returns self.

• mouse.up([button = "left"])
  Release given mouse button.
  Returns self.

• mouse.click([button = "left"])
  Click (press & release) given mouse button.
  Returns self.

• mouse.position
mouse.pos
  Get current mouse cursor position on screen in pixels.
  Returns (x, y) - a tuple of 2 integers.
  Read-only property.

• mouse.sleep(seconds)
  Just a handy clone of standart time.sleep() for cozy chaining.
  Returns self.