uiautomator

    
This module is a Python wrapper of Android uiautomator testing framework. It works on Android 4.1+ simply with Android device attached via adb, no need to install anything on Android device.
此模块是一个安卓ui自动化测试框架的python包,它在Android 4.1+上运行,Android设备通过adb连接,无需在安卓设备上安装任何别的东西。
from
uiautomator
import
device
as
d
 
d.screen.on()
d(text="Clock").click()

Installation

$ pip install uiautomator

Pre-requirements

  • Install Android SDK, and set ANDROID_HOME environment to the correct path.
  • Enable ADB setting on device and connect your android device using usb with your PC.
  • Allow apps to install from unknown sources on device settings.

import uiautomator

  • If ANDROID_SERIAL is defined in environment, or there is only one device connected:
    from
    uiautomator
    import
    device
    as
    d
  • Speficy the serial number when retrieving the device object
    from
    uiautomator
    import
    Device
     
    d
    =
    Device('014E05DE0F02000E')

  • Speficy the adb server host and port running on other computer
    Although adb supports -a option since SDK 4.3, but now it has a bug on it. The only way to start adb server listenning on all interfaces instead of localhost, is adb -a -P 5037 fork-server server &
    from
    uiautomator
    import
    Device
     
    d
    =
    Device('014E05DE0F02000E',
    adb_server_host='192.168.1.68',
    adb_server_port=5037)


Notes: In below examples, we use d represent the android device object.

Table of Contents  目录

Basic API Usages    基本API用法
Watcher introduction  观察者介绍
Handler introduction   处理程序介绍
Selector introduction   选择器介绍

Basic API Usages

This part show the normal actions of the device through some simple examples.
  • Retrieve the device info
    d.info
     
    Below is a possible result:
    { 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
    }

Key Event Actions of the device

  • Turn on/off screen
    #
    Turn on screen
    d.screen.on()
    #
    Turn off screen
    d.screen.off()

     
    Alternative method is:
    #
    wakeup the device
    d.wakeup()
    #
    sleep the device, same as turning off the screen.
    d.sleep()

  • Check if the screen is on or off
    if
    d.screen
    ==
    "on":
    #
    of d.screen != "off"
    #
    do something in case of screen on
    passif
    d.screen
    ==
    "off":
    #
    of d.screen != "on"
    #
    do something in case of screen off
    pass

  • Press hard/soft key
    #
    press home key
    d.press.home()
    #
    press back key
    d.press.back()
    #
    the normal way to press back key
    d.press("back")
    #
    press keycode 0x07('0') with META ALT(0x02) on
    d.press(0x07,
    0x02)

  • Next keys 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 KeyEvent.

Gesture interaction of the device

  • Click the screen
    #
    click (x, y) on screen
    d.click(x, y)

  • Long click the screen
    #
    long click (x, y) on screen
    d.long_click(x, y)

  • Swipe  滑动
    #
    swipe from (sx, sy) to (ex, ey)
    d.swipe(sx, sy, ex, ey)
    #
    swipe from (sx, sy) to (ex, ey) with 10 steps
    d.swipe(sx, sy, ex, ey,
    steps=10)

  • Drag
    #
    drag from (sx, sy) to (ex, ey)
    d.drag(sx, sy, ex, ey)
    #
    drag from (sx, sy) to (ex, ey) with 10 steps
    d.drag(sx, sy, ex, ey,
    steps=10)

Screen Actions of the device

  • Retrieve/Set Orientation    获取/设置 (手机)方向
    The possible orientation is:
    • natural or n
    • left or l
    • right or r
    • upsidedown or u (can not be set)  颠倒
  • #
    retrieve orientation, it may be "natural" or "left" or "right" or "upsidedown"
    orientation
    =
    d.orientation
    #
    set orientation and freeze rotation.#
    notes: "upsidedown" can not be set until Android 4.3.  设置和锁定方向
    d.orientation
    =
    "l"
    #
    or "left"
    d.orientation
    =
    "r"
    #
    or "right"
    d.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 local file "home.png", can not work until Android 4.2.
    d.screenshot("home.png")

  • Dump Window Hierarchy   存储窗口结构
    #
    dump the widown hierarchy and save to local file "hierarchy.xml"
    d.dump("hierarchy.xml")
    #
    or get the dumped content(unicode) from return.
    xml
    =
    d.dump()

  • Open notification or quick settings  打开通知栏/快速设置栏
    #
    open notification, can not work until Android 4.3.
    d.open.notification()
    #
    open quick settings, can not work until Android 4.3.
    d.open.quick_settings()

  • Wait for idle or window update   等待空闲或窗口更新
    #
    wait for current window to idle
    d.wait.idle()
    #
    wait until window update event occurs
    d.wait.update()

