cataglyphis/uiautomator2

Android Uiautomator2 Python Wrapper

uiautomator2

该项目正在火热的开发中

uiautomator2 是一个可以使用Python对Android设备进行UI自动化的库。其底层基于Google uiautomator，Google提供的uiautomator库可以获取屏幕上任意一个APP的任意一个控件属性，并对其进行任意操作，但有两个缺点：1. 测试脚本只能使用Java语言 2. 测试脚本必须每次被上传到设备上运行。 我们希望测试能够用一个更脚本化的语言，例如Python编写，同时可以每次所见即所得地修改测试、运行测试。这里要非常感谢 Xiaocong He (@xiaocong)，他将这个想法实现了出来（见xiaocong/uiautomator），原理是在手机上运行了一个http服务器，将uiautomator中的功能开放出来，然后再将这些http接口，封装成Python库。 我们的uiautomator2项目是对xiaocong/uiautomator的增强，主要有以下部分：

• 设备和开发机可以脱离数据线，通过WiFi互联（基于atx-agent）
• 集成了openstf/minicap加快截图速度
• 集成了openstf/minitouch达到精确实时控制设备
• 修复了xiaocong/uiautomator经常性退出的问题
• 代码进行了重构和精简，方便维护

虽然我说的很简单，但是实现起来用到了很多的技术和技巧，功能非常强，唯独文档有点少。哈哈

QQ沟通群: 499563266

Table of contents

• Installation
• Usage
  • Command line
  • Quick start
• API Documents

Installation

1. Install uiautomator2

   # Since uiautomator2 is still under development, you have to add --pre to install the development version
   pip install --pre uiautomator2
   
   # Or you can install directly from github source
   git clone https://github.com/openatx/uiautomator2
   pip install -e uiautomator2

   Optionally, pillow is needed to process screenshot data.

   pip install pillow

2. Deploy associated daemons to a device    电脑连接上一个手机或多个手机, 确保adb已经添加到环境变量中，执行下面的命令会自动安装本库所需要的设备端程序：uiautomator-server 、atx-agent、openstf/minicap、openstf/minitouch

   # init 所有的已经连接到电脑的设备
   python -m uiautomator2 init
   
   # 也可以使用`--serial`可以指定单个设备
   python -m uiautomator2 init --serial $SERIAL

   安装提示success即可

3. Install weditor(UI Inspector)

   因为uiautomator是独占资源，所以当atx运行的时候uiautomatorviewer是不能用的，为了减少atx频繁的启停，我们开发了基于浏览器技术的weditor UI查看器。https://github.com/openatx/weditor

   安装方法

   pip install --pre -U weditor

   Windows系统可以使用命令在桌面创建一个快捷方式 python -m weditor --shortcut

   命令行启动 python -m weditor 会自动打开浏览器，输入设备的ip或者序列号，点击Connect即可。

   具体参考文章：浅谈自动化测试工具python-uiautomator2

Usage

部署 atx-agent之后，设备可以和电脑通过WiFi链接，设备上的atx-agent安装完成后会自动提示手机的IP是多少（模拟器另说）。下文中我们用device_ip这个变量来表示手机的IP，这个IP唯一标示一个设备。

如果手机的WiFi跟电脑不是一个网段的，不能使用WiFi互联功能，需要通过数据线将手机连接到电脑上，使用命令adb forward tcp:7912 tcp:7912 将手机上的服务端口7912转发到电脑上，然后使用device_ip=127.0.0.1连接该手机。

Command line

• init: 为设备安装所需要的程序

• install: 安装apk，apk通过URL给出

  $ python -m uiautomator2 install $device_ip https://example.org/some.apk
  MainThread: 15:37:55,731 downloading 80.4 kB / 770.6 kB
  MainThread: 15:37:56,763 installing 770.6 kB / 770.6 kB
  MainThread: 15:37:58,780 success installed 770.6 kB / 770.6 kB

• clear-cache: 清空缓存

  $ python -m uiautomator2 clear-cache

• app-stop-all: 停止所有应用

  $ python -m uiautomator2 app-stop-all $device_ip

