arjuna.tpi.guiauto.model.gui module

class arjuna.tpi.guiauto.model.gui.Gui(*, gns_dir: str = None, config: Configuration = None, ext_config: AutomatorExtendedConfig = None, label: str = None)

Bases: arjuna.tpi.engine.asserter.AsserterMixIn

Represents a GUI.

This is the base class for GuiApp, GuiPage, GuiSection and GuiDialog

Keyword Arguments:
 
  • config – Configuration object.
  • ext_config – (Not Supported Yet) AutomatorExtendedConfig object for underlying GUI automator.
  • label – Label for the GuiApp. If not provided, the class name is used as the label.
  • gns_dir – Relative Root Directory for GNS file(s) associated with the GuiApp. Default is <ProjectRootDirectory>/guiauto/namespace. If provided, it is considered relative to the namespace directory.
config

Configuration associated with this GUI.

ext_config

AutomatorExtendedConfig associated with this GUI.

gns_dir

GNS Root Directory.

label

Label for this GUI.

name

Class Name of this GUI.

prepare(*args, **kwargs)

Part of Arjuna’s GUI Loading Protocol.

Children can override and write any necessary preparation instructions for GUI.

qual_name

Qualified Name of this GUI.

reach_until()

Part of Arjuna’s GUI Loading Protocol.

Children can override and write any necessary loading instructions for GUI.

validate_readiness()

Part of Arjuna’s GUI Loading Protocol.

Children can override and write any necessary instructions for validating readiness of the GUI.