Watcher  观察者

You can register watcher to perform some actions when a selector can not find a match.
  • Register Watcher
    When a selector can not find a match, uiautomator 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.
    • Press key when conditions match
  • d.watcher("AUTO_FC_WHEN_ANR").when(text="ANR").when(text="Wait") \
    .press.back.home()
    #
    Alternative way to define it as below
    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.#
    Alternavie way defining key sequence is press(<keybname>, ..., <keyname>)
  • 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 named watcher
    #
    remove the watcher
    d.watcher("watcher_name").remove()

  • List all watchers
    d.watchers
    #
    a list of all registered wachers' names

  • Check if there is any watcher triggered
    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()

  • Remvoe 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()

Handler

The functionality of handler is same as Watcher, except it is implemented ourside of Android uiautomator. The most different usage between handler and watcher is, handler can use customized callback function.  handler可以使用自定义的回调函数.
def
fc_close(device):
if
device(text='Force Close').exists:
device(text='Force Close').click()
return
True
#
return True means to break the loop of handler callback functions.
 
#
turn on the handler callback function
d.handlers.on(fc_close)
 
#
turn off the handler callback function
d.handlers.off(fc_close)

Selector

Selector is to identify specific ui object in current window.   选择器是在当前窗口中识别指定的ui对象。
#
To seleted the object ,text is '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

Child and sibling UI object

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

  • sibling
    #
    get sibling or child of sibling
    d(text="Google").sibling(className="android.widget.ImageView")

  • child by text or description or instance
    #
    get the child match className="android.widget.LinearLayout"#
    and also it or its child or grandchild contains text "Bluetooth"
    d(className="android.widget.ListView",
    resourceId="android:id/list") \
    .child_by_text("Bluetooth",
    className="android.widget.LinearLayout")
     
    #
    allow scroll search to get the child
    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 child which or which's grandchild contains the specified description, others are the same as child_by_text.
    • child_by_instance is to find child which 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>

  

We want to click the switch at the right side of text 'Wi‑Fi' to turn on/of Wi‑Fi. As there are several switches with almost the same properties, so we can not use like d(className="android.widget.Switch") to select the ui object. Instead, we can use code below to select it. 
  • 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 position
    Also we can use the relative position methods to get the view: left, right, top, bottom.
    • d(A).left(B), means selecting B on the left side of A.
    • d(A).right(B), means selecting B on the right side of A.
    • d(A).up(B), means selecting B above A.
    • d(A).down(B), means selecting B under A.
So for above case, we can write code alternatively:
  • ## 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 e.g. text, then you will have to use "instance" properties in selector like below:
    d(text="Add new",
    instance=0)
    #
    which means the first instance with text "Add new"
     
    However, uiautomator provides list like methods to use it.
    #
    get the count of views with text "Add new" on current screen
    d(text="Add new").count
     
    #
    same as count propertylen(d(text="Add new"))
     
    #
    get the instance via index
    d(text="Add new")[0]
    d(text="Add new")[1]
    ...
     
    #
    iteratorfor
    view
    in
    d(text="Add new"):
    view.info
    #
    ...

     
    Notes: when you are using selector like a list, you must make sure the screen keep unchanged, else you may get ui not found error.

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.

  • Retrieve the info of the specific ui object
    d(text="Settings").info
     
    Below is a possible result:
    { 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
    }
  • Set/Clear text of editable field
    d(text="Settings").clear_text()
    #
    clear the text
    d(text="Settings").set_text("My text...")
    #
    set the text