• screenshot: 截图

  $ python -m uiautomator2 screenshot $device_ip screenshot.jpg

• healthcheck: 健康检查

  $ python -m uiautomator2 healthcheck $device_ip

QUICK START

There are two ways to connect to the device. Run the following Python code in a Python 2.7/3+ interpreter:

1. Through WiFi (recommended) Suppose device IP is 10.0.0.1 and your PC is in the same network.

import uiautomator2 as u2

d = u2.connect('10.0.0.1') # alias for u2.connect_wifi('10.0.0.1')
print(d.info)

2. Through USB Suppose the device serial is 123456f (seen from adb devices)

import uiautomator2 as u2

d = u2.connect('123456f') # alias for u2.connect_usb('123456f')
print(d.info)

Calling u2.connect() with no argument, uiautomator2 will obtain device IP from the environment variable ANDROID_DEVICE_IP. If this environment variable is empty, uiautomator will fall back to connect_usb and you need to make sure that there is only one device connected to the computer.

一些常用但是不知道归到什么类里的函数

先中文写着了，国外大佬们先用Google Translate顶着

感觉肯定用得着的资料链接

• Question and Answers (FAQ)
• 浅谈自动化测试工具python-uiautomator2
• weditor 用于查看UI层次结构，方便写脚本用。
• htmlreport 记录测试过程的测试报告（实验性质）

检查并维持设备端守护进程处于运行状态

d.healthcheck()

点击坐标出现偏移

为了提高uiautomator2再有播放器界面不卡死，代码中将默认3000ms中的waitForIdleTimeout改成了0，不过有可能会造成坐标偏移，虽然概率不大。 如果出现这种情况，可以将其调大一点 d.jsonrpc.setConfigurator({"waitForIdleTimeout": 100})

连接本地USB设备

需要设备曾经使用python -m uiautomator2 init初始化过

d = u2.connect_usb("{Your-Device-Serial}")

如何停用UiAutomator的守护程序 How to stop UiAutomator process keeper

因为有atx-agent的存在，Uiautomator会被一直守护着，如果退出了就会被重新启动起来。但是Uiautomator又是霸道的，一旦它在运行，手机上的辅助功能、电脑上的uiautomatorviewer 就都不能用了，除非关掉该框架本身的uiautomator。下面就说下两种关闭方法

方法1：

直接打开uiautomator app（init成功后，就会安装上的），点击关闭UIAutomator

方法2:

d.service("uiautomator").stop()

打开调试开关

用于开发者或有经验的使用者定位问题

>>> d.debug = True
>>> d.info
12:32:47.182 $ curl -X POST -d '{"jsonrpc": "2.0", "id": "b80d3a488580be1f3e9cb3e926175310", "method": "deviceInfo", "params": {}}' 'http://127.0.0.1:54179/jsonrpc/0'
12:32:47.225 Response >>>
{"jsonrpc":"2.0","id":"b80d3a488580be1f3e9cb3e926175310","result":{"currentPackageName":"com.android.mms","displayHeight":1920,"displayRotation":0,"displaySizeDpX":360,"displaySizeDpY":640,"displayWidth":1080,"productName"
:"odin","screenOn":true,"sdkInt":25,"naturalOrientation":true}}
<<< END

Notes: In below examples, we use d to represent the uiautomator2 object for the connected device.

API Documents

App management

• Install an app
• Launch an app
• Stop an app
• Stop all running apps
• Push and pull files
• Auto click permission dialogs

Basic API Usages

• Shell commands
• Session
• Retrieve the device info
• Key Events
• Gesture interaction with the device
• Screen-related
• Selector
• Watcher
• Global settings
• Input method
• Toast
• XPath

测试方法

Google uiautomator与uiautomator2的区别

常见问题

Contributors

LICENSE

App management

This part showcases how to perform app management

Install an app

We only support installing an APK from a URL

d.app_install('http://some-domain.com/some.apk')

Launch an app

d.app_start("com.example.hello_world") # start with package name

Stop an app

# equivalent to `am force-stop`, thus you could lose data
d.app_stop("com.example.hello_world") 
# equivalent to `pm clear`
d.app_clear('com.example.hello_world')

