Camel.toolkits.pyautogui toolkit

​

PyAutoGUIToolkit

class PyAutoGUIToolkit(BaseToolkit):

​

init

def __init__(
    self,
    timeout: Optional[float] = None,
    screenshots_dir: str = 'tmp'
):

• timeout (Optional[float]): Timeout for API requests in seconds. (default: :obj:None)
• screenshots_dir (str): Directory to save screenshots. (default: :obj:"tmp")

​

_get_safe_coordinates

def _get_safe_coordinates(self, x: int, y: int):

• x (int): Original x-coordinate
• y (int): Original y-coordinate

​

mouse_move

def mouse_move(self, x: int, y: int):

• x (int): X-coordinate to move to.
• y (int): Y-coordinate to move to.

​

mouse_click

def mouse_click(
    self,
    button: Literal['left', 'middle', 'right'] = 'left',
    clicks: int = 1,
    x: Optional[int] = None,
    y: Optional[int] = None
):

• button (Literal["left", "middle", "right"]): The mouse button to click. - “left”: Typically used for selecting items, activating buttons, or placing the cursor. - “middle”: Often used for opening links in a new tab or specific application functions. - “right”: Usually opens a context menu providing options related to the clicked item or area. (default: :obj:"left")
• clicks (int): The number of times to click the button. - 1: A single click, the most common action. - 2: A double-click, often used to open files/folders or select words. (default: :obj:1)
• x (Optional[int]): The x-coordinate on the screen to move the mouse to before clicking. If None, clicks at the current mouse position. (default: :obj:None)
• y (Optional[int]): The y-coordinate on the screen to move the mouse to before clicking. If None, clicks at the current mouse position. (default: :obj:None)

​

get_mouse_position

def get_mouse_position(self):

​

take_screenshot

def take_screenshot(self):

​

mouse_drag

def mouse_drag(
    self,
    start_x: int,
    start_y: int,
    end_x: int,
    end_y: int,
    button: Literal['left', 'middle', 'right'] = 'left'
):

• start_x (int): Starting x-coordinate.
• start_y (int): Starting y-coordinate.
• end_x (int): Ending x-coordinate.
• end_y (int): Ending y-coordinate.
• button (Literal["left", "middle", "right"]): Mouse button to use (‘left’, ‘middle’, ‘right’). (default: :obj:'left')

​

scroll

def scroll(
    self,
    scroll_amount: int,
    x: Optional[int] = None,
    y: Optional[int] = None
):

• scroll_amount (int): Amount to scroll. Positive values scroll up, negative values scroll down.
• x (Optional[int]): X-coordinate to scroll at. If None, uses current position. (default: :obj:None)
• y (Optional[int]): Y-coordinate to scroll at. If None, uses current position. (default: :obj:None)

​

keyboard_type

def keyboard_type(self, text: str, interval: float = 0.0):

• text (str): Text to type.
• interval (float): Seconds to wait between keypresses. (default: :obj:0.0)

​

press_key

def press_key(self, key: Union[str, List[str]]):

• key (Union[str, List[str]]): The key to be pressed. Can also be a list of such strings. Valid key names include: - Basic characters: a-z, 0-9, and symbols like !, @, #, etc. - Special keys: enter, esc, space, tab, backspace, delete - Function keys: f1-f24 - Navigation: up, down, left, right, home, end, pageup, pagedown - Modifiers: shift, ctrl, alt, command, option, win - Media keys: volumeup, volumedown, volumemute, playpause

​

hotkey

def hotkey(self, keys: List[str]):

• keys (List[str]): The series of keys to press, in order. This can be either: - Multiple string arguments, e.g., hotkey(‘ctrl’, ‘c’) - A single list of strings, e.g., hotkey([‘ctrl’, ‘c’])

​

get_tools

def get_tools(self):