Configurator API Usage

This doc shows how Snippet UiAutomator implements the Configurator to configure UiAutomator.

Flag

The flag is a bitmask that can be used to control the behavior of the UiAutomator instance.

configurator = uiautomator.Configurator(
    flags=[
        uiautomator.Flag.FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES,
    ]
)
ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME,
    uiautomator.UiAutomatorService,
    uiautomator.UiAutomatorConfigs(configurator=configurator),
)

Timeout

By default, Snippet UiAutomator will set wait_for_idle to 0 seconds, which means there will be no waiting for the user interface to go into an idle state before starting a uiautomator action.

Timeouts can be also customized via passing datetime.timedelta.

configurator = uiautomator.Configurator(
    timeout=uiautomator.Timeout(
        wait_for_idle=datetime.timedelta(seconds=0),
    )
)
ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME,
    uiautomator.UiAutomatorService,
    uiautomator.UiAutomatorConfigs(configurator=configurator),
)

Tool Type

The tool type is the way used to interact with the device's UI. The possible tool types are:

configurator = uiautomator.Configurator(
    tool_type=uiautomator.ToolType.TOOL_TYPE_FINGER
)
ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME,
    uiautomator.UiAutomatorService,
    uiautomator.UiAutomatorConfigs(configurator=configurator),
)

Raise Error

By default, Snippet UiAutomator uses a Boolean value to indicate whether an operation is successful or not.

This behavior can be changed to raise an errors.UiObjectSearchError in exists, wait.exists, and wait.gone APIs.

Example Traceback

Details: [AndroidDevice|GOOG1234567890] Not found Selector{'res': 'X', 'enabled': False}
Traceback (most recent call last):
  File "/mobly/base_test.py", line 783, in exec_one_test
    test_method()
  File "/tests/uiobject2_test.py", line 50, in test_exists_when_target_not_exists_and_raised
    if self.ad.ui(res='X', enabled=False).exists:
  File "/snippet_uiautomator/uiobject2.py", line 534, in exists
    raise errors.UiObjectSearchError(
snippet_uiautomator.errors.UiObjectSearchError: [AndroidDevice|GOOG1234567890] Not found Selector{'res': 'X', 'enabled': False}

  • Set up when launched

    ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME,
    uiautomator.UiAutomatorService,
    uiautomator.UiAutomatorConfigs(raise_error=True),
)

  • Change setting after launched

    ad.ui.raise_error = True

  • One-time setting when calling API

    Note: Not support for exists API.

    ad.ui(...).wait.exists(timeout, raise_error=True)
ad.ui(...).wait.gone(timeout, raise_error=True)

Skip Installing

By default, Snippet UiAutomator will install its latest apk. This process can be skipped if Snippet UiAutomator is wrapped to your own apk and has already installed to the phone.

ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME,
    uiautomator.UiAutomatorService,
    uiautomator.UiAutomatorConfigs(skip_installing=True),
)