Stop all running apps

# stop all
d.app_stop_all()
# stop all app except for com.examples.demo
d.app_stop_all(excludes=['com.examples.demo'])

Push and pull files

• push a file to the device

  # push to a folder
  d.push("foo.txt", "/sdcard/")
  # push and rename
  d.push("foo.txt", "/sdcard/bar.txt")
  # push fileobj
  with open("foo.txt", 'rb') as f:
      d.push(f, "/sdcard/")
  # push and change file access mode
  d.push("foo.sh", "/data/local/tmp/", mode=0o755)

• pull a file from the device

  d.pull("/sdcard/tmp.txt", "tmp.txt")
  
  # FileNotFoundError will raise if the file is not found on the device
  d.pull("/sdcard/some-file-not-exists.txt", "tmp.txt")

Auto click permission dialogs

注意注意 disable_popups函数，检测发现很不稳定，暂时不要使用，等候通知。

Import in version 0.1.1

d.disable_popups() # automatic skip popups
d.disable_popups(False) # disable automatic skip popups

If this method is not working on your device, You can make a pull request or create an issue to enhance this function. I'll show you how to do it.

1. Open uiautomatorviewer.bat
2. Get popup hierarchy

Now you know the button text and current package name. Make a pull request by update function disable_popups or create an issue if you are not familar with git and python.

Basic API Usages

This part showcases how to perform common device operations:

Shell commands

• Run a short-lived shell command with a timeout protection. (Default timeout 60s)

  Note: timeout support require atx-agent >=0.3.3

  adb_shell function is deprecated. Use shell instead.

  Simple usage

  output, exit_code = d.shell("pwd", timeout=60) # timeout 60s (Default)
  # output: "/\n", exit_code: 0
  # Similar to command: adb shell pwd

  The first argument can be list. for example

  output, exit_code = d.shell(["ls", "-l"])
  # output: "/....", exit_code: 0

  This returns a string for stdout merged with stderr. If the command is a blocking command, shell will also block until the command is completed or the timeout kicks in. No partial output will be received during the execution of the command. This API is not suitable for long-running commands. The shell command given runs in a similar environment of adb shell, which has a Linux permission level of adb or shell (higher than an app permission).

• Run a long-running shell command

  add stream=True will return requests.models.Response object. More info see requests stream

  r = d.shell("logcat", stream=True)
  # r: requests.models.Response
  deadline = time.time() + 10 # run maxium 10s
  try:
      for line in r.iter_lines(): # r.iter_lines(chunk_size=512, decode_unicode=None, delimiter=None)
          if time.time() > deadline:
              break
          print("Read:", line.decode('utf-8'))
  finally:
      r.close() # this method must be called

  Command will be terminated when r.close() called.

Session

Session represent an app lifestyle. Can be used to start app, detect app crash.

• Launch app

  sess = d.session("com.netease.cloudmusic") # start 网易云音乐

• Attach to the running app

  sess = d.session("com.netease.cloudmusic", attach=True)

• Detect app crash

  # When app is still running
  sess(text="Music").click() # operation goes normal
  
  # If app crash or quit
  sess(text="Music").click() # raise SessionBrokenError
  # other function calls under session will raise SessionBrokenError too

  # check if session is ok.
  # Warning: function name may change in the future
  sess.running() # True or False

Retrieve the device info

Get basic information

d.info

Below is a possible output:

{ 
    u'displayRotation': 0,
    u'displaySizeDpY': 640,
    u'displaySizeDpX': 360,
    u'currentPackageName': u'com.android.launcher',
    u'productName': u'takju',
    u'displayWidth': 720,
    u'sdkInt': 18,
    u'displayHeight': 1184,
    u'naturalOrientation': True
}

Get window size

print(d.window_size())
# device upright output example: (1080, 1920)
# device horizontal output example: (1920, 1080)

Get current app info. For some android devices, the output could be empty (see Output example 3)