Perform the click action on the seleted ui object

  • Perform click on the specific ui object
    #
    click on the center of the specific ui object
    d(text="Settings").click()
    #
    click on the bottomright corner of the specific ui object
    d(text="Settings").click.bottomright()
    #
    click on the topleft corner of the specific ui object
    d(text="Settings").click.topleft()
    #
    click and wait until the new window update
    d(text="Settings").click.wait()

  • Perform long click on the specific ui object
    #
    long click on the center of the specific ui object
    d(text="Settings").long_click()
    #
    long click on the bottomright corner of the specific ui object
    d(text="Settings").long_click.bottomright()
    #
    long click on the topleft corner of the specific ui object
    d(text="Settings").long_click.topleft()

Gesture action for the specific ui object

  • Drag the ui object to another point or ui object
    #
    notes : drag can not be set until Android 4.3.#
    drag the ui object to point (x, y)
    d(text="Settings").drag.to(x, y,
    steps=100)
    #
    drag the ui object to another ui object(center)
    d(text="Settings").drag.to(text="Clock",
    steps=50)

  • Swipe from the center of the ui object to its edge
    Swipe supports 4 directions:  滑动支持4种方向
    • left
    • right
    • top
    • bottom
  • d(text="Settings").swipe.right()
    d(text="Settings").swipe.left(steps=10)
    d(text="Settings").swipe.up(steps=10)
    d(text="Settings").swipe.down()
  • Two point gesture from one point to another
    d(text="Settings").gesture((sx1, sy1), (sx2, sy2)) \
    .to((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()
  • 3 point gesture
    d().gestureM((sx1, sy1), (sx2, sy2),(sx3, sy3)) \
    .to((ex1, ey1), (ex2, ey2),(ex3,ey3))
    d().gestureM((100,200),(300,200),(600,200),(100,600),(300,600),(600,900))

  • Wait until the specific ui object appears or gone
    #
    wait until the ui object appears
    d(text="Settings").wait.exists(timeout=3000)
    #
    wait until the ui object gone
    d(text="Settings").wait.gone(timeout=1000)

  • 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 horizentally
    d(scrollable=True).fling.horiz.forward()
    #
    fling backward vertically
    d(scrollable=True).fling.vert.backward()
    #
    fling to beginning horizentally
    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 horizentally
    d(scrollable=True).scroll.horiz.forward(steps=100)
    #
    scroll backward vertically
    d(scrollable=True).scroll.vert.backward()
    #
    scroll to beginning horizentally
    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")

Contribution   贡献

  • Fork the repo, and clone to your computer.
  • Checkout a new branch from develop branch
  • Install requirements: pip install -r requirements.txt
  • Make your changes, and update tests. Don't forget adding your name at the end of 'Contributors' section
  • Pass all tests and your code must be covered: tox.
  • Commit your changes and submit pull request to develop branch.

Contributors

Issues & Discussion  问题与讨论

If you have any bug reports or annoyances please report them to our issue tracker at github issues.

Notes

  • Android uiautomator works on Android 4.1+, so before using it, make sure your device is Android4.1+.
  • Some methods are only working on Android 4.2/4.3, so you'd better read detailed java documentation of
    uiautomator
    before using it.
  • The module uses uiautomator-jsonrpc-server as its daemon to communicate with devices.  daemon:
  • The module is only tested on python2.7/3.2/3.3/pypy.

FAQ

  • Could not start JSONRPC server: raise IOError("RPC server not started!")
    It may be caused by network, device, or environment. So when you meet the issue, please follow below steps and try to manually start the JSONRPC server.
    1. Follow steps at uiautomator-jsonrpc-server to start jsonrpc server.
    2. Check if jsonrpc server is ok:
      curl -d '{"jsonrpc":"2.0","method":"deviceInfo","id":1}' localhost:9008/jsonrpc/0
       
      If you see message like {"jsonrpc":"2.0","id":1,"result":{"currentPackageName":"android","displayHeight":1280,"displayRotation":0,"displaySizeDpX":0,"displaySizeDpY":0,"displayWidth":720,"productName":"falcon","sdkInt":17,"naturalOrientation":true}}, it means the server is up.
If you can manually start the jsonrpc server, but your script always meets IOError("RPC server not started!"), please submit an issue at github issues.
  • Error httplib.BadStatusLine: ''
    JsonRPC server needs to access temp directory on device, but on some low tier devices, it may meet error during accessing temp files without SD-CARD attached. So if you met the error, please insert a SD-CARD and then try again.

License

MIT

xiaocong/uiautomator的更多相关文章

  1. [python学习篇] uiautomator xiaocong

    Skip to content     This repository Pull requests Issues Marketplace Gist   Sign out       Watch103 ...

  2. uiautomator +python 实现安卓自动化

    很多人看到这个题目我相信他们可能会说,uiautomator不是java开发的吗?python怎么用呢,其实呢 ,一开始我也是这么想的,看了金阳光老师的视频,也是用java写的,我表示不服,我要科学上 ...

  3. Android高手速成--第四部分 开发工具及测试工具

    第四部分 开发工具及测试工具 主要介绍和Android开发工具和测试工具相关的开源项目. 一.开发效率工具 Json2Java根据JSon数据自动生成对应的Java实体类,还支持Parcel.Gson ...

  4. Android开源项目分类汇总

    目前包括: Android开源项目第一篇——个性化控件(View)篇   包括ListView.ActionBar.Menu.ViewPager.Gallery.GridView.ImageView. ...

  5. android 很多牛叉布局github地址(转)

    原文地址 http://blog.csdn.net/luo15309823081/article/details/41449929 点击可到达github-------https://github.c ...

  6. GitHub上史上最全的Android开源项目分类汇总 (转)

    GitHub上史上最全的Android开源项目分类汇总 标签: github android 开源 | 发表时间:2014-11-23 23:00 | 作者:u013149325 分享到: 出处:ht ...

  7. 【Android】Android开源项目分类汇总

    第一部分 个性化控件(View) 主要介绍那些不错个性化的View,包括ListView.ActionBar.Menu.ViewPager.Gallery.GridView.ImageView.Pro ...

  8. Github上的andoird开源组件整理

    http://blog.csdn.net/findsafety/article/details/50623627 第一部分 个性化控件(View) 主要介绍那些不错个性化的View,包括ListVie ...

  9. Android开源项目汇总【转】

    主要介绍那些不错个性化的View,包括ListView.ActionBar.Menu.ViewPager.Gallery.GridView.ImageView.ProgressBar.TextView ...

随机推荐

  1. async与await

    在方法上可以加 async,方法体内需要有 await,没有await的话,会出现warn警告.async单独出现是没有用的. await只能出现在Task前面.await Task的后面的代码会被封 ...

  2. css样式: 宽高按一定比例进行自适应

    纯 CSS 实现高度与宽度成比例的效果 最近在做一个产品列表页面,布局如右图所示.页面中有若干个 item,其中每个 item 都向左浮动,并包含在自适应浏览器窗口宽度的父元素中. item 元素的 ...

  3. Package gtk+-3.0 was not found in the pkg-config search path

    问题描述: 在fedora21系统上通过rpmbuild构建fcitx的二进制包时出现以上错误,经老程序员指点:“是相应的开发包没有安装” 解决办法: yum installl gtk3-devel  ...

  4. POJ 3709 K-Anonymous Sequence - 斜率优化dp

    描述 给定一个数列 $a$, 分成若干段,每段至少有$k$个数, 将每段中的数减少至所有数都相同, 求最小的变化量 题解 易得到状态转移方程 $F_i = \min(F_j  + sum_i - su ...

  5. ubuntu16.04 LTS Server 安装mysql phpmyadmin apache2 php5.6环境

    1.安装apache sudo apt-get install apache2 为了测试apache2是否正常,访问http://localhost/或http://127.0.0.1/,出现It W ...

  6. msys2 显示git branch

    在.bashrc或.bash_profile中添加以下内容 function parse_git_branch () { git branch 2> /dev/null | sed -e '/^ ...

  7. canvas标签的基本用法

    1.canvas和其他标签一样使用,但是IE8以下是不支持的,可以在canvas里面加一个span用来提示,例如: <canvas> <span>IE8不支持canvas< ...

  8. KBMMW 4.80.00 发布

    一大波更新来了. 4.80.00 March 30 2015 Important notes (changes that may break existing code)        ======= ...

  9. (并查集)Connections in Galaxy War -- zoj --3261 还没写

    链接: http://acm.zju.edu.cn/onlinejudge/showProblem.do?problemCode=3261 http://acm.hust.edu.cn/vjudge/ ...

  10. C++ 中的运算符的优先级

    C++ 中的运算符的优先级 直接看图