guibot.guibot_proxy module

SUMMARY

Remote guibot interface for proxy operations using remote visual objects.

Frontend with serialization compatible API allowing the use of PyRO modified guibot.GuiBot object (creating and running the same object remotely and manipulating it locally). All the methods delegate their calls to this object with some additional postprocessing to make the execution remote so for information about the API please refer to it and region.Region.

INTERFACE

guibot.guibot_proxy.serialize_custom_error(class_obj)

Serialization method for the errors.UnsupportedBackendError which was chosen just as a sample.

Parameters:class_obj (classobj) – class object for the serialized error class Returns:serialization dictionary with the class name, arguments, and attributes Return type:{str, str or getset_descriptor or dictproxy}

guibot.guibot_proxy.register_exception_serialization()

We put here any exceptions that are too complicated for the default serialization and define their serialization methods.

Note

This would not be needed if we were using the Pickle serializer but its security problems at the moment made us prefer the serpent serializer paying for it with some extra setup steps and functions below.

class guibot.guibot_proxy.GuiBotProxy(dc=None, cv=None)

Bases: guibot.guibot.GuiBot

The proxy guibot object is just a wrapper around the actual guibot object that takes care of returning easily serializable PyRO proxy objects instead of the real ones or their serialized copies.

It allows you to move the mouse, type text and do any other GuiBot action from code which is executed on another machine somewhere on the network.

__init__(dc=None, cv=None)

Build a proxy guibot object of the original main guibot object.

nearby(rrange=50)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

above(rrange=0)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

below(rrange=0)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

left(rrange=0)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

right(rrange=0)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

find(target, timeout=10)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

find_all(target, timeout=10, allow_zero=False)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

sample(target)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

exists(target, timeout=0)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

wait(target, timeout=30)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

wait_vanish(target, timeout=30)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

hover(target_or_location)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

click(target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

right_click(target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

double_click(target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

multi_click(target_or_location, count=3, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

click_expect(click_image_or_location, expect_image_or_location=None, modifiers=None, timeout=60)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

click_vanish(click_image_or_location, expect_image_or_location=None, modifiers=None, timeout=60)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

click_at_index(anchor, index=0, find_number=3, timeout=10)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

mouse_down(target_or_location, button=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

mouse_up(target_or_location, button=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

mouse_scroll(target_or_location, clicks=10, horizontal=False)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

drag_drop(src_target_or_location, dst_target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

drag_from(target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

drop_at(target_or_location, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

press_keys(keys)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

press_at(target_or_location=None, keys=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

type_text(text, modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

type_at(target_or_location=None, text='', modifiers=None)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

fill_at(anchor, text, dx, dy, del_flag=True, esc_flag=True, mark_clicks=1)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.

select_at(anchor, image_or_index, dx, dy, dw=0, dh=0, ret_flag=True, mark_clicks=1)

See guibot.guibot.GuiBot and its inherited guibot.region.Region for details.