print(d.current_app())
# Output example 1: {'activity': '.Client', 'package': 'com.netease.example', 'pid': 23710}
# Output example 2: {'activity': '.Client', 'package': 'com.netease.example'}
# Output example 3: {'activity': None, 'package': None}

Get device serial number

print(d.serial)
# output example: 74aAEDR428Z9

Key Events

• Turn on/off screen

  d.screen_on() # turn on the screen
  d.screen_off() # turn off the screen

• Get current screen status

  d.info.get('screenOn') # require Android >= 4.4

• Press hard/soft key

  d.press("home") # press the home key, with key name
  d.press("back") # press the back key, with key name
  d.press(0x07, 0x02) # press keycode 0x07('0') with META ALT(0x02)

• These key names are currently supported:

  • home
  • back
  • left
  • right
  • up
  • down
  • center
  • menu
  • search
  • enter
  • delete ( or del)
  • recent (recent apps)
  • volume_up
  • volume_down
  • volume_mute
  • camera
  • power

You can find all key code definitions at Android KeyEvnet

• Unlock screen

  d.unlock()
  # This is equivalent to
  # 1. launch activity: com.github.uiautomator.ACTION_IDENTIFY
  # 2. press the "home" key

Gesture interaction with the device

• Click on the screen

  d.click(x, y)

• Double click

  d.double_click(x, y)
  d.double_click(x, y, 0.1) # default duration between two click is 0.1s

• Long click on the screen

  d.long_click(x, y)
  d.long_click(x, y, 0.5) # long click 0.5s (default)

• Swipe

  d.swipe(sx, sy, ex, ey)
  d.swipe(sx, sy, ex, ey, 0.5) # swipe for 0.5s(default)

• Drag

  d.drag(sx, sy, ex, ey)
  d.drag(sx, sy, ex, ey, 0.5) # swipe for 0.5s(default)

• Swipe points

  # swipe from point(x0, y0) to point(x1, y1) then to point(x2, y2)
  # time will speed 0.2s bwtween two points
  d.swipe((x0, y0), (x1, y1), (x2, y2), 0.2)

  多用于九宫格解锁，提前获取到每个点的相对坐标（这里支持百分比）， 更详细的使用参考这个帖子 使用u2实现九宫图案解锁

Note: click, swipe, drag operations support percentage position values. Example:

d.long_click(0.5, 0.5) means long click center of screen

Screen-related

• Retrieve/Set device orientation

  The possible orientations:

  • natural or n
  • left or l
  • right or r
  • upsidedown or u (can not be set)

  # retrieve orientation. the output could be "natural" or "left" or "right" or "upsidedown"
  orientation = d.orientation
  
  # WARNING: not pass testing in my TT-M1
  # set orientation and freeze rotation.
  # notes: setting "upsidedown" requires Android>=4.3.
  d.set_orientation('l') # or "left"
  d.set_orientation("l") # or "left"
  d.set_orientation("r") # or "right"
  d.set_orientation("n") # or "natural"

• Freeze/Un-freeze rotation

  # freeze rotation
  d.freeze_rotation()
  # un-freeze rotation
  d.freeze_rotation(False)

• Take screenshot

  # take screenshot and save to a file on the computer, require Android>=4.2.
  d.screenshot("home.jpg")
  
  # get PIL.Image formatted images. Naturally, you need pillow installed first
  image = d.screenshot() # default format="pillow"
  image.save("home.jpg") # or home.png. Currently, only png and jpg are supported
  
  # get opencv formatted images. Naturally, you need numpy and cv2 installed first
  import cv2
  image = d.screenshot(format='opencv')
  cv2.imwrite('home.jpg', image)
  
  # get raw jpeg data
  imagebin = d.screenshot(format='raw')
  open("some.jpg", "wb").write(imagebin)

• Dump UI hierarchy

  # get the UI hierarchy dump content (unicoded).
  xml = d.dump_hierarchy()

• Open notification or quick settings

  d.open_notification()
  d.open_quick_settings()

Selector

Selector is a handy mechanism to identify a specific UI object in the current window.

# Select the object with text 'Clock' and its className is 'android.widget.TextView'
d(text='Clock', className='android.widget.TextView')

