A helper function that creates a screenshot to act as a logging mechanism. When a PyAutoGUI function is called, this function is also called

Handles the actual move or drag event, since different platforms implement them differently. On Windows & Linux, a drag is a normal mouse mov

Returns a ``Point`` object based on ``firstArg`` and ``secondArg``, which are the first two arguments passed to several PyAutoGUI functions.

Performs pressing a mouse button down and then immediately releasing it. Returns ``None``. When no arguments are passed, the primary mouse b

Returns the current xy coordinates of the mouse cursor as a two-integer tuple. Args: x (int, None, optional) - If not None, this argum

Gets the number token at the start of commandStr. Given '5hello' returns '5' Given ' 5hello' returns ' 5' Given '-42hello' returns '-42

The helper function that actually makes the call to the mouse_event() win32 function. Args: ev (int): The win32 code for the mouse even

The left, middle, and right mouse buttons are button numbers 1, 2, and 3 respectively. This is the numbering that Xlib on Linux uses (while W

Returns the width and height of the screen as a two-integer tuple. Returns: (width, height) tuple of the screen size, in pixels.

Send the mouse vertical scroll event to Windows by calling the mouse_event() win32 function. Args: clicks (int): The amount of scrollin

Returns the width and height of the screen as a two-integer tuple. Returns: (width, height) tuple of the screen size, in pixels.

Helper method for special keys. Source: http://stackoverflow.com/questions/11045814/emulate-media-key-press-on-mac

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 p

Performs releasing a mouse button up (but not down beforehand). The x and y parameters detail where the mouse event happens. If None, the cur

Performs a keyboard key press down, followed by a release. Args: key (str, list): The key to be pressed. The valid names are listed in

Performs a scroll of the mouse scroll wheel. Whether this is a vertical or horizontal scroll depends on the underlying operating system.

Gets the comma token at the start of commandStr. Given ',' returns ',' Given ' ,', returns ' ,' Raises an exception if a comma isn't f

Gets the command string token at the start of commandStr. It will also be enclosed with parentheses. Given "(ccc)world" returns "(ccc)" G

Gets the quoted string token at the start of commandStr. The quoted string must use single quotes. Given "'hello'world" returns "'hello'"

A helper function for performing a pause at the end of a PyAutoGUI function based on some settings. If ``_pause`` is ``True``, then sleep fo

Returns the current xy coordinates of the mouse cursor as a two-integer tuple by calling the GetCursorPos() win32 function. Returns: (x

Tokenizes commandStr into a list of commands and their arguments for the run() function. Returns the list.

This function is meant to be run from the command line. It will automatically display the location and RGB of the mouse cursor.

Performs a mouse drag (mouse movement while a button is held down) to a point on the screen. The x and y parameters detail where the mouse ev

Returns an (x, y) tuple of the point that has progressed a proportion ``n`` along the line defined by the two ``x1``, ``y1`` and ``x2``, ``y2

Performs key down presses on the arguments passed in order, then performs key releases in reverse order. The effect is that calling hotkey('c

Moves the mouse cursor to a point on the screen. The x and y parameters detail where the mouse event happens. If None, the current mouse posi

Returns whether the given xy coordinates are on the primary screen or not. Note that this function doesn't work for secondary screens. Args:

Send the mouse click event to Windows by calling the mouse_event() win32 function. Args: button (str): The mouse button, either 'left',

This function raises PyAutoGUIException. It's used for the PyGetWindow function names if the PyGetWindow module failed to be

This function raises ``PyAutoGUIException``. It's used for the PyMsgBox function names if the PyMsgbox module failed to be imported.

This function raises ``PyAutoGUIException``. It's used for the PyScreeze function names if the PyScreeze module failed to be imported

This function raises ``PyAutoGUIException``. It's used for the PyTweening function names if the PyTweening module failed to be import

A decorator that calls failSafeCheck() before the decorated function and _handlePause() after it.

Send the mouse horizontal scroll event to Windows by calling the mouse_event() win32 function. Args: clicks (int): The amount of scroll

Performs a keyboard key press without the release. This will put that key in a held down state. NOTE: For some reason, this does not seem to

Performs a keyboard key press without the release. This will put that key in a held down state. NOTE: For some reason, this does not seem to

Performs a keyboard key release (without the press down beforehand). Args: key (str): The key to be released up. The valid names are listed

Performs a keyboard key release (without the press down beforehand). Args: key (str): The key to be released up. The valid names are listed

Send the mouse down event to Windows by calling the mouse_event() win32 function. Args: x (int): The x position of the mouse event.

Send the mouse up event to Windows by calling the mouse_event() win32 function. Args: x (int): The x position of the mouse event.

Send the mouse move event to Windows by calling SetCursorPos() win32 function. Args: button (str): The mouse button, either 'left', 'mi

Returns the current xy coordinates of the mouse cursor as a two-integer tuple. Returns: (x, y) tuple of the current xy coordinates of t

A wrapper for _scroll(), which does vertical scrolling. Args: clicks (int): The amount of scrolling to do. A positive value is the mouse

Performs a double click. This is a wrapper function for click('left', x, y, 2, interval). The x and y parameters detail where the mouse even

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 pa

Context manager that performs a keyboard key press down upon entry, followed by a release upon exit. Args: key (str, list): The key to

Performs an explicitly horizontal scroll of the mouse scroll wheel, if this is supported by the operating system. (Currently just Linux.) The

Returns True if the ``character`` is a keyboard key that would require the shift key to be held down, such as uppercase letters or the symbol

Returns a Boolean value if the given key is a valid value to pass to PyAutoGUI's keyboard-related functions for the current platform. This fu

Performs a keyboard key press without the release. This will put that key in a held down state. NOTE: For some reason, this does not seem to