def dragMouse(x, y, button, duration): width, height = platformModule._size() startx, starty = platformModule._position() # None values means "use current position". Convert x and y to ints. x = startx if x is None else int(x) y = starty if y is None else int(y) # Make sure x and y are within the screen bounds. if x < 0: x = 0 elif x >= width: x = width - 1 if y < 0: y = 0 elif y >= height: y = height - 1 segments = max(width, height) timeSegment = float(duration) / segments while timeSegment < 0.05: # if timeSegment is too short, let's decrease the amount we divide it by. Otherwise the time.sleep() will be a no-op and the mouse cursor moves there instantly. segments = int(segments * 0.9) # decrease segments by 90%. timeSegment = float(duration) / segments for n in range(segments): time.sleep(timeSegment) pointOnLine = linear(float(n) / segments) tweenX, tweenY = getPointOnLine(startx, starty, x, y, pointOnLine) tweenX, tweenY = int(tweenX), int(tweenY) # only OS X needs the drag event specifically platformModule._dragTo(tweenX, tweenY, button) # Ensure that no matter what the tween function returns, the mouse ends up # at the final destination. platformModule._dragTo(x, y, button)
def dragRel(xOffset=0,
yOffset=0,
duration=0.0,
tween=linear,
button='left',
pause=None,
_pause=True):
"""Performs a mouse drag (mouse movement while a button is held down) to a
point on the screen, relative to its current position.
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default. If tuple, this is used for xOffset and yOffset.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
button (str, int, optional): The mouse button clicked. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
"""
if xOffset is None:
xOffset = 0
if yOffset is None:
yOffset = 0
if type(xOffset) in (tuple, list):
xOffset, yOffset = xOffset[0], xOffset[1]
if xOffset == 0 and yOffset == 0:
return # no-op case
_failSafeCheck()
mousex, mousey = platformModule._position()
mouseDown(button=button, _pause=False)
_mouseMoveDragTo('drag', mousex + xOffset, mousey + yOffset, duration,
tween, button)
mouseUp(button=button, _pause=False)
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def moveRel(xOffset=0,
yOffset=0,
duration=0.0,
tween=linear,
pause=None,
_pause=True):
"""Moves the mouse cursor to a point on the screen, relative to its current
position.
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default. If tuple, this is used for x and y.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
Returns:
None
"""
# This may seem silly, but I wanted the user to be able to pass None for
# an argument just so that it is consistent with moveTo().
if xOffset is None:
xOffset = 0
if yOffset is None:
yOffset = 0
if type(xOffset) in (tuple, list):
xOffset, yOffset = xOffset[0], xOffset[1]
if xOffset == 0 and yOffset == 0:
return # no-op case
_failSafeCheck()
mousex, mousey = platformModule._position()
moveTo(mousex + xOffset, mousey + yOffset, duration, tween, _pause=False)
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def mouseDown(x=None,
y=None,
button='left',
duration=0.0,
tween=linear,
pause=None,
_pause=True):
"""Performs pressing a mouse button down (but not up).
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): The x position on the screen where the
mouse down happens. None by default. If tuple, this is used for x and y.
y (int, float, None, optional): The y position on the screen where the
mouse down happens. None by default.
button (str, int, optional): The mouse button pressed down. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
Raises:
ValueError: If button is not one of 'left', 'middle', 'right', 1, 2, or 3
"""
if button not in ('left', 'middle', 'right', 1, 2, 3):
raise ValueError(
"button argument must be one of ('left', 'middle', 'right', 1, 2, 3), not %s"
% button)
if type(x) in (tuple, list):
x, y = x[0], x[1]
x, y = position(x, y)
_failSafeCheck()
moveTo(x, y, _pause=False)
x, y = platformModule._position(
) # TODO - this isn't right. We need to check the params.
if button == 1 or str(button).lower() == 'left':
platformModule._mouseDown(x, y, 'left')
elif button == 2 or str(button).lower() == 'middle':
platformModule._mouseDown(x, y, 'middle')
elif button == 3 or str(button).lower() == 'right':
platformModule._mouseDown(x, y, 'right')
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def dragRel(xOffset=0, yOffset=0, duration=0.0, tween=linear, button='left', pause=None, _pause=True):
"""Performs a mouse drag (mouse movement while a button is held down) to a
point on the screen, relative to its current position.
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default. If tuple, this is used for xOffset and yOffset.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
button (str, int, optional): The mouse button clicked. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
"""
if xOffset is None:
xOffset = 0
if yOffset is None:
yOffset = 0
if type(xOffset) in (tuple, list):
xOffset, yOffset = xOffset[0], xOffset[1]
if xOffset == 0 and yOffset == 0:
return # no-op case
_failSafeCheck()
mousex, mousey = platformModule._position()
mouseDown(button=button, _pause=False)
_mouseMoveDragTo('drag', mousex + xOffset, mousey + yOffset, duration, tween, button)
mouseUp(button=button, _pause=False)
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def moveRel(xOffset=0, yOffset=0, duration=0.0, tween=linear, pause=None, _pause=True):
"""Moves the mouse cursor to a point on the screen, relative to its current
position.
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default. If tuple, this is used for x and y.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
Returns:
None
"""
# This may seem silly, but I wanted the user to be able to pass None for
# an argument just so that it is consistent with moveTo().
if xOffset is None:
xOffset = 0
if yOffset is None:
yOffset = 0
if type(xOffset) in (tuple, list):
xOffset, yOffset = xOffset[0], xOffset[1]
if xOffset == 0 and yOffset == 0:
return # no-op case
_failSafeCheck()
mousex, mousey = platformModule._position()
moveTo(mousex + xOffset, mousey + yOffset, duration, tween, _pause=False)
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def mouseUp(x=None, y=None, button='left', duration=0.0, tween=linear, pause=None, _pause=True):
"""Performs releasing a mouse button up (but not down beforehand).
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, tuple, optional): The x position on the screen where the
mouse up happens. None by default. If tuple, this is used for x and y.
y (int, float, None, optional): The y position on the screen where the
mouse up happens. None by default.
button (str, int, optional): The mouse button released. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
Raises:
ValueError: If button is not one of 'left', 'middle', 'right', 1, 2, or 3
"""
if button not in ('left', 'middle', 'right', 1, 2, 3):
raise ValueError("button argument must be one of ('left', 'middle', 'right', 1, 2, 3), not %s" % button)
if type(x) in (tuple, list):
x, y = x[0], x[1]
x, y = position(x, y)
_failSafeCheck()
moveTo(x, y, _pause=False)
x, y = platformModule._position()
if button == 1 or str(button).lower() == 'left':
platformModule._mouseUp(x, y, 'left')
elif button == 2 or str(button).lower() == 'middle':
platformModule._mouseUp(x, y, 'middle')
elif button == 3 or str(button).lower() == 'right':
platformModule._mouseUp(x, y, 'right')
if pause is not None and _pause:
time.sleep(pause)
elif _pause and PAUSE != 0:
time.sleep(PAUSE)
def position(x=None, y=None):
"""Returns the current xy coordinates of the mouse cursor as a two-integer
tuple.
Args:
x (int, None, optional) - If not None, this argument overrides the x in
the return value.
y (int, None, optional) - If not None, this argument overrides the y in
the return value.
Returns:
(x, y) tuple of the current xy coordinates of the mouse cursor.
"""
posx, posy = platformModule._position()
posx = int(posx)
posy = int(posy)
if x is not None:
posx = int(x)
if y is not None:
posy = int(y)
return posx, posy
def position(x=None, y=None):
"""Returns the current xy coordinates of the mouse cursor as a two-integer
tuple.
Args:
x (int, None, optional) - If not None, this argument overrides the x in
the return value.
y (int, None, optional) - If not None, this argument overrides the y in
the return value.
Returns:
(x, y) tuple of the current xy coordinates of the mouse cursor.
"""
posx, posy = platformModule._position()
posx = int(posx)
posy = int(posy)
if x is not None:
posx = int(x)
if y is not None:
posy = int(y)
return posx, posy
def mouseDown(x=None, y=None, button='left', _pause=True):
"""Performs pressing a mouse button down (but not up).
The x and y parameters detail where the mouse event happens. If None, the
current mouse position is used. If a float value, it is rounded down. If
outside the boundaries of the screen, the event happens at edge of the
screen.
Args:
x (int, float, None, optional): The x position on the screen where the
mouse down happens. None by default.
y (int, float, None, optional): The y position on the screen where the
mouse down happens. None by default.
button (str, int, optional): The mouse button pressed down. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
Raises:
ValueError: If button is not one of 'left', 'middle', 'right', 1, 2, or 3
"""
if button not in ('left', 'middle', 'right', 1, 2, 3):
raise ValueError("button argument must be one of ('left', 'middle', 'right', 1, 2, 3), not %s" % button)
x, y = position(x, y)
_failSafeCheck()
moveTo(x, y, _pause=False)
x, y = platformModule._position() # TODO - this isn't right. We need to check the params.
if button == 1 or str(button).lower() == 'left':
platformModule._mouseDown(x, y, 'left')
elif button == 2 or str(button).lower() == 'middle':
platformModule._mouseDown(x, y, 'middle')
elif button == 3 or str(button).lower() == 'right':
platformModule._mouseDown(x, y, 'right')
if _pause and PAUSE != 0:
time.sleep(PAUSE)
def _mouseMoveDragTo(moveOrDrag, x, y, duration, tween, button=None):
"""Handles the actual move or drag event, since different platforms
implement them differently.
On Windows & Linux, a drag is a normal mouse move while a mouse button is
held down. On OS X, a distinct "drag" event must be used instead.
The code for moving and dragging the mouse is similar, so this function
handles both. Users should call the moveTo() or dragTo() functions instead
of calling _mouseMoveDragTo().
Args:
moveOrDrag (str): Either 'move' or 'drag', for the type of action this is.
x (int, float, None, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
button (str, int, optional): The mouse button clicked. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
"""
# The move and drag code is similar, but OS X requires a special drag event instead of just a move event when dragging.
# See https://stackoverflow.com/a/2696107/1893164
assert moveOrDrag in ('move', 'drag'), "moveOrDrag must be in ('move', 'drag'), not %s" % (moveOrDrag)
if sys.platform != 'darwin':
moveOrDrag = 'move' # only OS X needs to use the drag
if x is None and y is None:
return # special case for no mouse movement at all
x, y = position(x, y)
width, height = platformModule._size()
startx, starty = platformModule._position()
# None values means "use current position". Convert x and y to ints.
x = startx if x is None else int(x)
y = starty if y is None else int(y)
# Make sure x and y are within the screen bounds.
if x < 0:
x = 0
elif x >= width:
x = width - 1
if y < 0:
y = 0
elif y >= height:
y = height - 1
_failSafeCheck()
# If the duration is small enough, just move the cursor there instantly.
if duration <= MINIMUM_DURATION:
if moveOrDrag == 'move':
platformModule._moveTo(x, y)
else:
platformModule._dragTo(x, y, button)
return
# Non-instant moving/dragging involves tweening:
segments = max(width, height)
timeSegment = duration / segments
while timeSegment < 0.05: # if timeSegment is too short, let's decrease the amount we divide it by. Otherwise the time.sleep() will be a no-op and the mouse cursor moves there instantly.
segments = int(segments * 0.9) # decrease segments by 90%.
timeSegment = duration / segments
for n in range(segments):
time.sleep(timeSegment)
_failSafeCheck()
pointOnLine = tween(n / segments)
tweenX, tweenY = getPointOnLine(startx, starty, x, y, pointOnLine)
tweenX, tweenY = int(tweenX), int(tweenY)
if moveOrDrag == 'move':
platformModule._moveTo(tweenX, tweenY)
else:
# only OS X needs the drag event specifically
platformModule._dragTo(tweenX, tweenY, button)
# Ensure that no matter what the tween function returns, the mouse ends up
# at the final destination.
if moveOrDrag == 'move':
platformModule._moveTo(x, y)
else:
platformModule._dragTo(x, y, button)
_failSafeCheck()
def _mouseMoveDragTo(moveOrDrag, x, y, duration, tween, button=None):
"""Handles the actual move or drag event, since different platforms
implement them differently.
On Windows & Linux, a drag is a normal mouse move while a mouse button is
held down. On OS X, a distinct "drag" event must be used instead.
The code for moving and dragging the mouse is similar, so this function
handles both. Users should call the moveTo() or dragTo() functions instead
of calling _mouseMoveDragTo().
Args:
moveOrDrag (str): Either 'move' or 'drag', for the type of action this is.
x (int, float, None, optional): How far left (for negative values) or
right (for positive values) to move the cursor. 0 by default.
y (int, float, None, optional): How far up (for negative values) or
down (for positive values) to move the cursor. 0 by default.
duration (float, optional): The amount of time it takes to move the mouse
cursor to the new xy coordinates. If 0, then the mouse cursor is moved
instantaneously. 0.0 by default.
tween (func, optional): The tweening function used if the duration is not
0. A linear tween is used by default. See the tweens.py file for
details.
button (str, int, optional): The mouse button clicked. Must be one of
'left', 'middle', 'right' (or 1, 2, or 3) respectively. 'left' by
default.
Returns:
None
"""
# The move and drag code is similar, but OS X requires a special drag event instead of just a move event when dragging.
# See https://stackoverflow.com/a/2696107/1893164
assert moveOrDrag in (
'move', 'drag'
), "moveOrDrag must be in ('move', 'drag'), not %s" % (moveOrDrag)
if sys.platform != 'darwin':
moveOrDrag = 'move' # only OS X needs to use the drag
if x is None and y is None:
return # special case for no mouse movement at all
x, y = position(x, y)
width, height = platformModule._size()
startx, starty = platformModule._position()
# None values means "use current position". Convert x and y to ints.
x = startx if x is None else int(x)
y = starty if y is None else int(y)
# Make sure x and y are within the screen bounds.
if x < 0:
x = 0
elif x >= width:
x = width - 1
if y < 0:
y = 0
elif y >= height:
y = height - 1
_failSafeCheck()
# If the duration is small enough, just move the cursor there instantly.
if duration <= MINIMUM_DURATION:
if moveOrDrag == 'move':
platformModule._moveTo(x, y)
else:
platformModule._dragTo(x, y, button)
return
# Non-instant moving/dragging involves tweening:
segments = max(width, height)
timeSegment = float(duration) / segments
while timeSegment < 0.05: # if timeSegment is too short, let's decrease the amount we divide it by. Otherwise the time.sleep() will be a no-op and the mouse cursor moves there instantly.
segments = int(segments * 0.9) # decrease segments by 90%.
timeSegment = float(duration) / segments
for n in range(segments):
time.sleep(timeSegment)
_failSafeCheck()
pointOnLine = tween(float(n) / segments)
tweenX, tweenY = getPointOnLine(startx, starty, x, y, pointOnLine)
tweenX, tweenY = int(tweenX), int(tweenY)
if moveOrDrag == 'move':
platformModule._moveTo(tweenX, tweenY)
else:
# only OS X needs the drag event specifically
platformModule._dragTo(tweenX, tweenY, button)
# Ensure that no matter what the tween function returns, the mouse ends up
# at the final destination.
if moveOrDrag == 'move':
platformModule._moveTo(x, y)
else:
platformModule._dragTo(x, y, button)
_failSafeCheck()