Selector supports below parameters. Refer to UiSelector Java doc for detailed information.

• text, textContains, textMatches, textStartsWith
• className, classNameMatches
• description, descriptionContains, descriptionMatches, descriptionStartsWith
• checkable, checked, clickable, longClickable
• scrollable, enabled,focusable, focused, selected
• packageName, packageNameMatches
• resourceId, resourceIdMatches
• index, instance

Children and siblings

• children

  # get the children or grandchildren
  d(className="android.widget.ListView").child(text="Bluetooth")

• siblings

  # get siblings
  d(text="Google").sibling(className="android.widget.ImageView")

• children by text or description or instance

  # get the child matching the condition className="android.widget.LinearLayout"
  # and also its children or grandchildren with text "Bluetooth"
  d(className="android.widget.ListView", resourceId="android:id/list") \
   .child_by_text("Bluetooth", className="android.widget.LinearLayout")
  
  # get children by allowing scroll search
  d(className="android.widget.ListView", resourceId="android:id/list") \
   .child_by_text(
      "Bluetooth",
      allow_scroll_search=True,
      className="android.widget.LinearLayout"
    )

  • child_by_description is to find children whose grandchildren have the specified description, other parameters being similar to child_by_text.

  • child_by_instance is to find children with has a child UI element anywhere within its sub hierarchy that is at the instance specified. It is performed on visible views without scrolling.

  See below links for detailed information:

  • UiScrollable, getChildByDescription, getChildByText, getChildByInstance
  • UiCollection, getChildByDescription, getChildByText, getChildByInstance

  Above methods support chained invoking, e.g. for below hierarchy

  <node index="0" text="" resource-id="android:id/list" class="android.widget.ListView" ...>
    <node index="0" text="WIRELESS & NETWORKS" resource-id="" class="android.widget.TextView" .../>
    <node index="1" text="" resource-id="" class="android.widget.LinearLayout" ...>
      <node index="1" text="" resource-id="" class="android.widget.RelativeLayout" ...>
        <node index="0" text="Wi‑Fi" resource-id="android:id/title" class="android.widget.TextView" .../>
      </node>
      <node index="2" text="ON" resource-id="com.android.settings:id/switchWidget" class="android.widget.Switch" .../>
    </node>
    ...
  </node>

  

  To click the switch widget right to the TextView 'Wi‑Fi', we need to select the switch widgets first. However, according to the UI hierarchy, more than one switch widgets exist and have almost the same properties. Selecting by className will not work. Alternatively, the below selecting strategy would help:

  d(className="android.widget.ListView", resourceId="android:id/list") \
    .child_by_text("Wi‑Fi", className="android.widget.LinearLayout") \
    .child(className="android.widget.Switch") \
    .click()

• relative positioning

  Also we can use the relative positioning methods to get the view: left, right, top, bottom.

  • d(A).left(B), selects B on the left side of A.
  • d(A).right(B), selects B on the right side of A.
  • d(A).up(B), selects B above A.
  • d(A).down(B), selects B under A.

  So for above cases, we can alternatively select it with:

  ## select "switch" on the right side of "Wi‑Fi"
  d(text="Wi‑Fi").right(className="android.widget.Switch").click()

• Multiple instances

  Sometimes the screen may contain multiple views with the same properties, e.g. text, then you will have to use the "instance" property in the selector to pick one of qualifying instances, like below:

  d(text="Add new", instance=0)  # which means the first instance with text "Add new"

  In addition, uiautomator2 provides a list-like API (similar to jQuery):

  # get the count of views with text "Add new" on current screen
  d(text="Add new").count
  
  # same as count property
  len(d(text="Add new"))
  
  # get the instance via index
  d(text="Add new")[0]
  d(text="Add new")[1]
  ...
  
  # iterator
  for view in d(text="Add new"):
      view.info  # ...

  Notes: when using selectors in a list fashion, you must ensure that the UI elements on the screen keep unchanged. Otherwise, when Element-Not-Found error could occur when iterating through the list.

Get the selected ui object status and its information

