arjuna.tpi.guiauto.meta.formatter module

class arjuna.tpi.guiauto.meta.formatter.GNSLabelFormatter(gns, **fargs)

Bases: object

Formattter for the GuiWidgetDefinition associated with a GNS Label.

It is not created directly by a test author. Created using .format call of GNS object associated with a Gui.

Parameters:gns – Gui Namespace object
Keyword Arguments:
 **fargs – Arbitrary key-value pairs to format the GuiWidgetDefinition associated with a GNS Label.

Note

Supports . notation for a GuiWidgetLabel just like a GNS object. For example:

fmt.label1
class arjuna.tpi.guiauto.meta.formatter.GuiWidgetDefinitionFormatter(creator, **fargs)

Bases: object

Formattter for a GuiWidgetDefinition created by GuiWidget factory methods.

It is not created directly by a test author. Created using .format call of a Gui or GuiElement.

Parameters:creatorGui or GuiElement
Keyword Arguments:
 **fargs – Arbitrary key-value pairs to format the GuiWidgetDefinition associated with a GNS Label.

Note

Supports all GuiWidget factory method calls:

fmt.element
fmt.multi_element
fmt.dropdown
fmt.radio_group
locate(type='element', **kwargs)

Locate a GuiWidget.

Keyword Arguments:
 
  • type – type of GuiWidget (element, multi_element, dropdown, radio_group)
  • **kwargs – Arbitrary key-value pairs used to construct a GuiWidgetDefinition
Returns:

An object of type GuiWidget. Exact object type depends on the value of type attribute.

Note

The format key-value pairs of this GuiWidgetDefinitionFormatter are used to format the identifiers in the constructed GuiWidgetDefinition.

locator(**kwargs) → arjuna.tpi.guiauto.meta.locator.GuiWidgetDefinition

Create a GuiWidgetDefinition.

Keyword Arguments:
 
  • type – type of GuiWidget (element, multi_element, dropdown, radio_group)
  • **kwargs – Arbitrary key-value pairs used to construct a GuiWidgetDefinition
Returns:

A GuiWidgetDefinition as per the arguments to this call and format arugments of this GuiWidgetDefinitionFormatter.

Note

The format key-value pairs of this GuiWidgetDefinitionFormatter are used to format the identifiers in the constructed GuiWidgetDefinition.