commit	adc13546bd16eb977a91027ff716d0903564fe58	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Wed Apr 30 16:15:30 2025 -0700
committer	Android Build Coastguard Worker <[email protected]>	Wed Apr 30 16:15:30 2025 -0700
tree	e3bdad06d8fd8873f502fe5c255b339513e0a520
parent	c72f4de0b88593a1a616b4b8deeb05d63f7a4835 [diff]
parent	52f456f96a07bc2986fb17618d7bcd180fe01241 [diff]

tree: e3bdad06d8fd8873f502fe5c255b339513e0a520

README.md

Snippet UiAutomator

This is the Python wrapper based on Mobly Snippet Lib for calling the AndroidX UiAutomator APIs.

Requirements

Python 3.7+
Android 8.0+ (SDK 26+)

Installation

pip install snippet-uiautomator

Initial Mobly Android Controller

Inside Mobly Test

To use in a Mobly test, the Android device needs to be initialized in the Mobly base test.

from mobly import base_test
from mobly.controllers import android_device

class MoblyTest(base_test.BaseTestClass):
  def setup_class(self):
    ad = self.register_controller(android_device)[0]

Outside Mobly Test
If not using in a Mobly test, such as when running in a Python terminal, the Android device can be initialized with its serial number.
```
from mobly.controllers import android_device

ad = android_device.AndroidDevice('GOOG1234567890')
```

To learn more about Mobly, visit Getting started with Mobly.

Launch UiAutomator Service

[!WARNING] UiAutomation is a service that can only be used by one app at a time. If this service is already being registered by another app, Snippet UiAutomator will not be able to start. To resolve this issue, stop the app holding the UiAutomation service before calling Snippet UiAutomator.

Snippet UiAutomator supports launching as one of Mobly Android Device Service.

from snippet_uiautomator import uiautomator

ad.services.register(
    uiautomator.ANDROID_SERVICE_NAME, uiautomator.UiAutomatorService
)

ad.ui(text='OK').click()

Test

Run unit tests for Python part:

pytest

Run tests for Snippet part:

cd snippet_uiautomator/android
./gradlew test

Set up pre-commit hooks, this will run some automated checks during each git commit and possibly update some files that require changes:

pip install pre-commit
pre-commit install