• Check if the specific UI object exists

  d(text="Settings").exists # True if exists, else False
  d.exists(text="Settings") # alias of above property.
  
  # advanced usage
  d(text="Settings").exists(timeout=3) # wait Settings appear in 3s, same as .wait(3)

• Retrieve the info of the specific UI object

  d(text="Settings").info

  Below is a possible output:

  { u'contentDescription': u'',
  u'checked': False,
  u'scrollable': False,
  u'text': u'Settings',
  u'packageName': u'com.android.launcher',
  u'selected': False,
  u'enabled': True,
  u'bounds': {u'top': 385,
              u'right': 360,
              u'bottom': 585,
              u'left': 200},
  u'className': u'android.widget.TextView',
  u'focused': False,
  u'focusable': True,
  u'clickable': True,
  u'chileCount': 0,
  u'longClickable': True,
  u'visibleBounds': {u'top': 385,
                      u'right': 360,
                      u'bottom': 585,
                      u'left': 200},
  u'checkable': False
  }
  

• Get/Set/Clear text of an editable field (e.g., EditText widgets)

  d(text="Settings").get_text()  # get widget text
  d(text="Settings").set_text("My text...")  # set the text
  d(text="Settings").clear_text()  # clear the text

• Get Widget center point

  x, y = d(text="Settings").center()

Perform the click action on the selected UI object

• Perform click on the specific object

  # click on the center of the specific ui object
  d(text="Settings").click()
  # wait element to appear for at most 10 seconds and then click
  d(text="Settings").click(timeout=10)
  # click when exists in 10s, default timeout 0s
  clicked = d(text='Skip').click_exists(timeout=10.0)
  # click until element gone, return bool
  is_gone = d(text="Skip").click_gone(maxretry=10, interval=1.0) # maxretry default 10, interval default 1.0

• Perform long click on the specific UI object

  # long click on the center of the specific UI object
  d(text="Settings").long_click()

Gesture actions for the specific UI object

• Drag the UI object towards another point or another UI object

  # notes : drag can not be used for Android<4.3.
  # drag the UI object to a screen point (x, y), in 0.5 second
  d(text="Settings").drag_to(x, y, duration=0.5)
  # drag the UI object to (the center position of) another UI object, in 0.25 second
  d(text="Settings").drag_to(text="Clock", duration=0.25)

• Two-point gesture from one point to another

  d(text="Settings").gesture((sx1, sy1), (sx2, sy2), (ex1, ey1), (ex2, ey2))

• Two-point gesture on the specific UI object

  Supports two gestures:

  • In, from edge to center
  • Out, from center to edge

  # notes : pinch can not be set until Android 4.3.
  # from edge to center. here is "In" not "in"
  d(text="Settings").pinch_in(percent=100, steps=10)
  # from center to edge
  d(text="Settings").pinch_out()

• Wait until the specific UI appears or disappears

  # wait until the ui object appears
  d(text="Settings").wait(timeout=3.0) # return bool
  # wait until the ui object gone
  d(text="Settings").wait_gone(timeout=1.0)

  The default timeout is 20s. see global settings for more details

• Perform fling on the specific ui object(scrollable)

  Possible properties:

  • horiz or vert
  • forward or backward or toBeginning or toEnd

  # fling forward(default) vertically(default) 
  d(scrollable=True).fling()
  # fling forward horizontally
  d(scrollable=True).fling.horiz.forward()
  # fling backward vertically
  d(scrollable=True).fling.vert.backward()
  # fling to beginning horizontally
  d(scrollable=True).fling.horiz.toBeginning(max_swipes=1000)
  # fling to end vertically
  d(scrollable=True).fling.toEnd()

• Perform scroll on the specific ui object(scrollable)

  Possible properties:

  • horiz or vert
  • forward or backward or toBeginning or toEnd, or to

  # scroll forward(default) vertically(default)
  d(scrollable=True).scroll(steps=10)
  # scroll forward horizontally
  d(scrollable=True).scroll.horiz.forward(steps=100)
  # scroll backward vertically
  d(scrollable=True).scroll.vert.backward()
  # scroll to beginning horizontally
  d(scrollable=True).scroll.horiz.toBeginning(steps=100, max_swipes=1000)
  # scroll to end vertically
  d(scrollable=True).scroll.toEnd()
  # scroll forward vertically until specific ui object appears
  d(scrollable=True).scroll.to(text="Security")

Watcher

You can register watchers to perform some actions when a selector does not find a match.

• Register Watcher

  When a selector can not find a match, uiautomator2 will run all registered watchers.

  • Click target when conditions match

  d.watcher("AUTO_FC_WHEN_ANR").when(text="ANR").when(text="Wait") \
                               .click(text="Force Close")
  # d.watcher(name) ## creates a new named watcher.
  #  .when(condition)  ## the UiSelector condition of the watcher.
  #  .click(target)  ## perform click action on the target UiSelector.

  There is also a trick about click. You can use click without arguments.

  d.watcher("ALERT").when(text="OK").click()
  # Same as
  d.watcher("ALERT").when(text="OK").click(text="OK")

  • Press key when a condition becomes true

  d.watcher("AUTO_FC_WHEN_ANR").when(text="ANR").when(text="Wait") \
                               .press("back", "home")
  # d.watcher(name) ## creates a new named watcher.
  #  .when(condition)  ## the UiSelector condition of the watcher.
  #  .press(<keyname>, ..., <keyname>.()  ## press keys one by one in sequence.

• Check if the named watcher triggered

  A watcher is triggered, which means the watcher was run and all its conditions matched.

  d.watcher("watcher_name").triggered
  # true in case of the specified watcher triggered, else false

• Remove a named watcher

  # remove the watcher
  d.watcher("watcher_name").remove()

• List all watchers

  d.watchers
  # a list of all registered watchers

• Check for any triggered watcher

  d.watchers.triggered
  #  true in case of any watcher triggered

• Reset all triggered watchers

  # reset all triggered watchers, after that, d.watchers.triggered will be false.
  d.watchers.reset()

• Remove watchers

  # remove all registered watchers
  d.watchers.remove()
  # remove the named watcher, same as d.watcher("watcher_name").remove()
  d.watchers.remove("watcher_name")

• Force to run all watchers

  # force to run all registered watchers
  d.watchers.run()

• Run all watchers when page update.

  通常可以用来自动点击权限确认框，或者自动安装

  d.watcher("OK").when(text="OK").click(text="OK")
  # enable auto trigger watchers
  d.watchers.watched = True
  
  # disable auto trigger watchers
  d.watchers.watched = False
  
  # get current trigger watchers status
  assert d.watchers.watched == False

另外文档还是有很多没有写，推荐直接去看源码init.py

Global settings

# set delay 1.5s after each UI click and click
d.click_post_delay = 1.5 # default no delay

# set default element wait timeout (seconds)
d.wait_timeout = 30.0 # default 20.0

UiAutomator中的超时设置(隐藏方法)

>> d.jsonrpc.getConfigurator() 
{'actionAcknowledgmentTimeout': 500,
 'keyInjectionDelay': 0,
 'scrollAcknowledgmentTimeout': 200,
 'waitForIdleTimeout': 0,
 'waitForSelectorTimeout': 0}

>> d.jsonrpc.setConfigurator({"waitForIdleTimeout": 100})
{'actionAcknowledgmentTimeout': 500,
 'keyInjectionDelay': 0,
 'scrollAcknowledgmentTimeout': 200,
 'waitForIdleTimeout': 100,
 'waitForSelectorTimeout': 0}

为了防止客户端程序响应超时，waitForIdleTimeout和waitForSelectorTimeout目前已改为0

Refs: Google uiautomator Configurator

Input method

这种方法通常用于不知道控件的情况下的输入。第一步需要切换输入法，然后发送adb广播命令，具体使用方法如下

d.set_fastinput_ime(True) # 切换成FastInputIME输入法
d.send_keys("你好123abcEFG") # adb广播输入
d.clear_text() # 清除输入框所有内容(Require android-uiautomator.apk version >= 1.0.7)
d.set_fastinput_ime(False) # 切换成正常的输入法

Toast

Show Toast

d.toast.show("Hello world")
d.toast.show("Hello world", 1.0) # show for 1.0s, default 1.0s

Get Toast

# [Args]
# 5.0: max wait timeout. Default 10.0
# 10.0: cache time. return cache toast if already toast already show up in recent 10 seconds. Default 10.0 (Maybe change in the furture)
# "default message": return if no toast finally get. Default None
d.toast.get_message(5.0, 10.0, "default message")

# common usage
assert "Short message" in d.toast.get_message(5.0, default="")

# clear cached toast
d.toast.reset()
# Now d.toast.get_message(0) is None

XPath

For example: 其中一个节点的内容

<android.widget.TextView
  index="2"
  text="05:19"
  resource-id="com.netease.cloudmusic:id/qf"
  package="com.netease.cloudmusic"
  content-desc=""
  checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false"
  scrollable="false" long-clickable="false" password="false" selected="false" visible-to-user="true"
  bounds="[957,1602][1020,1636]" />

xpath定位和使用方法

# wait exists 10s
d.xpath("//android.widget.TextView").wait(10.0)
# find and click
d.xpath("//*[@content-desc='分享']").click()
# get all text-view text, attrib and center point
for elem in d.xpath("//android.widget.TextView").all():
    print("Text:", elem.text)
    # Dictionary eg: 
    # {'index': '1', 'text': '999+', 'resource-id': 'com.netease.cloudmusic:id/qb', 'package': 'com.netease.cloudmusic', 'content-desc': '', 'checkable': 'false', 'checked': 'false', 'clickable': 'false', 'enabled': 'true', 'focusable': 'false', 'focused': 'false','scrollable': 'false', 'long-clickable': 'false', 'password': 'false', 'selected': 'false', 'visible-to-user': 'true', 'bounds': '[661,1444][718,1478]'}
    print("Attrib:", elem.attrib)
    # Coordinate eg: (100, 200)
    print("Position:", elem.center())

测试方法

$ adb forward tcp:9008 tcp:9008
$ curl 127.0.0.1:9008/ping
# expect: pong

$ curl -d '{"jsonrpc":"2.0","method":"deviceInfo","id":1}' 127.0.0.1:9008/jsonrpc/0
# expect JSON output

Google uiautomator与uiautomator2的区别

1. API相似但是不完全兼容
2. uiautomator2是安卓项目，而uiautomator是Java项目
3. uiautomator2可以输入中文，而uiautomator的Java工程需借助utf7输入法才能输入中文
4. uiautomator2必须明确EditText框才能向里面输入文字，uiautomator直接指定父类也可以在子类中输入文字
5. uiautomator2获取控件速度比uiautomator快

常见问题

1. 提示502错误

   尝试手机连接PC，然后运行下面的命令

   adb shell am instrument -w -r -e debug false -e class com.github.uiautomator.stub.Stub \
   	com.github.uiautomator.test/android.support.test.runner.AndroidJUnitRunner
   

   如果运行正常，启动测试之前增加一行代码d.healthcheck()

   如果报错，可能是缺少某个设备组件没有安装，使用下面的命令重新初始化 python -m uiautomator2 init --reinstall

实验室功能

远程查看

手机python -m uiautomator2 init之后，浏览器输入 <device_ip:7912>，会发现一个远程控制功能，延迟非常低噢。^_^

手机USB连接后，自动调用init命令

adbkit-init

项目历史

项目重构自 https://github.com/openatx/atx-uiautomator

CHANGELOG (generated by pbr)

依赖项目

• uiautomator守护程序 https://github.com/openatx/atx-agent
• uiautomator jsonrpc serverhttps://github.com/openatx/android-uiautomator-server/

Contributors

• codeskyblue (@codeskyblue)
• Xiaocong He (@xiaocong)
• Yuanyuan Zou (@yuanyuan)
• Qian Jin (@QianJin2013)
• Xu Jingjie (@xiscoxu)
• Xia Mingyuan (@mingyuan-xia)
• Artem Iglikov, Google Inc. (@artikz)

Other contributors

LICENSE

MIT