From 460180e309aa113687e317bf19f67e8211fec979 Mon Sep 17 00:00:00 2001 From: Diego Torres Milano Date: Tue, 9 Jul 2013 02:19:01 -0400 Subject: [PATCH] Added methods to calculate dump distances - Version 2.3.25 - Added Hamming distance - Added Levenshtein distance - Added View.__microStr__() - Traverse refactoring - Improved docs --- AndroidViewClient/doc/api-objects.txt | 17 +- AndroidViewClient/doc/class-tree.html | 2 +- AndroidViewClient/doc/help.html | 2 +- AndroidViewClient/doc/identifier-index.html | 88 +- AndroidViewClient/doc/module-tree.html | 2 +- .../doc/src.com.dtmilano.android-module.html | 2 +- .../doc/src.com.dtmilano.android-pysrc.html | 2 +- ...om.dtmilano.android.viewclient-module.html | 11 +- ...com.dtmilano.android.viewclient-pysrc.html | 4524 +++++++++-------- ...ano.android.viewclient.EditText-class.html | 3 +- ...android.viewclient.Excerpt2Code-class.html | 2 +- ...ano.android.viewclient.TextView-class.html | 3 +- ...t.UiAutomator2AndroidViewClient-class.html | 2 +- ...tmilano.android.viewclient.View-class.html | 20 +- ...o.android.viewclient.ViewClient-class.html | 251 +- ...iewclient.ViewNotFoundException-class.html | 2 +- ...ilano.android.viewclient.Window-class.html | 2 +- AndroidViewClient/doc/toc-everything.html | 3 +- ...om.dtmilano.android.viewclient-module.html | 3 +- .../src/com/dtmilano/android/viewclient.py | 219 +- 20 files changed, 2944 insertions(+), 2216 deletions(-) diff --git a/AndroidViewClient/doc/api-objects.txt b/AndroidViewClient/doc/api-objects.txt index a610da96..efaab549 100644 --- a/AndroidViewClient/doc/api-objects.txt +++ b/AndroidViewClient/doc/api-objects.txt @@ -4,7 +4,6 @@ src.com.dtmilano.android.viewclient src.com.dtmilano.android.viewclient-module.h src.com.dtmilano.android.viewclient.HEIGHT_PROPERTY src.com.dtmilano.android.viewclient-module.html#HEIGHT_PROPERTY src.com.dtmilano.android.viewclient.GONE src.com.dtmilano.android.viewclient-module.html#GONE src.com.dtmilano.android.viewclient.VIEW_SERVER_PORT src.com.dtmilano.android.viewclient-module.html#VIEW_SERVER_PORT -src.com.dtmilano.android.viewclient.LEFT_PROPERTY_API_8 src.com.dtmilano.android.viewclient-module.html#LEFT_PROPERTY_API_8 src.com.dtmilano.android.viewclient.TEXT_PROPERTY src.com.dtmilano.android.viewclient-module.html#TEXT_PROPERTY src.com.dtmilano.android.viewclient.WIDTH_PROPERTY_API_8 src.com.dtmilano.android.viewclient-module.html#WIDTH_PROPERTY_API_8 src.com.dtmilano.android.viewclient.__nd src.com.dtmilano.android.viewclient-module.html#__nd @@ -40,9 +39,11 @@ src.com.dtmilano.android.viewclient.TOP_PROPERTY_API_8 src.com.dtmilano.android. src.com.dtmilano.android.viewclient.VIEW_SERVER_HOST src.com.dtmilano.android.viewclient-module.html#VIEW_SERVER_HOST src.com.dtmilano.android.viewclient.VERSION_SDK_PROPERTY src.com.dtmilano.android.viewclient-module.html#VERSION_SDK_PROPERTY src.com.dtmilano.android.viewclient.LEFT_PROPERTY src.com.dtmilano.android.viewclient-module.html#LEFT_PROPERTY +src.com.dtmilano.android.viewclient.LEFT_PROPERTY_API_8 src.com.dtmilano.android.viewclient-module.html#LEFT_PROPERTY_API_8 src.com.dtmilano.android.viewclient.WIDTH_PROPERTY src.com.dtmilano.android.viewclient-module.html#WIDTH_PROPERTY src.com.dtmilano.android.viewclient.DEBUG_RECEIVED src.com.dtmilano.android.viewclient-module.html#DEBUG_RECEIVED src.com.dtmilano.android.viewclient.WS src.com.dtmilano.android.viewclient-module.html#WS +src.com.dtmilano.android.viewclient.DEBUG_DISTANCE src.com.dtmilano.android.viewclient-module.html#DEBUG_DISTANCE src.com.dtmilano.android.viewclient.DEBUG_TOUCH src.com.dtmilano.android.viewclient-module.html#DEBUG_TOUCH src.com.dtmilano.android.viewclient.EditText src.com.dtmilano.android.viewclient.EditText-class.html src.com.dtmilano.android.viewclient.View.getPositionAndSize src.com.dtmilano.android.viewclient.View-class.html#getPositionAndSize @@ -82,6 +83,7 @@ src.com.dtmilano.android.viewclient.View.getCenter src.com.dtmilano.android.view src.com.dtmilano.android.viewclient.View.getText src.com.dtmilano.android.viewclient.View-class.html#getText src.com.dtmilano.android.viewclient.View.device src.com.dtmilano.android.viewclient.View-class.html#device src.com.dtmilano.android.viewclient.View.intersection src.com.dtmilano.android.viewclient.View-class.html#intersection +src.com.dtmilano.android.viewclient.View.__microStr__ src.com.dtmilano.android.viewclient.View-class.html#__microStr__ src.com.dtmilano.android.viewclient.View.getXY src.com.dtmilano.android.viewclient.View-class.html#getXY src.com.dtmilano.android.viewclient.View.getX src.com.dtmilano.android.viewclient.View-class.html#getX src.com.dtmilano.android.viewclient.View.getParent src.com.dtmilano.android.viewclient.View-class.html#getParent @@ -133,6 +135,7 @@ src.com.dtmilano.android.viewclient.View.getCenter src.com.dtmilano.android.view src.com.dtmilano.android.viewclient.View.getText src.com.dtmilano.android.viewclient.View-class.html#getText src.com.dtmilano.android.viewclient.View.device src.com.dtmilano.android.viewclient.View-class.html#device src.com.dtmilano.android.viewclient.View.intersection src.com.dtmilano.android.viewclient.View-class.html#intersection +src.com.dtmilano.android.viewclient.View.__microStr__ src.com.dtmilano.android.viewclient.View-class.html#__microStr__ src.com.dtmilano.android.viewclient.View.getXY src.com.dtmilano.android.viewclient.View-class.html#getXY src.com.dtmilano.android.viewclient.View.getX src.com.dtmilano.android.viewclient.View-class.html#getX src.com.dtmilano.android.viewclient.View.getParent src.com.dtmilano.android.viewclient.View-class.html#getParent @@ -188,6 +191,7 @@ src.com.dtmilano.android.viewclient.View.getCenter src.com.dtmilano.android.view src.com.dtmilano.android.viewclient.View.getText src.com.dtmilano.android.viewclient.View-class.html#getText src.com.dtmilano.android.viewclient.View.leftProperty src.com.dtmilano.android.viewclient.View-class.html#leftProperty src.com.dtmilano.android.viewclient.View.intersection src.com.dtmilano.android.viewclient.View-class.html#intersection +src.com.dtmilano.android.viewclient.View.__microStr__ src.com.dtmilano.android.viewclient.View-class.html#__microStr__ src.com.dtmilano.android.viewclient.View.getXY src.com.dtmilano.android.viewclient.View-class.html#getXY src.com.dtmilano.android.viewclient.View.getX src.com.dtmilano.android.viewclient.View-class.html#getX src.com.dtmilano.android.viewclient.View.getParent src.com.dtmilano.android.viewclient.View-class.html#getParent @@ -200,13 +204,17 @@ src.com.dtmilano.android.viewclient.View.containsPoint src.com.dtmilano.android. src.com.dtmilano.android.viewclient.View.getVisibility src.com.dtmilano.android.viewclient.View-class.html#getVisibility src.com.dtmilano.android.viewclient.ViewClient src.com.dtmilano.android.viewclient.ViewClient-class.html src.com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTree src.com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTree +src.com.dtmilano.android.viewclient.ViewClient.__pickleable src.com.dtmilano.android.viewclient.ViewClient-class.html#__pickleable src.com.dtmilano.android.viewclient.ViewClient.traverse src.com.dtmilano.android.viewclient.ViewClient-class.html#traverse src.com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CIT src.com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CIT -src.com.dtmilano.android.viewclient.ViewClient.dump src.com.dtmilano.android.viewclient.ViewClient-class.html#dump +src.com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTreeThatMatches src.com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTreeThatMatches +src.com.dtmilano.android.viewclient.ViewClient.__traverse src.com.dtmilano.android.viewclient.ViewClient-class.html#__traverse src.com.dtmilano.android.viewclient.ViewClient.findViewWithAttribute src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithAttribute +src.com.dtmilano.android.viewclient.ViewClient.hammingDistance src.com.dtmilano.android.viewclient.ViewClient-class.html#hammingDistance src.com.dtmilano.android.viewclient.ViewClient.excerpt src.com.dtmilano.android.viewclient.ViewClient-class.html#excerpt src.com.dtmilano.android.viewclient.ViewClient.findViewByTag src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewByTag src.com.dtmilano.android.viewclient.ViewClient.ignoreUiAutomatorKilled src.com.dtmilano.android.viewclient.ViewClient-class.html#ignoreUiAutomatorKilled +src.com.dtmilano.android.viewclient.ViewClient.distance src.com.dtmilano.android.viewclient.ViewClient-class.html#distance src.com.dtmilano.android.viewclient.ViewClient.__parseTree src.com.dtmilano.android.viewclient.ViewClient-class.html#__parseTree src.com.dtmilano.android.viewclient.ViewClient.traverseShowClassIdTextAndCenter src.com.dtmilano.android.viewclient.ViewClient-class.html#traverseShowClassIdTextAndCenter src.com.dtmilano.android.viewclient.ViewClient.sleep src.com.dtmilano.android.viewclient.ViewClient-class.html#sleep @@ -218,7 +226,7 @@ src.com.dtmilano.android.viewclient.ViewClient.__init__ src.com.dtmilano.android src.com.dtmilano.android.viewclient.ViewClient.findViewWithTextOrRaise src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithTextOrRaise src.com.dtmilano.android.viewclient.ViewClient.traverseShowClassIdTextPositionAndSize src.com.dtmilano.android.viewclient.ViewClient-class.html#traverseShowClassIdTextPositionAndSize src.com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CITC src.com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CITC -src.com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTreeThatMatches src.com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTreeThatMatches +src.com.dtmilano.android.viewclient.ViewClient.dump src.com.dtmilano.android.viewclient.ViewClient-class.html#dump src.com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CITUI src.com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CITUI src.com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CITPS src.com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CITPS src.com.dtmilano.android.viewclient.ViewClient.views src.com.dtmilano.android.viewclient.ViewClient-class.html#views @@ -226,6 +234,7 @@ src.com.dtmilano.android.viewclient.ViewClient.isKeyboardShown src.com.dtmilano. src.com.dtmilano.android.viewclient.ViewClient.__obtainAdbPath src.com.dtmilano.android.viewclient.ViewClient-class.html#__obtainAdbPath src.com.dtmilano.android.viewclient.ViewClient.adb src.com.dtmilano.android.viewclient.ViewClient-class.html#adb src.com.dtmilano.android.viewclient.ViewClient.build src.com.dtmilano.android.viewclient.ViewClient-class.html#build +src.com.dtmilano.android.viewclient.ViewClient.__levenshteinDistance src.com.dtmilano.android.viewclient.ViewClient-class.html#__levenshteinDistance src.com.dtmilano.android.viewclient.ViewClient.__parseTreeFromUiAutomatorDump src.com.dtmilano.android.viewclient.ViewClient-class.html#__parseTreeFromUiAutomatorDump src.com.dtmilano.android.viewclient.ViewClient.ro src.com.dtmilano.android.viewclient.ViewClient-class.html#ro src.com.dtmilano.android.viewclient.ViewClient.TRAVERSE_CITCD src.com.dtmilano.android.viewclient.ViewClient-class.html#TRAVERSE_CITCD @@ -241,6 +250,7 @@ src.com.dtmilano.android.viewclient.ViewClient.traverseShowClassIdTextAndUniqueI src.com.dtmilano.android.viewclient.ViewClient.findViewById src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewById src.com.dtmilano.android.viewclient.ViewClient.findViewsContainingPoint src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewsContainingPoint src.com.dtmilano.android.viewclient.ViewClient.__findViewWithAttributeInTreeOrRaise src.com.dtmilano.android.viewclient.ViewClient-class.html#__findViewWithAttributeInTreeOrRaise +src.com.dtmilano.android.viewclient.ViewClient.levenshteinDistance src.com.dtmilano.android.viewclient.ViewClient-class.html#levenshteinDistance src.com.dtmilano.android.viewclient.ViewClient.device src.com.dtmilano.android.viewclient.ViewClient-class.html#device src.com.dtmilano.android.viewclient.ViewClient.getSdkVersion src.com.dtmilano.android.viewclient.ViewClient-class.html#getSdkVersion src.com.dtmilano.android.viewclient.ViewClient.findViewWithAttributeOrRaise src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithAttributeOrRaise @@ -259,6 +269,7 @@ src.com.dtmilano.android.viewclient.ViewClient.list src.com.dtmilano.android.vie src.com.dtmilano.android.viewclient.ViewClient.traverseShowClassIdTextAndContentDescription src.com.dtmilano.android.viewclient.ViewClient-class.html#traverseShowClassIdTextAndContentDescription src.com.dtmilano.android.viewclient.ViewClient.findViewWithContentDescription src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithContentDescription src.com.dtmilano.android.viewclient.ViewClient.useUiAutomator src.com.dtmilano.android.viewclient.ViewClient-class.html#useUiAutomator +src.com.dtmilano.android.viewclient.ViewClient.__hammingDistance src.com.dtmilano.android.viewclient.ViewClient-class.html#__hammingDistance src.com.dtmilano.android.viewclient.ViewClient.root src.com.dtmilano.android.viewclient.ViewClient-class.html#root src.com.dtmilano.android.viewclient.ViewClient.display src.com.dtmilano.android.viewclient.ViewClient-class.html#display src.com.dtmilano.android.viewclient.ViewClient.findViewWithContentDescriptionOrRaise src.com.dtmilano.android.viewclient.ViewClient-class.html#findViewWithContentDescriptionOrRaise diff --git a/AndroidViewClient/doc/class-tree.html b/AndroidViewClient/doc/class-tree.html index 9a5c4cdb..06827c87 100644 --- a/AndroidViewClient/doc/class-tree.html +++ b/AndroidViewClient/doc/class-tree.html @@ -125,7 +125,7 @@

Class Hierarchy

@@ -304,11 +311,12 @@

Identifier Index

- + - @@ -532,55 +541,55 @@

Identifier Index

- - - - - - + - + + + + + + - - - + - @@ -588,7 +597,7 @@

Identifier Index

- @@ -596,26 +605,41 @@

Identifier Index

- + + + + + + - + - + + + + +
- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 The Navigation Bar - - @@ -156,7 +156,7 @@

Identifier Index

(in src.com.dtmilano.android.viewclient) - @@ -164,8 +164,8 @@

Identifier Index

(in src.com.dtmilano.android.viewclient) - + + + + + +
- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 Identifier Index
DEBUG
(in src.com.dtmilano.android.viewclient)		DEBUG_DEVICE
+		DEBUG_DISTANCE
(in src.com.dtmilano.android.viewclient)		DEBUG_TOUCH
+		DEBUG_TREE
(in src.com.dtmilano.android.viewclient)
DEBUG_GETATTR
(in src.com.dtmilano.android.viewclient)		DEBUG_TREE
+		DEBUG_WINDOWS
(in src.com.dtmilano.android.viewclient)
DEBUG_RECEIVED
(in src.com.dtmilano.android.viewclient)		DEBUG_WINDOWS
-(in src.com.dtmilano.android.viewclient)		distance()
+(in ViewClient)
DEBUG_COORDS
@@ -175,6 +175,13 @@

Identifier Index

dump()
(in ViewClient)
DEBUG_DEVICE
+(in src.com.dtmilano.android.viewclient)		DEBUG_TOUCH
+(in src.com.dtmilano.android.viewclient)		 

E

 + -
hammingDistance()
+(in ViewClient)		 HEIGHT_PROPERTY
(in src.com.dtmilano.android.viewclient)		 HEIGHT_PROPERTY_API_8
(in src.com.dtmilano.android.viewclient)		 
   
@@ -349,12 +357,13 @@

Identifier Index

(in src.com.dtmilano.android.viewclient)		 LEFT_PROPERTY_API_8
(in src.com.dtmilano.android.viewclient)		 list()
+(in ViewClient)
LEFT_PROPERTY
(in src.com.dtmilano.android.viewclient)		list()
+		levenshteinDistance()
(in ViewClient)		  
__call__()
(in View)		__init__()
-(in View)		__obtainStatusBarDimensionsIfVisible()
-(in View)
__del__()
-(in ViewClient)		 __init__()
(in ViewClient)		 __obtainVwVh()
(in View)
__dumpWindowsInformation()
-(in View)		__del__()
+(in ViewClient)		 __init__()
(in ViewNotFoundException)		 __obtainVxVy()
(in View)
__findViewWithAttributeInTree()
-(in ViewClient)		__dumpWindowsInformation()
+(in View)		 __init__()
(in Window)		 __package__
(in src.com.dtmilano.android)
__findViewWithAttributeInTree()
+(in ViewClient)		__levenshteinDistance()
+(in ViewClient)		__parseTree()
+(in ViewClient)
__findViewWithAttributeInTreeOrRaise()
(in ViewClient)		 __mapSerialNo()
(in ViewClient)		__parseTree()
+		__parseTreeFromUiAutomatorDump()
(in ViewClient)
__findViewWithAttributeInTreeThatMatches()
(in ViewClient)		__nd()
-(in src.com.dtmilano.android.viewclient)		__parseTreeFromUiAutomatorDump()
+		__microStr__()
+(in View)		__pickleable()
(in ViewClient)
__getattr__()
(in View)		__nh()
+		__nd()
(in src.com.dtmilano.android.viewclient)		 __smallStr__()
(in View)
__getFocusedWindowPosition()
(in ViewClient)		__ns()
+		__nh()
(in src.com.dtmilano.android.viewclient)		 __splitAttrs()
(in ViewClient)
__getitem__()
(in View)		__obtainAdbPath()
-(in ViewClient)		__ns()
+(in src.com.dtmilano.android.viewclient)		 __str__()
(in View)
__hammingDistance()
+(in ViewClient)		__obtainAdbPath()
+(in ViewClient)		__str__()
+(in Window)
__init__()
(in Excerpt2Code)		 __obtainDeviceSerialNumber()
(in ViewClient)		__str__()
-(in Window)		__tinyStr__()
+(in View)
__init__()
(in UiAutomator2AndroidViewClient)		 __obtainPxPy()
(in View)		__tinyStr__()
+		__traverse()
+(in ViewClient)
__init__()
+(in View)		__obtainStatusBarDimensionsIfVisible()
(in View)		 
@@ -651,7 +675,7 @@

Identifier Index

- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 Module Hierarchy + + +
- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 Package android

- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 Source Code for
- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:24 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:03 2013 Module viewclient

Version: - 2.3.24 + 2.3.25

@@ -337,6 +337,13 @@

Module viewclient

DEBUG_BOUNDS = DEBUG and False

+   + + DEBUG_DISTANCE = DEBUG and False +
  @@ -730,7 +737,7 @@

SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED

- Generated by Epydoc 3.0.1 on Wed Jun 19 00:21:21 2013 + Generated by Epydoc 3.0.1 on Tue Jul 9 02:16:01 2013 Source Code for 17 @author: Diego Torres Milano 18 ''' 19 - 20 __version__ = '2.3.24' + 20 __version__ = '2.3.25' 21 22 import sys 23 import subprocess @@ -95,2184 +95,2394 @@

Source Code for 29 import time 30 import signal 31 import warnings - 32 import xml.parsers.expat - 33 import org.python.modules.sre.PatternObject - 34 from com.android.monkeyrunner import MonkeyDevice, MonkeyRunner - 35 - 36 DEBUG = False - 37 DEBUG_DEVICE = DEBUG and False - 38 DEBUG_RECEIVED = DEBUG and False - 39 DEBUG_TREE = DEBUG and False - 40 DEBUG_GETATTR = DEBUG and False - 41 DEBUG_CALL = DEBUG and False - 42 DEBUG_COORDS = DEBUG and False - 43 DEBUG_TOUCH = DEBUG and False - 44 DEBUG_STATUSBAR = DEBUG and False - 45 DEBUG_WINDOWS = DEBUG and False - 46 DEBUG_BOUNDS = DEBUG and False - 47 - 48 WARNINGS = False - 49 - 50 VIEW_SERVER_HOST = 'localhost' - 51 VIEW_SERVER_PORT = 4939 + 32 import copy + 33 import pickle + 34 import xml.parsers.expat + 35 import org.python.modules.sre.PatternObject + 36 from com.android.monkeyrunner import MonkeyDevice, MonkeyRunner + 37 + 38 DEBUG = False + 39 DEBUG_DEVICE = DEBUG and False + 40 DEBUG_RECEIVED = DEBUG and False + 41 DEBUG_TREE = DEBUG and False + 42 DEBUG_GETATTR = DEBUG and False + 43 DEBUG_CALL = DEBUG and False + 44 DEBUG_COORDS = DEBUG and False + 45 DEBUG_TOUCH = DEBUG and False + 46 DEBUG_STATUSBAR = DEBUG and False + 47 DEBUG_WINDOWS = DEBUG and False + 48 DEBUG_BOUNDS = DEBUG and False + 49 DEBUG_DISTANCE = DEBUG and False + 50 + 51 WARNINGS = False 52 - 53 ADB_DEFAULT_PORT = 5555 - 54 - 55 OFFSET = 25 - 56 ''' This assumes the smallest touchable view on the screen is approximately 50px x 50px - 57 and touches it at M{(x+OFFSET, y+OFFSET)} ''' - 58 - 59 USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES = True - 60 ''' Use monkeyrunner (C{MonkeyDevice.getProperty()}) to obtain the needed properties. If this is - 61 C{False} then C{adb shell getprop} is used ''' - 62 - 63 SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED = False - 64 ''' Skips some classes related with the Action Bar and the PhoneWindow$DecorView in the - 65 coordinates calculation - 66 @see: L{View.getXY()} ''' - 67 - 68 # some device properties - 69 VERSION_SDK_PROPERTY = 'version.sdk' + 53 VIEW_SERVER_HOST = 'localhost' + 54 VIEW_SERVER_PORT = 4939 + 55 + 56 ADB_DEFAULT_PORT = 5555 + 57 + 58 OFFSET = 25 + 59 ''' This assumes the smallest touchable view on the screen is approximately 50px x 50px + 60 and touches it at M{(x+OFFSET, y+OFFSET)} ''' + 61 + 62 USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES = True + 63 ''' Use monkeyrunner (C{MonkeyDevice.getProperty()}) to obtain the needed properties. If this is + 64 C{False} then C{adb shell getprop} is used ''' + 65 + 66 SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED = False + 67 ''' Skips some classes related with the Action Bar and the PhoneWindow$DecorView in the + 68 coordinates calculation + 69 @see: L{View.getXY()} ''' 70 - 71 # some constants for the attributes - 72 ID_PROPERTY = 'mID' - 73 ID_PROPERTY_UI_AUTOMATOR = 'uniqueId' - 74 TEXT_PROPERTY = 'text:mText' - 75 TEXT_PROPERTY_API_10 = 'mText' - 76 TEXT_PROPERTY_UI_AUTOMATOR = 'text' - 77 WS = "\xfe" # the whitespace replacement char for TEXT_PROPERTY - 78 LEFT_PROPERTY = 'layout:mLeft' - 79 LEFT_PROPERTY_API_8 = 'mLeft' - 80 TOP_PROPERTY = 'layout:mTop' - 81 TOP_PROPERTY_API_8 = 'mTop' - 82 WIDTH_PROPERTY = 'layout:getWidth()' - 83 WIDTH_PROPERTY_API_8 = 'getWidth()' - 84 HEIGHT_PROPERTY = 'layout:getHeight()' - 85 HEIGHT_PROPERTY_API_8 = 'getHeight()' - 86 GET_VISIBILITY_PROPERTY = 'getVisibility()' - 87 LAYOUT_TOP_MARGIN_PROPERTY = 'layout:layout_topMargin' - 88 - 89 # visibility - 90 VISIBLE = 0x0 - 91 INVISIBLE = 0x4 - 92 GONE = 0x8 - 93 - 94 IP_RE = re.compile('^(\d{1,3}\.){3}\d{1,3}$') - 95 ID_RE = re.compile('id/([^/]*)(/(\d+))?') -
96 - 97 -def __nd(name): -
98 ''' - 99 @return: Returns a named decimal regex - 100 ''' - 101 return '(?P<%s>\d+)' % name -
102 -
103 -def __nh(name): -
104 ''' - 105 @return: Returns a named hex regex - 106 ''' - 107 return '(?P<%s>[0-9a-f]+)' % name -
108 -
109 -def __ns(name, greedy=False): -
110 ''' - 111 NOTICE: this is using a non-greedy (or minimal) regex - 112 - 113 @type name: str - 114 @param name: the name used to tag the expression - 115 @type greedy: bool - 116 @param greedy: Whether the regex is greedy or not - 117 - 118 @return: Returns a named string regex (only non-whitespace characters allowed) - 119 ''' - 120 return '(?P<%s>\S+%s)' % (name, '' if greedy else '?') -
121 -
122 - 123 -class Window: -
124 ''' - 125 Window class - 126 ''' - 127 -
128 - def __init__(self, num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility): -
129 ''' - 130 Constructor - 131 - 132 @type num: int - 133 @param num: Ordering number in Window Manager - 134 @type winId: str - 135 @param winId: the window ID - 136 @type activity: str - 137 @param activity: the activity (or sometimes other component) owning the window - 138 @type wvx: int - 139 @param wvx: window's virtual X - 140 @type wvy: int - 141 @param wvy: window's virtual Y - 142 @type wvw: int - 143 @param wvw: window's virtual width - 144 @type wvh: int - 145 @param wvh: window's virtual height - 146 @type px: int - 147 @param px: parent's X - 148 @type py: int - 149 @param py: parent's Y - 150 @type visibility: int - 151 @param visibility: visibility of the window - 152 ''' - 153 - 154 if DEBUG_COORDS: print >> sys.stderr, "Window(%d, %s, %s, %d, %d, %d, %d, %d, %d, %d)" % \ - 155 (num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility) - 156 self.num = num - 157 self.winId = winId - 158 self.activity = activity - 159 self.wvx = wvx - 160 self.wvy = wvy - 161 self.wvw = wvw - 162 self.wvh = wvh - 163 self.px = px - 164 self.py = py - 165 self.visibility = visibility -
166 -
167 - def __str__(self): -
168 return "Window(%d, wid=%s, a=%s, x=%d, y=%d, w=%d, h=%d, px=%d, py=%d, v=%d)" % \ - 169 (self.num, self.winId, self.activity, self.wvx, self.wvy, self.wvw, self.wvh, self.px, self.py, self.visibility) -
170 -
171 - 172 -class ViewNotFoundException(Exception): -
173 ''' - 174 ViewNotFoundException is raised when a View is not found. - 175 ''' - 176 -
177 - def __init__(self, attr, value, root): -
178 if isinstance(value, org.python.modules.sre.PatternObject): - 179 msg = "Couldn't find View with %s that matches '%s' in tree with root=%s" % (attr, value.pattern, root) - 180 else: - 181 msg = "Couldn't find View with %s='%s' in tree with root=%s" % (attr, value, root) - 182 super(Exception, self). 71 # some device properties + 72 VERSION_SDK_PROPERTY = 'version.sdk' + 73 + 74 # some constants for the attributes + 75 ID_PROPERTY = 'mID' + 76 ID_PROPERTY_UI_AUTOMATOR = 'uniqueId' + 77 TEXT_PROPERTY = 'text:mText' + 78 TEXT_PROPERTY_API_10 = 'mText' + 79 TEXT_PROPERTY_UI_AUTOMATOR = 'text' + 80 WS = "\xfe" # the whitespace replacement char for TEXT_PROPERTY + 81 LEFT_PROPERTY = 'layout:mLeft' + 82 LEFT_PROPERTY_API_8 = 'mLeft' + 83 TOP_PROPERTY = 'layout:mTop' + 84 TOP_PROPERTY_API_8 = 'mTop' + 85 WIDTH_PROPERTY = 'layout:getWidth()' + 86 WIDTH_PROPERTY_API_8 = 'getWidth()' + 87 HEIGHT_PROPERTY = 'layout:getHeight()' + 88 HEIGHT_PROPERTY_API_8 = 'getHeight()' + 89 GET_VISIBILITY_PROPERTY = 'getVisibility()' + 90 LAYOUT_TOP_MARGIN_PROPERTY = 'layout:layout_topMargin' + 91 + 92 # visibility + 93 VISIBLE = 0x0 + 94 INVISIBLE = 0x4 + 95 GONE = 0x8 + 96 + 97 IP_RE = re.compile('^(\d{1,3}\.){3}\d{1,3}$') + 98 ID_RE = re.compile('id/([^/]*)(/(\d+))?') +
99 + 100 -def __nd(name): +
101 ''' + 102 @return: Returns a named decimal regex + 103 ''' + 104 return '(?P<%s>\d+)' % name +
105 +
106 -def __nh(name): +
107 ''' + 108 @return: Returns a named hex regex + 109 ''' + 110 return '(?P<%s>[0-9a-f]+)' % name +
111 +
112 -def __ns(name, greedy=False): +
113 ''' + 114 NOTICE: this is using a non-greedy (or minimal) regex + 115 + 116 @type name: str + 117 @param name: the name used to tag the expression + 118 @type greedy: bool + 119 @param greedy: Whether the regex is greedy or not + 120 + 121 @return: Returns a named string regex (only non-whitespace characters allowed) + 122 ''' + 123 return '(?P<%s>\S+%s)' % (name, '' if greedy else '?') +
124 +
125 + 126 -class Window: +
127 ''' + 128 Window class + 129 ''' + 130 +
131 - def __init__(self, num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility): +
132 ''' + 133 Constructor + 134 + 135 @type num: int + 136 @param num: Ordering number in Window Manager + 137 @type winId: str + 138 @param winId: the window ID + 139 @type activity: str + 140 @param activity: the activity (or sometimes other component) owning the window + 141 @type wvx: int + 142 @param wvx: window's virtual X + 143 @type wvy: int + 144 @param wvy: window's virtual Y + 145 @type wvw: int + 146 @param wvw: window's virtual width + 147 @type wvh: int + 148 @param wvh: window's virtual height + 149 @type px: int + 150 @param px: parent's X + 151 @type py: int + 152 @param py: parent's Y + 153 @type visibility: int + 154 @param visibility: visibility of the window + 155 ''' + 156 + 157 if DEBUG_COORDS: print >> sys.stderr, "Window(%d, %s, %s, %d, %d, %d, %d, %d, %d, %d)" % \ + 158 (num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility) + 159 self.num = num + 160 self.winId = winId + 161 self.activity = activity + 162 self.wvx = wvx + 163 self.wvy = wvy + 164 self.wvw = wvw + 165 self.wvh = wvh + 166 self.px = px + 167 self.py = py + 168 self.visibility = visibility +
169 +
170 - def __str__(self): +
171 return "Window(%d, wid=%s, a=%s, x=%d, y=%d, w=%d, h=%d, px=%d, py=%d, v=%d)" % \ + 172 (self.num, self.winId, self.activity, self.wvx, self.wvy, self.wvw, self.wvh, self.px, self.py, self.visibility) +
173 +
174 + 175 -class ViewNotFoundException(Exception): +
176 ''' + 177 ViewNotFoundException is raised when a View is not found. + 178 ''' + 179 +
180 - def __init__(self, attr, value, root): +
181 if isinstance(value, org.python.modules.sre.PatternObject): + 182 msg = "Couldn't find View with %s that matches '%s' in tree with root=%s" % (attr, value.pattern, root) + 183 else: + 184 msg = "Couldn't find View with %s='%s' in tree with root=%s" % (attr, value, root) + 185 super(Exception, self).__init__(msg) -
183 -
184 -class View: -
185 ''' - 186 View class - 187 ''' - 188 - 189 @staticmethod -
190 - def factory(attrs, device, version=-1, forceviewserveruse=False): -
191 ''' - 192 View factory - 193 ''' - 194 - 195 if attrs.has_key('class'): - 196 clazz = attrs['class'] - 197 if clazz == 'android.widget.TextView': - 198 return TextView(attrs, device, version, forceviewserveruse) - 199 elif clazz == 'android.widget.EditText': - 200 return EditText(attrs, device, version, forceviewserveruse) - 201 else: - 202 return View(attrs, device, version, forceviewserveruse) - 203 else: - 204 return View(attrs, device, version, forceviewserveruse) -
205 -
206 - def __init__(self, map, device, version=-1, forceviewserveruse=False): -
207 ''' - 208 Constructor - 209 - 210 @type map: map - 211 @param map: the map containing the (attribute, value) pairs - 212 @type device: MonkeyDevice - 213 @param device: the device containing this View - 214 @type version: int - 215 @param version: the Android SDK version number of the platform where this View belongs. If - 216 this is C{-1} then the Android SDK version will be obtained in this - 217 constructor. - 218 @type forceviewserveruse: boolean - 219 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions were given - 220 to use C{UiAutomator}. - 221 ''' - 222 - 223 self.map = map - 224 ''' The map that contains the C{attr},C{value} pairs ''' - 225 self.device = device - 226 ''' The MonkeyDevice ''' - 227 self.children = [] - 228 ''' The children of this View ''' - 229 self.parent = None - 230 ''' The parent of this View ''' - 231 self.windows = {} - 232 self.currentFocus = None - 233 ''' The current focus ''' - 234 self.build = {} - 235 ''' Build properties ''' - 236 - 237 if version != -1: - 238 self.build[VERSION_SDK_PROPERTY] = version - 239 else: - 240 try: - 241 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: - 242 self.build[VERSION_SDK_PROPERTY] = int(device.getProperty('build.' + VERSION_SDK_PROPERTY)) - 243 else: - 244 self.build[VERSION_SDK_PROPERTY] = int(device.shell('getprop ro.build.' + VERSION_SDK_PROPERTY)[:-2]) - 245 except: - 246 self.build[VERSION_SDK_PROPERTY] = -1 - 247 - 248 version = self.build[VERSION_SDK_PROPERTY] - 249 self.useUiAutomator = (version >= 16) and not forceviewserveruse - 250 ''' Whether to use UIAutomator or ViewServer ''' - 251 self.idProperty = None - 252 ''' The id property depending on the View attribute format ''' - 253 self.textProperty = None - 254 ''' The text property depending on the View attribute format ''' - 255 self.leftProperty = None - 256 ''' The left property depending on the View attribute format ''' - 257 self.topProperty = None - 258 ''' The top property depending on the View attribute format ''' - 259 self.widthProperty = None - 260 ''' The width property depending on the View attribute format ''' - 261 self.heightProperty = None - 262 ''' The height property depending on the View attribute format ''' - 263 if version >= 16 and self.useUiAutomator: - 264 self.idProperty = ID_PROPERTY_UI_AUTOMATOR - 265 self.textProperty = TEXT_PROPERTY_UI_AUTOMATOR - 266 self.leftProperty = LEFT_PROPERTY - 267 self.topProperty = TOP_PROPERTY - 268 self.widthProperty = WIDTH_PROPERTY - 269 self.heightProperty = HEIGHT_PROPERTY - 270 elif version > 10 and (version < 16 or self.useUiAutomator): - 271 self.idProperty = ID_PROPERTY - 272 self.textProperty = TEXT_PROPERTY - 273 self.leftProperty = LEFT_PROPERTY - 274 self.topProperty = TOP_PROPERTY - 275 self.widthProperty = WIDTH_PROPERTY - 276 self.heightProperty = HEIGHT_PROPERTY - 277 elif version == 10: - 278 self.idProperty = ID_PROPERTY - 279 self.textProperty = TEXT_PROPERTY_API_10 - 280 self.leftProperty = LEFT_PROPERTY - 281 self.topProperty = TOP_PROPERTY - 282 self.widthProperty = WIDTH_PROPERTY - 283 self.heightProperty = HEIGHT_PROPERTY - 284 elif version >= 7 and version < 10: - 285 self.idProperty = ID_PROPERTY - 286 self.textProperty = TEXT_PROPERTY_API_10 - 287 self.leftProperty = LEFT_PROPERTY_API_8 - 288 self.topProperty = TOP_PROPERTY_API_8 - 289 self.widthProperty = WIDTH_PROPERTY_API_8 - 290 self.heightProperty = HEIGHT_PROPERTY_API_8 - 291 elif version > 0 and version < 7: - 292 self.idProperty = ID_PROPERTY - 293 self.textProperty = TEXT_PROPERTY_API_10 - 294 self.leftProperty = LEFT_PROPERTY - 295 self.topProperty = TOP_PROPERTY - 296 self.widthProperty = WIDTH_PROPERTY - 297 self.heightProperty = HEIGHT_PROPERTY - 298 elif version == -1: - 299 self.idProperty = ID_PROPERTY - 300 self.textProperty = TEXT_PROPERTY - 301 self.leftProperty = LEFT_PROPERTY - 302 self.topProperty = TOP_PROPERTY - 303 self.widthProperty = WIDTH_PROPERTY - 304 self.heightProperty = HEIGHT_PROPERTY - 305 else: - 306 self.idProperty = ID_PROPERTY - 307 self.textProperty = TEXT_PROPERTY - 308 self.leftProperty = LEFT_PROPERTY - 309 self.topProperty = TOP_PROPERTY - 310 self.widthProperty = WIDTH_PROPERTY - 311 self.heightProperty = HEIGHT_PROPERTY -
312 -
313 - def __getitem__(self, key): -
314 return self.map[key] +src.com.dtmilano.android.viewclient.Window.__init__" class="py-name" href="#" onclick="return doclink('link-54', '__init__', 'link-54');">__init__(msg) +
186 +
187 -class View: +
188 ''' + 189 View class + 190 ''' + 191 + 192 @staticmethod +
193 - def factory(attrs, device, version=-1, forceviewserveruse=False): +
194 ''' + 195 View factory + 196 ''' + 197 + 198 if attrs.has_key('class'): + 199 clazz = attrs['class'] + 200 if clazz == 'android.widget.TextView': + 201 return TextView(attrs, device, version, forceviewserveruse) + 202 elif clazz == 'android.widget.EditText': + 203 return EditText(attrs, device, version, forceviewserveruse) + 204 else: + 205 return View(attrs, device, version, forceviewserveruse) + 206 else: + 207 return View(attrs, device, version, forceviewserveruse) +
208 +
209 - def __init__(self, map, device, version=-1, forceviewserveruse=False): +
210 ''' + 211 Constructor + 212 + 213 @type map: map + 214 @param map: the map containing the (attribute, value) pairs + 215 @type device: MonkeyDevice + 216 @param device: the device containing this View + 217 @type version: int + 218 @param version: the Android SDK version number of the platform where this View belongs. If + 219 this is C{-1} then the Android SDK version will be obtained in this + 220 constructor. + 221 @type forceviewserveruse: boolean + 222 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions were given + 223 to use C{UiAutomator}. + 224 ''' + 225 + 226 self.map = map + 227 ''' The map that contains the C{attr},C{value} pairs ''' + 228 self.device = device + 229 ''' The MonkeyDevice ''' + 230 self.children = [] + 231 ''' The children of this View ''' + 232 self.parent = None + 233 ''' The parent of this View ''' + 234 self.windows = {} + 235 self.currentFocus = None + 236 ''' The current focus ''' + 237 self.build = {} + 238 ''' Build properties ''' + 239 + 240 if version != -1: + 241 self.build[VERSION_SDK_PROPERTY] = version + 242 else: + 243 try: + 244 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: + 245 self.build[VERSION_SDK_PROPERTY] = int(device.getProperty('build.' + VERSION_SDK_PROPERTY)) + 246 else: + 247 self.build[VERSION_SDK_PROPERTY] = int(device.shell('getprop ro.build.' + VERSION_SDK_PROPERTY)[:-2]) + 248 except: + 249 self.build[VERSION_SDK_PROPERTY] = -1 + 250 + 251 version = self.build[VERSION_SDK_PROPERTY] + 252 self.useUiAutomator = (version >= 16) and not forceviewserveruse + 253 ''' Whether to use UIAutomator or ViewServer ''' + 254 self.idProperty = None + 255 ''' The id property depending on the View attribute format ''' + 256 self.textProperty = None + 257 ''' The text property depending on the View attribute format ''' + 258 self.leftProperty = None + 259 ''' The left property depending on the View attribute format ''' + 260 self.topProperty = None + 261 ''' The top property depending on the View attribute format ''' + 262 self.widthProperty = None + 263 ''' The width property depending on the View attribute format ''' + 264 self.heightProperty = None + 265 ''' The height property depending on the View attribute format ''' + 266 if version >= 16 and self.useUiAutomator: + 267 self.idProperty = ID_PROPERTY_UI_AUTOMATOR + 268 self.textProperty = TEXT_PROPERTY_UI_AUTOMATOR + 269 self.leftProperty = LEFT_PROPERTY + 270 self.topProperty = TOP_PROPERTY + 271 self.widthProperty = WIDTH_PROPERTY + 272 self.heightProperty = HEIGHT_PROPERTY + 273 elif version > 10 and (version < 16 or self.useUiAutomator): + 274 self.idProperty = ID_PROPERTY + 275 self.textProperty = TEXT_PROPERTY + 276 self.leftProperty = LEFT_PROPERTY + 277 self.topProperty = TOP_PROPERTY + 278 self.widthProperty = WIDTH_PROPERTY + 279 self.heightProperty = HEIGHT_PROPERTY + 280 elif version == 10: + 281 self.idProperty = ID_PROPERTY + 282 self.textProperty = TEXT_PROPERTY_API_10 + 283 self.leftProperty = LEFT_PROPERTY + 284 self.topProperty = TOP_PROPERTY + 285 self.widthProperty = WIDTH_PROPERTY + 286 self.heightProperty = HEIGHT_PROPERTY + 287 elif version >= 7 and version < 10: + 288 self.idProperty = ID_PROPERTY + 289 self.textProperty = TEXT_PROPERTY_API_10 + 290 self.leftProperty = LEFT_PROPERTY_API_8 + 291 self.topProperty = TOP_PROPERTY_API_8 + 292 self.widthProperty = WIDTH_PROPERTY_API_8 + 293 self.heightProperty = HEIGHT_PROPERTY_API_8 + 294 elif version > 0 and version < 7: + 295 self.idProperty = ID_PROPERTY + 296 self.textProperty = TEXT_PROPERTY_API_10 + 297 self.leftProperty = LEFT_PROPERTY + 298 self.topProperty = TOP_PROPERTY + 299 self.widthProperty = WIDTH_PROPERTY + 300 self.heightProperty = HEIGHT_PROPERTY + 301 elif version == -1: + 302 self.idProperty = ID_PROPERTY + 303 self.textProperty = TEXT_PROPERTY + 304 self.leftProperty = LEFT_PROPERTY + 305 self.topProperty = TOP_PROPERTY + 306 self.widthProperty = WIDTH_PROPERTY + 307 self.heightProperty = HEIGHT_PROPERTY + 308 else: + 309 self.idProperty = ID_PROPERTY + 310 self.textProperty = TEXT_PROPERTY + 311 self.leftProperty = LEFT_PROPERTY + 312 self.topProperty = TOP_PROPERTY + 313 self.widthProperty = WIDTH_PROPERTY + 314 self.heightProperty = HEIGHT_PROPERTY
315 -
316 - def __getattr__(self, name): -
317 if DEBUG_GETATTR: - 318 print >>sys.stderr, "__getattr__(%s) version: %d" % (name, self.build[VERSION_SDK_PROPERTY]) - 319 - 320 # NOTE: - 321 # I should try to see if 'name' is a defined method - 322 # but it seems that if I call locals() here an infinite loop is entered - 323 - 324 if self.map.has_key(name): - 325 r = self.map[name] - 326 elif self.map.has_key(name + '()'): - 327 # the method names are stored in the map with their trailing '()' - 328 r = self.map[name + '()'] - 329 elif name.count("_") > 0: - 330 mangledList = self.allPossibleNamesWithColon(name) - 331 mangledName = self.intersection(mangledList, self.map.keys()) - 332 if len(mangledName) > 0 and self.map.has_key(mangledName[0]): - 333 r = self.map[mangledName[0]] - 334 else: - 335 # Default behavior - 336 raise AttributeError, name - 337 else: - 338 # try removing 'is' prefix - 339 if DEBUG_GETATTR: - 340 print >> sys.stderr, " __getattr__: trying without 'is' prefix" - 341 suffix = name[2:].lower() - 342 if self.map.has_key(suffix): - 343 r = self.map[suffix] - 344 else: - 345 # Default behavior - 346 raise AttributeError, name - 347 - 348 # if the method name starts with 'is' let's assume its return value is boolean - 349 # if name[:2] == 'is': - 350 # r = True if r == 'true' else False - 351 if r == 'true': - 352 r = True - 353 elif r == 'false': - 354 r = False - 355 - 356 # this should not cached in some way - 357 def innerMethod(): - 358 if DEBUG_GETATTR: - 359 print >>sys.stderr, "innerMethod: %s returning %s" % (innerMethod.__name__, r) - 360 return r -
361 - 362 innerMethod.__name__ = name - 363 - 364 # this should work, but then there's problems with the arguments of innerMethod - 365 # even if innerMethod(self) is added - 366 #setattr(View, innerMethod.__name__, innerMethod) - 367 #setattr(self, innerMethod.__name__, innerMethod) - 368 - 369 return innerMethod -
370 -
371 - def __call__(self, *args, **kwargs): -
372 if DEBUG_CALL: - 373 print >>sys.stderr, "__call__(%s)" % (args if args else None) -
374 -
375 - def getClass(self): -
376 ''' - 377 Gets the L{View} class - 378 - 379 @return: the L{View} class or C{None} if not defined - 380 ''' - 381 - 382 try: - 383 return self.map['class'] - 384 except: - 385 return None -
386 -
387 - def getId(self): -
388 ''' - 389 Gets the L{View} Id - 390 - 391 @return: the L{View} C{Id} or C{None} if not defined - 392 @see: L{getUniqueId()} - 393 ''' - 394 - 395 try: - 396 return self.map[self.idProperty] - 397 except: - 398 return None -
399 -
400 - def getContentDescription(self): -
401 ''' - 402 Gets the content description. - 403 ''' - 404 - 405 try: - 406 return self.map['content-desc'] - 407 except: - 408 return None -
409 -
410 - def getParent(self): -
411 ''' - 412 Gets the parent. - 413 ''' - 414 - 415 return self.parent -
416 -
417 - def getText(self): -
418 ''' - 419 Gets the text attribute. - 420 - 421 @return: the text attribute or C{None} if not defined - 422 ''' - 423 - 424 try: - 425 return self.map[self.textProperty] - 426 except Exception: - 427 return None -
428 -
429 - def getHeight(self): -
430 ''' - 431 Gets the height. - 432 ''' - 433 - 434 if self.useUiAutomator: - 435 return self.map['bounds'][1][1] - self.map['bounds'][0][1] - 436 else: - 437 try: - 438 return int(self.map[self.heightProperty]) - 439 except: - 440 return 0 -
441 -
442 - def getWidth(self): -
443 ''' - 444 Gets the width. - 445 ''' - 446 - 447 if self.useUiAutomator: - 448 return self.map['bounds'][1][0] - self.map['bounds'][0][0] - 449 else: - 450 try: - 451 return int(self.map[self.widthProperty]) - 452 except: - 453 return 0 -
454 -
455 - def getUniqueId(self): -
456 ''' - 457 Gets the unique Id of this View. - 458 - 459 @see: L{ViewClient.__splitAttrs()} for a discussion on B{Unique Ids} - 460 ''' - 461 - 462 try: - 463 return self.map['uniqueId'] - 464 except: - 465 return None -
466 -
467 - def getVisibility(self): -
468 ''' - 469 Gets the View visibility - 470 ''' - 471 - 472 try: - 473 if self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': - 474 return VISIBLE - 475 elif self.map[GET_VISIBILITY_PROPERTY] == 'INVISIBLE': - 476 return INVISIBLE - 477 elif self.map[GET_VISIBILITY_PROPERTY] == 'GONE': - 478 return GONE - 479 else: - 480 return -2 - 481 except: - 482 return -1 -
483 -
484 - def getX(self): -
485 ''' - 486 Gets the View X coordinate - 487 ''' - 488 - 489 if DEBUG_COORDS: - 490 print >>sys.stderr, "getX(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) - 491 x = 0 - 492 - 493 if self.useUiAutomator: - 494 x = self.map['bounds'][0][0] - 495 else: - 496 try: - 497 if GET_VISIBILITY_PROPERTY in self.map and self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': - 498 _x = int(self.map[self.leftProperty]) - 499 if DEBUG_COORDS: print >>sys.stderr, " getX: VISIBLE adding %d" % _x - 500 x += _x - 501 except: - 502 warnings.warn("View %s has no '%s' property" % (self.getId(), self.leftProperty)) - 503 - 504 if DEBUG_COORDS: print >>sys.stderr, " getX: returning %d" % (x) - 505 return x -
506 -
507 - def getY(self): -
508 ''' - 509 Gets the View Y coordinate - 510 ''' - 511 - 512 if DEBUG_COORDS: - 513 print >>sys.stderr, "getY(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) - 514 y = 0 - 515 - 516 if self.useUiAutomator: - 517 y = self.map['bounds'][0][1] - 518 else: - 519 try: - 520 if GET_VISIBILITY_PROPERTY in self.map and self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': - 521 _y = int(self.map[self.topProperty]) - 522 if DEBUG_COORDS: print >>sys.stderr, " getY: VISIBLE adding %d" % _y - 523 y += _y - 524 except: - 525 warnings.warn("View %s has no '%s' property" % (self.getId(), self.topProperty)) - 526 - 527 if DEBUG_COORDS: print >>sys.stderr, " getY: returning %d" % (y) - 528 return y -
529 -
530 - def getXY(self, debug=False): -
531 ''' - 532 Returns the I{screen} coordinates of this C{View}. - 533 - 534 @return: The I{screen} coordinates of this C{View} - 535 ''' - 536 - 537 if DEBUG_COORDS or debug: - 538 try: - 539 id = self.getId() - 540 except: - 541 id = "NO_ID" - 542 print >> sys.stderr, "getXY(%s %s ## %s)" % (self.getClass(), id, self.getUniqueId()) - 543 - 544 x = self.getX() - 545 y = self.getY() - 546 parent = self.parent - 547 if DEBUG_COORDS: print >> sys.stderr, " getXY: x=%s y=%s parent=%s" % (x, y, parent.getUniqueId() if parent else "None") - 548 hx = 0 - 549 ''' Hierarchy accumulated X ''' - 550 hy = 0 - 551 ''' Hierarchy accumulated Y ''' - 552 - 553 if not self.useUiAutomator: - 554 if DEBUG_COORDS: print >> sys.stderr, " getXY: not using UiAutomator, calculating ancestors coordinates" - 555 while parent != None: - 556 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent: %s %s <<<<" % (parent.getClass() if parent else "None", parent.getUniqueId() if parent else "None") - 557 if SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED: - 558 if parent.getClass() in [ 'com.android.internal.widget.ActionBarView', - 559 'com.android.internal.widget.ActionBarContextView', - 560 'com.android.internal.view.menu.ActionMenuView', - 561 'com.android.internal.policy.impl.PhoneWindow$DecorView' ]: - 562 if DEBUG_COORDS: print >> sys.stderr, " getXY: skipping %s %s (%d,%d)" % (parent.getClass(), parent.getUniqueId(), parent.getX(), parent.getY()) - 563 parent = parent.parent - 564 continue - 565 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent=%s x=%d hx=%d y=%d hy=%d" % (parent.getUniqueId(), parent.getX(), hx, parent.getY(), hy) - 566 hx += parent.getX() - 567 hy += parent.getY() - 568 parent = parent.parent - 569 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent=%s hx=%d hy=%d (end of loop)" % (parent.getUniqueId() if parent else "None", hx, hy) - 570 - 571 (wvx, wvy) = self.__dumpWindowsInformation(debug=debug) - 572 if DEBUG_COORDS or debug: - 573 print >>sys.stderr, " getXY: wv=(%d, %d) (windows information)" % (wvx, wvy) - 574 try: - 575 fw = self.windows[self.currentFocus] - 576 if DEBUG_STATUSBAR: - 577 print >> sys.stderr, " getXY: focused window=", fw - 578 print >> sys.stderr, " getXY: deciding whether to consider statusbar offset because current focused windows is at", (fw.wvx, fw.wvy), "parent", (fw.px, fw.py) - 579 except KeyError: - 580 fw = None - 581 (sbw, sbh) = self.__obtainStatusBarDimensionsIfVisible() - 582 if DEBUG_COORDS or debug: - 583 print >>sys.stderr, " getXY: sb=(%d, %d) (statusbar dimensions)" % (sbw, sbh) - 584 statusBarOffset = 0 - 585 pwx = 0 - 586 pwy = 0 - 587 - 588 if fw: - 589 if DEBUG_COORDS: - 590 print >>sys.stderr, " getXY: focused window=", fw, "sb=", (sbw, sbh) - 591 if fw.wvy <= sbh: # it's very unlikely that fw.wvy < sbh, that is a window over the statusbar - 592 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: yes, considering offset=", sbh - 593 statusBarOffset = sbh - 594 else: - 595 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: no, ignoring statusbar offset fw.wvy=", fw.wvy, ">", sbh - 596 - 597 if fw.py == fw.wvy: - 598 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: but wait, fw.py == fw.wvy so we are adjusting by ", (fw.px, fw.py) - 599 pwx = fw.px - 600 pwy = fw.py - 601 else: - 602 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: fw.py=%d <= fw.wvy=%d, no adjustment" % (fw.py, fw.wvy) - 603 - 604 if DEBUG_COORDS or DEBUG_STATUSBAR or debug: - 605 print >>sys.stderr, " getXY: returning (%d, %d) ***" % (x+hx+wvx+pwx, y+hy+wvy-statusBarOffset+pwy) - 606 print >>sys.stderr, " x=%d+%d+%d+%d" % (x,hx,wvx,pwx) - 607 print >>sys.stderr, " y=%d+%d+%d-%d+%d" % (y,hy,wvy,statusBarOffset,pwy) - 608 return (x+hx+wvx+pwx, y+hy+wvy-statusBarOffset+pwy) -
609 -
610 - def getCoords(self): -
611 ''' - 612 Gets the coords of the View - 613 - 614 @return: A tuple containing the View's coordinates (L, T, R, B) - 615 ''' - 616 - 617 if DEBUG_COORDS: - 618 print >>sys.stderr, "getCoords(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) - 619 - 620 (x, y) = self.getXY(); - 621 w = self.getWidth() - 622 h = self.getHeight() - 623 return ((x, y), (x+w, y+h)) -
624 -
625 - def getPositionAndSize(self): -
626 ''' - 627 Gets the position and size (X,Y, W, H) - 628 - 629 @return: A tuple containing the View's coordinates (X, Y, W, H) - 630 ''' - 631 - 632 (x, y) = self.getXY(); - 633 w = self.getWidth() - 634 h = self.getHeight() - 635 return (x, y, w, h) -
636 - 637 -
638 - def getCenter(self): -
639 ''' - 640 Gets the center coords of the View - 641 - 642 @author: U{Dean Morin <https://github.com/deanmorin>} - 643 ''' - 644 - 645 (left, top), (right, bottom) = self.getCoords() - 646 x = left + (right - left) / 2 - 647 y = top + (bottom - top) / 2 - 648 return (x, y) -
649 -
650 - def __obtainStatusBarDimensionsIfVisible(self): -
651 sbw = 0 - 652 sbh = 0 - 653 for winId in self.windows: - 654 w = self.windows[winId] - 655 if DEBUG_COORDS: print >> sys.stderr, " __obtainStatusBarDimensionsIfVisible: w=", w, " w.activity=", w.activity, "%%%" - 656 if w.activity == 'StatusBar': - 657 if w.wvy == 0 and w.visibility == 0: - 658 if DEBUG_COORDS: print >> sys.stderr, " __obtainStatusBarDimensionsIfVisible: statusBar=", (w.wvw, w.wvh) - 659 sbw = w.wvw - 660 sbh = w.wvh - 661 break - 662 - 663 return (sbw, sbh) -
664 -
665 - def __obtainVxVy(self, m): -
666 wvx = int(m.group('vx')) - 667 wvy = int(m.group('vy')) - 668 return wvx, wvy -
669 -
670 - def __obtainVwVh(self, m): -
671 (wvx, wvy) = self.__obtainVxVy(m) - 672 wvx1 = int(m.group('vx1')) - 673 wvy1 = int(m.group('vy1')) - 674 return (wvx1-wvx, wvy1-wvy) -
675 -
676 - def __obtainPxPy(self, m): -
677 px = int(m.group('px')) - 678 py = int(m.group('py')) - 679 return (px, py) -
680 -
681 - def __dumpWindowsInformation(self, debug=False): -
682 self.windows = {} - 683 self.currentFocus = None - 684 dww = self.device.shell('dumpsys window windows') - 685 if DEBUG_WINDOWS or debug: print >> sys.stderr, dww - 686 lines = dww.split('\n') - 687 widRE = re.compile('^ *Window #%s Window{%s (u\d+ )?%s?.*}:' % - 688 (__nd('num'), __nh('winId'), __ns('activity', greedy=True))) - 689 currentFocusRE = re.compile('^ mCurrentFocus=Window{%s .*' % __nh('winId')) - 690 viewVisibilityRE = re.compile(' mViewVisibility=0x%s ' % __nh('visibility')) - 691 # This is for 4.0.4 API-15 - 692 containingFrameRE = re.compile('^ *mContainingFrame=\[%s,%s\]\[%s,%s\] mParentFrame=\[%s,%s\]\[%s,%s\]' % - 693 (__nd('cx'), __nd('cy'), __nd('cw'), __nd('ch'), __nd('px'), __nd('py'), __nd('pw'), __nd('ph'))) - 694 contentFrameRE = re.compile('^ *mContentFrame=\[%s,%s\]\[%s,%s\] mVisibleFrame=\[%s,%s\]\[%s,%s\]' % - 695 (__nd('x'), __nd('y'), __nd('w'), __nd('h'), __nd('vx'), __nd('vy'), __nd('vx1'), __nd('vy1'))) - 696 # This is for 4.1 API-16 - 697 framesRE = re.compile('^ *Frames: containing=\[%s,%s\]\[%s,%s\] parent=\[%s,%s\]\[%s,%s\]' % - 698 (__nd('cx'), __nd('cy'), __nd('cw'), __nd('ch'), __nd('px'), __nd('py'), __nd('pw'), __nd('ph'))) - 699 contentRE = re.compile('^ *content=\[%s,%s\]\[%s,%s\] visible=\[%s,%s\]\[%s,%s\]' % - 700 (__nd('x'), __nd('y'), __nd('w'), __nd('h'), __nd('vx'), __nd('vy'), __nd('vx1'), __nd('vy1'))) - 701 policyVisibilityRE = re.compile('mPolicyVisibility=%s ' % __ns('policyVisibility', greedy=True)) - 702 - 703 for l in range(len(lines)): - 704 m = widRE.search(lines[l]) - 705 if m: - 706 num = int(m.group('num')) - 707 winId = m.group('winId') - 708 activity = m.group('activity') - 709 wvx = 0 - 710 wvy = 0 - 711 wvw = 0 - 712 wvh = 0 - 713 px = 0 - 714 py = 0 - 715 visibility = -1 - 716 policyVisibility = 0x0 - 717 - 718 for l2 in range(l+1, len(lines)): - 719 m = widRE.search(lines[l2]) - 720 if m: - 721 l += (l2-1) - 722 break - 723 m = viewVisibilityRE.search(lines[l2]) - 724 if m: - 725 visibility = int(m.group('visibility')) - 726 if DEBUG_COORDS: print >> sys.stderr, "__dumpWindowsInformation: visibility=", visibility - 727 if self.build[VERSION_SDK_PROPERTY] >= 17: - 728 wvx, wvy = (0, 0) - 729 wvw, wvh = (0, 0) - 730 if self.build[VERSION_SDK_PROPERTY] >= 16: - 731 m = framesRE.search(lines[l2]) - 732 if m: - 733 px, py = self.__obtainPxPy(m) - 734 m = contentRE.search(lines[l2+1]) - 735 if m: - 736 # FIXME: the information provided by 'dumpsys window windows' in 4.2.1 (API 16) - 737 # when there's a system dialog may not be correct and causes the View coordinates - 738 # be offset by this amount, see - 739 # https://github.com/dtmilano/AndroidViewClient/issues/29 - 740 wvx, wvy = self.__obtainVxVy(m) - 741 wvw, wvh = self.__obtainVwVh(m) - 742 elif self.build[VERSION_SDK_PROPERTY] == 15: - 743 m = containingFrameRE.search(lines[l2]) - 744 if m: - 745 px, py = self.__obtainPxPy(m) - 746 m = contentFrameRE.search(lines[l2+1]) - 747 if m: - 748 wvx, wvy = self.__obtainVxVy(m) - 749 wvw, wvh = self.__obtainVwVh(m) - 750 elif self.build[VERSION_SDK_PROPERTY] == 10: - 751 m = containingFrameRE.search(lines[l2]) - 752 if m: - 753 px, py = self.__obtainPxPy(m) - 754 m = contentFrameRE.search(lines[l2+1]) - 755 if m: - 756 wvx, wvy = self.__obtainVxVy(m) - 757 wvw, wvh = self.__obtainVwVh(m) - 758 else: - 759 warnings.warn("Unsupported Android version %d" % self.build[VERSION_SDK_PROPERTY]) - 760 - 761 #print >> sys.stderr, "Searching policyVisibility in", lines[l2] - 762 m = policyVisibilityRE.search(lines[l2]) - 763 if m: - 764 policyVisibility = 0x0 if m.group('policyVisibility') == 'true' else 0x8 - 765 - 766 self.windows[winId] = Window(num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility + policyVisibility) - 767 else: - 768 m = currentFocusRE.search(lines[l]) - 769 if m: - 770 self.currentFocus = m.group('winId') - 771 - 772 if self.currentFocus in self.windows and self.windows[self.currentFocus].visibility == 0: - 773 if DEBUG_COORDS or debug: - 774 print >> sys.stderr, "__dumpWindowsInformation: focus=", self.currentFocus - 775 print >> sys.stderr, "__dumpWindowsInformation:", self.windows[self.currentFocus] - 776 w = self.windows[self.currentFocus] - 777 return (w.wvx, w.wvy) - 778 else: - 779 if DEBUG_COORDS: print >> sys.stderr, "__dumpWindowsInformation: (0,0)" - 780 return (0,0) -
781 -
782 - def touch(self, type=MonkeyDevice.DOWN_AND_UP): -
783 ''' - 784 Touches the center of this C{View} - 785 ''' - 786 - 787 (x, y) = self.getCenter() - 788 if DEBUG_TOUCH: - 789 print >>sys.stderr, "should touch @ (%d, %d)" % (x, y) - 790 if type == MonkeyDevice.DOWN_AND_UP: - 791 if WARNINGS: - 792 print >> sys.stderr, "ViewClient: touch workaround enabled" - 793 self.device.touch(x, y, MonkeyDevice.DOWN) - 794 time.sleep(50/1000.0) - 795 self.device.touch(x+10, y+10, MonkeyDevice.UP) - 796 else: - 797 self.device.touch(x, y, type) -
798 -
799 - def allPossibleNamesWithColon(self, name): -
800 l = [] - 801 for i in range(name.count("_")): - 802 name = name.replace("_", ":", 1) - 803 l.append(name) - 804 return l -
805 -
806 - def intersection(self, l1, l2): -
807 return list(set(l1) & set(l2)) -
808 -
809 - def containsPoint(self, (x, y)): -
810 (X, Y, W, H) = self.getPositionAndSize() - 811 return (((x >= X) and (x <= (X+W)) and ((y >= Y) and (y <= (Y+H))))) -
812 -
813 - def add(self, child): -
814 ''' - 815 Adds a child - 816 - 817 @type child: View - 818 @param child: The child to add - 819 ''' - 820 child.parent = self - 821 self.children.append(child) -
822 -
823 - def isClickable(self): -
824 return self.__getattr__('isClickable')() +
316 - def __getitem__(self, key): +
317 return self.map[key] +
318 +
319 - def __getattr__(self, name): +
320 if DEBUG_GETATTR: + 321 print >>sys.stderr, "__getattr__(%s) version: %d" % (name, self.build[VERSION_SDK_PROPERTY]) + 322 + 323 # NOTE: + 324 # I should try to see if 'name' is a defined method + 325 # but it seems that if I call locals() here an infinite loop is entered + 326 + 327 if self.map.has_key(name): + 328 r = self.map[name] + 329 elif self.map.has_key(name + '()'): + 330 # the method names are stored in the map with their trailing '()' + 331 r = self.map[name + '()'] + 332 elif name.count("_") > 0: + 333 mangledList = self.allPossibleNamesWithColon(name) + 334 mangledName = self.intersection(mangledList, self.map.keys()) + 335 if len(mangledName) > 0 and self.map.has_key(mangledName[0]): + 336 r = self.map[mangledName[0]] + 337 else: + 338 # Default behavior + 339 raise AttributeError, name + 340 else: + 341 # try removing 'is' prefix + 342 if DEBUG_GETATTR: + 343 print >> sys.stderr, " __getattr__: trying without 'is' prefix" + 344 suffix = name[2:].lower() + 345 if self.map.has_key(suffix): + 346 r = self.map[suffix] + 347 else: + 348 # Default behavior + 349 raise AttributeError, name + 350 + 351 # if the method name starts with 'is' let's assume its return value is boolean + 352 # if name[:2] == 'is': + 353 # r = True if r == 'true' else False + 354 if r == 'true': + 355 r = True + 356 elif r == 'false': + 357 r = False + 358 + 359 # this should not cached in some way + 360 def innerMethod(): + 361 if DEBUG_GETATTR: + 362 print >>sys.stderr, "innerMethod: %s returning %s" % (innerMethod.__name__, r) + 363 return r +
364 + 365 innerMethod.__name__ = name + 366 + 367 # this should work, but then there's problems with the arguments of innerMethod + 368 # even if innerMethod(self) is added + 369 #setattr(View, innerMethod.__name__, innerMethod) + 370 #setattr(self, innerMethod.__name__, innerMethod) + 371 + 372 return innerMethod +
373 +
374 - def __call__(self, *args, **kwargs): +
375 if DEBUG_CALL: + 376 print >>sys.stderr, "__call__(%s)" % (args if args else None) +
377 +
378 - def getClass(self): +
379 ''' + 380 Gets the L{View} class + 381 + 382 @return: the L{View} class or C{None} if not defined + 383 ''' + 384 + 385 try: + 386 return self.map['class'] + 387 except: + 388 return None +
389 +
390 - def getId(self): +
391 ''' + 392 Gets the L{View} Id + 393 + 394 @return: the L{View} C{Id} or C{None} if not defined + 395 @see: L{getUniqueId()} + 396 ''' + 397 + 398 try: + 399 return self.map[self.idProperty] + 400 except: + 401 return None +
402 +
403 - def getContentDescription(self): +
404 ''' + 405 Gets the content description. + 406 ''' + 407 + 408 try: + 409 return self.map['content-desc'] + 410 except: + 411 return None +
412 +
413 - def getParent(self): +
414 ''' + 415 Gets the parent. + 416 ''' + 417 + 418 return self.parent +
419 +
420 - def getText(self): +
421 ''' + 422 Gets the text attribute. + 423 + 424 @return: the text attribute or C{None} if not defined + 425 ''' + 426 + 427 try: + 428 return self.map[self.textProperty] + 429 except Exception: + 430 return None +
431 +
432 - def getHeight(self): +
433 ''' + 434 Gets the height. + 435 ''' + 436 + 437 if self.useUiAutomator: + 438 return self.map['bounds'][1][1] - self.map['bounds'][0][1] + 439 else: + 440 try: + 441 return int(self.map[self.heightProperty]) + 442 except: + 443 return 0 +
444 +
445 - def getWidth(self): +
446 ''' + 447 Gets the width. + 448 ''' + 449 + 450 if self.useUiAutomator: + 451 return self.map['bounds'][1][0] - self.map['bounds'][0][0] + 452 else: + 453 try: + 454 return int(self.map[self.widthProperty]) + 455 except: + 456 return 0 +
457 +
458 - def getUniqueId(self): +
459 ''' + 460 Gets the unique Id of this View. + 461 + 462 @see: L{ViewClient.__splitAttrs()} for a discussion on B{Unique Ids} + 463 ''' + 464 + 465 try: + 466 return self.map['uniqueId'] + 467 except: + 468 return None +
469 +
470 - def getVisibility(self): +
471 ''' + 472 Gets the View visibility + 473 ''' + 474 + 475 try: + 476 if self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': + 477 return VISIBLE + 478 elif self.map[GET_VISIBILITY_PROPERTY] == 'INVISIBLE': + 479 return INVISIBLE + 480 elif self.map[GET_VISIBILITY_PROPERTY] == 'GONE': + 481 return GONE + 482 else: + 483 return -2 + 484 except: + 485 return -1 +
486 +
487 - def getX(self): +
488 ''' + 489 Gets the View X coordinate + 490 ''' + 491 + 492 if DEBUG_COORDS: + 493 print >>sys.stderr, "getX(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) + 494 x = 0 + 495 + 496 if self.useUiAutomator: + 497 x = self.map['bounds'][0][0] + 498 else: + 499 try: + 500 if GET_VISIBILITY_PROPERTY in self.map and self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': + 501 _x = int(self.map[self.leftProperty]) + 502 if DEBUG_COORDS: print >>sys.stderr, " getX: VISIBLE adding %d" % _x + 503 x += _x + 504 except: + 505 warnings.warn("View %s has no '%s' property" % (self.getId(), self.leftProperty)) + 506 + 507 if DEBUG_COORDS: print >>sys.stderr, " getX: returning %d" % (x) + 508 return x +
509 +
510 - def getY(self): +
511 ''' + 512 Gets the View Y coordinate + 513 ''' + 514 + 515 if DEBUG_COORDS: + 516 print >>sys.stderr, "getY(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) + 517 y = 0 + 518 + 519 if self.useUiAutomator: + 520 y = self.map['bounds'][0][1] + 521 else: + 522 try: + 523 if GET_VISIBILITY_PROPERTY in self.map and self.map[GET_VISIBILITY_PROPERTY] == 'VISIBLE': + 524 _y = int(self.map[self.topProperty]) + 525 if DEBUG_COORDS: print >>sys.stderr, " getY: VISIBLE adding %d" % _y + 526 y += _y + 527 except: + 528 warnings.warn("View %s has no '%s' property" % (self.getId(), self.topProperty)) + 529 + 530 if DEBUG_COORDS: print >>sys.stderr, " getY: returning %d" % (y) + 531 return y +
532 +
533 - def getXY(self, debug=False): +
534 ''' + 535 Returns the I{screen} coordinates of this C{View}. + 536 + 537 @return: The I{screen} coordinates of this C{View} + 538 ''' + 539 + 540 if DEBUG_COORDS or debug: + 541 try: + 542 id = self.getId() + 543 except: + 544 id = "NO_ID" + 545 print >> sys.stderr, "getXY(%s %s ## %s)" % (self.getClass(), id, self.getUniqueId()) + 546 + 547 x = self.getX() + 548 y = self.getY() + 549 parent = self.parent + 550 if DEBUG_COORDS: print >> sys.stderr, " getXY: x=%s y=%s parent=%s" % (x, y, parent.getUniqueId() if parent else "None") + 551 hx = 0 + 552 ''' Hierarchy accumulated X ''' + 553 hy = 0 + 554 ''' Hierarchy accumulated Y ''' + 555 + 556 if not self.useUiAutomator: + 557 if DEBUG_COORDS: print >> sys.stderr, " getXY: not using UiAutomator, calculating ancestors coordinates" + 558 while parent != None: + 559 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent: %s %s <<<<" % (parent.getClass() if parent else "None", parent.getUniqueId() if parent else "None") + 560 if SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED: + 561 if parent.getClass() in [ 'com.android.internal.widget.ActionBarView', + 562 'com.android.internal.widget.ActionBarContextView', + 563 'com.android.internal.view.menu.ActionMenuView', + 564 'com.android.internal.policy.impl.PhoneWindow$DecorView' ]: + 565 if DEBUG_COORDS: print >> sys.stderr, " getXY: skipping %s %s (%d,%d)" % (parent.getClass(), parent.getUniqueId(), parent.getX(), parent.getY()) + 566 parent = parent.parent + 567 continue + 568 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent=%s x=%d hx=%d y=%d hy=%d" % (parent.getUniqueId(), parent.getX(), hx, parent.getY(), hy) + 569 hx += parent.getX() + 570 hy += parent.getY() + 571 parent = parent.parent + 572 if DEBUG_COORDS: print >> sys.stderr, " getXY: parent=%s hx=%d hy=%d (end of loop)" % (parent.getUniqueId() if parent else "None", hx, hy) + 573 + 574 (wvx, wvy) = self.__dumpWindowsInformation(debug=debug) + 575 if DEBUG_COORDS or debug: + 576 print >>sys.stderr, " getXY: wv=(%d, %d) (windows information)" % (wvx, wvy) + 577 try: + 578 fw = self.windows[self.currentFocus] + 579 if DEBUG_STATUSBAR: + 580 print >> sys.stderr, " getXY: focused window=", fw + 581 print >> sys.stderr, " getXY: deciding whether to consider statusbar offset because current focused windows is at", (fw.wvx, fw.wvy), "parent", (fw.px, fw.py) + 582 except KeyError: + 583 fw = None + 584 (sbw, sbh) = self.__obtainStatusBarDimensionsIfVisible() + 585 if DEBUG_COORDS or debug: + 586 print >>sys.stderr, " getXY: sb=(%d, %d) (statusbar dimensions)" % (sbw, sbh) + 587 statusBarOffset = 0 + 588 pwx = 0 + 589 pwy = 0 + 590 + 591 if fw: + 592 if DEBUG_COORDS: + 593 print >>sys.stderr, " getXY: focused window=", fw, "sb=", (sbw, sbh) + 594 if fw.wvy <= sbh: # it's very unlikely that fw.wvy < sbh, that is a window over the statusbar + 595 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: yes, considering offset=", sbh + 596 statusBarOffset = sbh + 597 else: + 598 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: no, ignoring statusbar offset fw.wvy=", fw.wvy, ">", sbh + 599 + 600 if fw.py == fw.wvy: + 601 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: but wait, fw.py == fw.wvy so we are adjusting by ", (fw.px, fw.py) + 602 pwx = fw.px + 603 pwy = fw.py + 604 else: + 605 if DEBUG_STATUSBAR: print >>sys.stderr, " getXY: fw.py=%d <= fw.wvy=%d, no adjustment" % (fw.py, fw.wvy) + 606 + 607 if DEBUG_COORDS or DEBUG_STATUSBAR or debug: + 608 print >>sys.stderr, " getXY: returning (%d, %d) ***" % (x+hx+wvx+pwx, y+hy+wvy-statusBarOffset+pwy) + 609 print >>sys.stderr, " x=%d+%d+%d+%d" % (x,hx,wvx,pwx) + 610 print >>sys.stderr, " y=%d+%d+%d-%d+%d" % (y,hy,wvy,statusBarOffset,pwy) + 611 return (x+hx+wvx+pwx, y+hy+wvy-statusBarOffset+pwy) +
612 +
613 - def getCoords(self): +
614 ''' + 615 Gets the coords of the View + 616 + 617 @return: A tuple containing the View's coordinates ((L, T), (R, B)) + 618 ''' + 619 + 620 if DEBUG_COORDS: + 621 print >>sys.stderr, "getCoords(%s %s ## %s)" % (self.getClass(), self.getId(), self.getUniqueId()) + 622 + 623 (x, y) = self.getXY(); + 624 w = self.getWidth() + 625 h = self.getHeight() + 626 return ((x, y), (x+w, y+h)) +
627 +
628 - def getPositionAndSize(self): +
629 ''' + 630 Gets the position and size (X,Y, W, H) + 631 + 632 @return: A tuple containing the View's coordinates (X, Y, W, H) + 633 ''' + 634 + 635 (x, y) = self.getXY(); + 636 w = self.getWidth() + 637 h = self.getHeight() + 638 return (x, y, w, h) +
639 + 640 +
641 - def getCenter(self): +
642 ''' + 643 Gets the center coords of the View + 644 + 645 @author: U{Dean Morin <https://github.com/deanmorin>} + 646 ''' + 647 + 648 (left, top), (right, bottom) = self.getCoords() + 649 x = left + (right - left) / 2 + 650 y = top + (bottom - top) / 2 + 651 return (x, y) +
652 +
653 - def __obtainStatusBarDimensionsIfVisible(self): +
654 sbw = 0 + 655 sbh = 0 + 656 for winId in self.windows: + 657 w = self.windows[winId] + 658 if DEBUG_COORDS: print >> sys.stderr, " __obtainStatusBarDimensionsIfVisible: w=", w, " w.activity=", w.activity, "%%%" + 659 if w.activity == 'StatusBar': + 660 if w.wvy == 0 and w.visibility == 0: + 661 if DEBUG_COORDS: print >> sys.stderr, " __obtainStatusBarDimensionsIfVisible: statusBar=", (w.wvw, w.wvh) + 662 sbw = w.wvw + 663 sbh = w.wvh + 664 break + 665 + 666 return (sbw, sbh) +
667 +
668 - def __obtainVxVy(self, m): +
669 wvx = int(m.group('vx')) + 670 wvy = int(m.group('vy')) + 671 return wvx, wvy +
672 +
673 - def __obtainVwVh(self, m): +
674 (wvx, wvy) = self.__obtainVxVy(m) + 675 wvx1 = int(m.group('vx1')) + 676 wvy1 = int(m.group('vy1')) + 677 return (wvx1-wvx, wvy1-wvy) +
678 +
679 - def __obtainPxPy(self, m): +
680 px = int(m.group('px')) + 681 py = int(m.group('py')) + 682 return (px, py) +
683 +
684 - def __dumpWindowsInformation(self, debug=False): +
685 self.windows = {} + 686 self.currentFocus = None + 687 dww = self.device.shell('dumpsys window windows') + 688 if DEBUG_WINDOWS or debug: print >> sys.stderr, dww + 689 lines = dww.split('\n') + 690 widRE = re.compile('^ *Window #%s Window{%s (u\d+ )?%s?.*}:' % + 691 (__nd('num'), __nh('winId'), __ns('activity', greedy=True))) + 692 currentFocusRE = re.compile('^ mCurrentFocus=Window{%s .*' % __nh('winId')) + 693 viewVisibilityRE = re.compile(' mViewVisibility=0x%s ' % __nh('visibility')) + 694 # This is for 4.0.4 API-15 + 695 containingFrameRE = re.compile('^ *mContainingFrame=\[%s,%s\]\[%s,%s\] mParentFrame=\[%s,%s\]\[%s,%s\]' % + 696 (__nd('cx'), __nd('cy'), __nd('cw'), __nd('ch'), __nd('px'), __nd('py'), __nd('pw'), __nd('ph'))) + 697 contentFrameRE = re.compile('^ *mContentFrame=\[%s,%s\]\[%s,%s\] mVisibleFrame=\[%s,%s\]\[%s,%s\]' % + 698 (__nd('x'), __nd('y'), __nd('w'), __nd('h'), __nd('vx'), __nd('vy'), __nd('vx1'), __nd('vy1'))) + 699 # This is for 4.1 API-16 + 700 framesRE = re.compile('^ *Frames: containing=\[%s,%s\]\[%s,%s\] parent=\[%s,%s\]\[%s,%s\]' % + 701 (__nd('cx'), __nd('cy'), __nd('cw'), __nd('ch'), __nd('px'), __nd('py'), __nd('pw'), __nd('ph'))) + 702 contentRE = re.compile('^ *content=\[%s,%s\]\[%s,%s\] visible=\[%s,%s\]\[%s,%s\]' % + 703 (__nd('x'), __nd('y'), __nd('w'), __nd('h'), __nd('vx'), __nd('vy'), __nd('vx1'), __nd('vy1'))) + 704 policyVisibilityRE = re.compile('mPolicyVisibility=%s ' % __ns('policyVisibility', greedy=True)) + 705 + 706 for l in range(len(lines)): + 707 m = widRE.search(lines[l]) + 708 if m: + 709 num = int(m.group('num')) + 710 winId = m.group('winId') + 711 activity = m.group('activity') + 712 wvx = 0 + 713 wvy = 0 + 714 wvw = 0 + 715 wvh = 0 + 716 px = 0 + 717 py = 0 + 718 visibility = -1 + 719 policyVisibility = 0x0 + 720 + 721 for l2 in range(l+1, len(lines)): + 722 m = widRE.search(lines[l2]) + 723 if m: + 724 l += (l2-1) + 725 break + 726 m = viewVisibilityRE.search(lines[l2]) + 727 if m: + 728 visibility = int(m.group('visibility')) + 729 if DEBUG_COORDS: print >> sys.stderr, "__dumpWindowsInformation: visibility=", visibility + 730 if self.build[VERSION_SDK_PROPERTY] >= 17: + 731 wvx, wvy = (0, 0) + 732 wvw, wvh = (0, 0) + 733 if self.build[VERSION_SDK_PROPERTY] >= 16: + 734 m = framesRE.search(lines[l2]) + 735 if m: + 736 px, py = self.__obtainPxPy(m) + 737 m = contentRE.search(lines[l2+1]) + 738 if m: + 739 # FIXME: the information provided by 'dumpsys window windows' in 4.2.1 (API 16) + 740 # when there's a system dialog may not be correct and causes the View coordinates + 741 # be offset by this amount, see + 742 # https://github.com/dtmilano/AndroidViewClient/issues/29 + 743 wvx, wvy = self.__obtainVxVy(m) + 744 wvw, wvh = self.__obtainVwVh(m) + 745 elif self.build[VERSION_SDK_PROPERTY] == 15: + 746 m = containingFrameRE.search(lines[l2]) + 747 if m: + 748 px, py = self.__obtainPxPy(m) + 749 m = contentFrameRE.search(lines[l2+1]) + 750 if m: + 751 wvx, wvy = self.__obtainVxVy(m) + 752 wvw, wvh = self.__obtainVwVh(m) + 753 elif self.build[VERSION_SDK_PROPERTY] == 10: + 754 m = containingFrameRE.search(lines[l2]) + 755 if m: + 756 px, py = self.__obtainPxPy(m) + 757 m = contentFrameRE.search(lines[l2+1]) + 758 if m: + 759 wvx, wvy = self.__obtainVxVy(m) + 760 wvw, wvh = self.__obtainVwVh(m) + 761 else: + 762 warnings.warn("Unsupported Android version %d" % self.build[VERSION_SDK_PROPERTY]) + 763 + 764 #print >> sys.stderr, "Searching policyVisibility in", lines[l2] + 765 m = policyVisibilityRE.search(lines[l2]) + 766 if m: + 767 policyVisibility = 0x0 if m.group('policyVisibility') == 'true' else 0x8 + 768 + 769 self.windows[winId] = Window(num, winId, activity, wvx, wvy, wvw, wvh, px, py, visibility + policyVisibility) + 770 else: + 771 m = currentFocusRE.search(lines[l]) + 772 if m: + 773 self.currentFocus = m.group('winId') + 774 + 775 if self.currentFocus in self.windows and self.windows[self.currentFocus].visibility == 0: + 776 if DEBUG_COORDS or debug: + 777 print >> sys.stderr, "__dumpWindowsInformation: focus=", self.currentFocus + 778 print >> sys.stderr, "__dumpWindowsInformation:", self.windows[self.currentFocus] + 779 w = self.windows[self.currentFocus] + 780 return (w.wvx, w.wvy) + 781 else: + 782 if DEBUG_COORDS: print >> sys.stderr, "__dumpWindowsInformation: (0,0)" + 783 return (0,0) +
784 +
785 - def touch(self, type=MonkeyDevice.DOWN_AND_UP): +
786 ''' + 787 Touches the center of this C{View} + 788 ''' + 789 + 790 (x, y) = self.getCenter() + 791 if DEBUG_TOUCH: + 792 print >>sys.stderr, "should touch @ (%d, %d)" % (x, y) + 793 if type == MonkeyDevice.DOWN_AND_UP: + 794 if WARNINGS: + 795 print >> sys.stderr, "ViewClient: touch workaround enabled" + 796 self.device.touch(x, y, MonkeyDevice.DOWN) + 797 time.sleep(50/1000.0) + 798 self.device.touch(x+10, y+10, MonkeyDevice.UP) + 799 else: + 800 self.device.touch(x, y, type) +
801 +
802 - def allPossibleNamesWithColon(self, name): +
803 l = [] + 804 for i in range(name.count("_")): + 805 name = name.replace("_", ":", 1) + 806 l.append(name) + 807 return l +
808 +
809 - def intersection(self, l1, l2): +
810 return list(set(l1) & set(l2)) +
811 +
812 - def containsPoint(self, (x, y)): +
813 (X, Y, W, H) = self.getPositionAndSize() + 814 return (((x >= X) and (x <= (X+W)) and ((y >= Y) and (y <= (Y+H))))) +
815 +
816 - def add(self, child): +
817 ''' + 818 Adds a child + 819 + 820 @type child: View + 821 @param child: The child to add + 822 ''' + 823 child.parent = self + 824 self.children.append(child)
825 -
826 - def variableNameFromId(self): -
827 m = ID_RE.match(self.getUniqueId()) - 828 if m: - 829 var = m.group(1) - 830 if m.group(3): - 831 var += m.group(3) - 832 if re.match('^\d', var): - 833 var = 'id_' + var - 834 return var -
835 -
836 - def writeImageToFile(self, filename, format="PNG"): -
837 ''' - 838 Write the View image to the specified filename in the specified format. - 839 - 840 @type filename: str - 841 @param filename: Absolute path and optional filename receiving the image. If this points to - 842 a directory, then the filename is determined by this View unique ID and - 843 format extension. - 844 @type format: str - 845 @param format: Image format (default format is PNG) - 846 ''' - 847 - 848 if not os.path.isabs(filename): - 849 raise ValueError("writeImageToFile expects an absolute path") - 850 if os.path.isdir(filename): - 851 filename = os.path.join(filename, self.variableNameFromId() + '.' + format.lower()) - 852 if DEBUG: - 853 print >> sys.stderr, "writeImageToFile: saving image to '%s' in %s format" % (filename, format) - 854 self.device.takeSnapshot().getSubImage(self.getPositionAndSize()).writeToFile(filename, format) -
855 -
856 - def __smallStr__(self): -
857 __str = "View[" - 858 if "class" in self.map: - 859 __str += " class=" + self.map['class'] - 860 __str += " id=%s" % self.getId() - 861 __str += " ] parent=" - 862 if self.parent and "class" in self.parent.map: - 863 __str += "%s" % self.parent.map["class"] - 864 else: - 865 __str += "None" - 866 - 867 return __str -
868 -
869 - def __tinyStr__(self): -
870 __str = "View[" - 871 if "class" in self.map: - 872 __str += " class=" + re.sub('.*\.', '', self.map['class']) - 873 __str += " id=%s" % self.getId() - 874 __str += " ]" - 875 - 876 return __str -
877 -
878 - def __str__(self): -
879 __str = "View[" - 880 if "class" in self.map: - 881 __str += " class=" + self.map["class"].__str__() + " " - 882 for a in self.map: - 883 __str += a + "=" + self.map[a].__str__() + " " - 884 __str += "] parent=" - 885 if self.parent: - 886 if "class" in self.parent.map: - 887 __str += "%s" % self.parent.map["class"] - 888 else: - 889 __str += self.parent.getId().__str__() - 890 else: - 891 __str += "None" - 892 - 893 return __str -
894 -
895 -class TextView(View): -
896 ''' - 897 TextView class. - 898 ''' - 899 - 900 pass -
901 -
902 -class EditText(TextView): -
903 ''' - 904 EditText class. - 905 ''' - 906 -
907 - def type(self, text): -
908 self.touch() - 909 MonkeyRunner.sleep(1) - 910 for c in text: - 911 if c != ' ': - 912 self.device.type(c) - 913 else: - 914 self.device.press('KEYCODE_SPACE', MonkeyDevice.DOWN_AND_UP) - 915 MonkeyRunner.sleep(1) -
916 -
917 - def backspace(self): -
918 self.touch() - 919 MonkeyRunner.sleep(1) - 920 self.device.press('KEYCODE_DEL', MonkeyDevice.DOWN_AND_UP) -
921 -
923 ''' - 924 UiAutomator XML to AndroidViewClient - 925 ''' - 926 -
927 - def __init__(self, device, version): -
928 self.device = device - 929 self.version = version - 930 self.root = None - 931 self.nodeStack = [] - 932 self.parent = None - 933 self.viewsById = [] - 934 self.idCount = 1 -
935 -
936 - def StartElement(self, name, attributes): -
937 ''' - 938 Expat start element event handler - 939 ''' - 940 if name == 'hierarchy': - 941 pass - 942 elif name == 'node': - 943 # Instantiate an Element object - 944 attributes['uniqueId'] = 'id/no_id/%d' % self.idCount - 945 bounds = re.split('[\][,]', attributes['bounds']) - 946 attributes['bounds'] = ((int(bounds[1]), int(bounds[2])), (int(bounds[4]), int(bounds[5]))) - 947 if DEBUG_BOUNDS: - 948 print >> sys.stderr, "bounds=", attributes['bounds'] - 949 self.idCount += 1 - 950 child = View.factory(attributes, self.device, self.version) - 951 self.viewsById.append(child) - 952 # Push element onto the stack and make it a child of parent - 953 if not self.nodeStack: - 954 self.root = child - 955 else: - 956 self.parent = self.nodeStack[-1] - 957 self.parent.add(child) - 958 self.nodeStack.append(child) -
959 -
960 - def EndElement(self, name): -
961 ''' - 962 Expat end element event handler - 963 ''' - 964 - 965 if name == 'hierarchy': - 966 pass - 967 elif name == 'node': - 968 self.nodeStack.pop() -
969 -
970 - def CharacterData(self, data): -
971 ''' - 972 Expat character data event handler - 973 ''' - 974 - 975 if data.strip(): - 976 data = data.encode() - 977 element = self.nodeStack[-1] - 978 element.cdata += data -
979 -
980 - def Parse(self, uiautomatorxml): -
981 # Create an Expat parser - 982 parser = xml.parsers.expat.ParserCreate() - 983 # Set the Expat event handlers to our methods - 984 parser.StartElementHandler = self.StartElement - 985 parser.EndElementHandler = self.EndElement - 986 parser.CharacterDataHandler = self.CharacterData - 987 # Parse the XML File - 988 parserStatus = parser.Parse(uiautomatorxml, 1) - 989 return self.root -
990 -
991 -class Excerpt2Code(): -
992 ''' Excerpt XML to code ''' - 993 -
994 - def __init__(self): -
995 self.data = None -
996 -
997 - def StartElement(self, name, attributes): -
998 ''' - 999 Expat start element event handler -1000 ''' -1001 if name == 'excerpt': -1002 pass -1003 else: -1004 warnings.warn("Unexpected element: '%s'" % name) -
1005 -
1006 - def EndElement(self, name): -
1007 ''' -1008 Expat end element event handler -1009 ''' -1010 -1011 if name == 'excerpt': -1012 pass -
1013 -
1014 - def CharacterData(self, data): -
1015 ''' -1016 Expat character data event handler -1017 ''' -1018 -1019 if data.strip(): -1020 data = data.encode() -1021 if not self.data: -1022 self.data = data -1023 else: -1024 self.data += data -
1025 -
1026 - def Parse(self, excerpt): -
1027 # Create an Expat parser -1028 parser = xml.parsers.expat.ParserCreate() -1029 # Set the Expat event handlers to our methods -1030 parser.StartElementHandler = self.StartElement -1031 parser.EndElementHandler = self.EndElement -1032 parser.CharacterDataHandler = self.CharacterData -1033 # Parse the XML -1034 parserStatus = parser.Parse(excerpt, 1) -1035 return self.data -
1036 -
1037 -class ViewClient: -
1038 ''' -1039 ViewClient is a I{ViewServer} client. -1040 -1041 ViewServer backend -1042 ================== -1043 If not running the ViewServer is started on the target device or emulator and then the port -1044 mapping is created. -1045 -1046 UiAutomator backend -1047 =================== -1048 No service is started. -1049 ''' -1050 -
1051 - def __init__(self, device, serialno, adb=None, autodump=True, forceviewserveruse=False, localport=VIEW_SERVER_PORT, remoteport=VIEW_SERVER_PORT, startviewserver=True, ignoreuiautomatorkilled=False): -
1052 ''' -1053 Constructor -1054 -1055 @type device: MonkeyDevice -1056 @param device: The device running the C{View server} to which this client will connect -1057 @type serialno: str -1058 @param serialno: the serial number of the device or emulator to connect to -1059 @type adb: str -1060 @param adb: the path of the C{adb} executable or None and C{ViewClient} will try to find it -1061 @type autodump: boolean -1062 @param autodump: whether an automatic dump is performed at the end of this constructor -1063 @type forceviewserveruse: boolean -1064 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions to use -1065 C{UiAutomator} are satisfied -1066 @type localport: int -1067 @param localport: the local port used in the redirection -1068 @type remoteport: int -1069 @param remoteport: the remote port used to start the C{ViewServer} in the device or -1070 emulator -1071 @type startviewserver: boolean -1072 @param startviewserver: Whether to start the B{global} ViewServer -1073 @type ignoreuiautomatorkilled: boolean -1074 @param ignoreuiautomatorkilled: Ignores received B{Killed} message from C{uiautomator} -1075 ''' -1076 -1077 if not device: -1078 raise Exception('Device is not connected') -1079 self.device = device -1080 ''' The C{MonkeyDevice} device instance ''' -1081 -1082 if not serialno: -1083 raise ValueError("Serialno cannot be None") -1084 self.serialno = self.__mapSerialNo(serialno) -1085 ''' The serial number of the device ''' -1086 -1087 if DEBUG_DEVICE: print >> sys.stderr, "ViewClient: using device with serialno", self.serialno -1088 -1089 if adb: -1090 if not os.access(adb, os.X_OK): -1091 raise Exception('adb="%s" is not executable' % adb) -1092 else: -1093 adb = ViewClient.__obtainAdbPath() -1094 -1095 self.adb = adb -1096 ''' The adb command ''' -1097 self.root = None -1098 ''' The root node ''' -1099 self.viewsById = {} -1100 ''' The map containing all the L{View}s indexed by their L{View.getUniqueId()} ''' -1101 self.display = {} -1102 ''' The map containing the device's display properties: width, height and density ''' -1103 for prop in [ 'width', 'height', 'density' ]: -1104 self.display[prop] = -1 -1105 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: -1106 try: -1107 self.display[prop] = int(device.getProperty('display.' + prop)) -1108 except: -1109 if WARNINGS: -1110 warnings.warn("Couldn't determine display %s" % prop) -1111 else: -1112 # these values are usually not defined as properties, so we stick to the -1 set -1113 # before -1114 pass -1115 -1116 self.build = {} -1117 ''' The map containing the device's build properties: version.sdk, version.release ''' -1118 for prop in [VERSION_SDK_PROPERTY, 'version.release']: -1119 self.build[prop] = -1 -1120 try: -1121 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: -1122 self.build[prop] = device.getProperty('build.' + prop) -1123 else: -1124 self.build[prop] = device.shell('getprop ro.build.' + prop)[:-2] -1125 except: -1126 if WARNINGS: -1127 warnings.warn("Couldn't determine build %s" % prop) -1128 -1129 if prop == VERSION_SDK_PROPERTY: -1130 # we expect it to be an int -1131 self.build[prop] = int(self.build[prop] if self.build[prop] else -1) -1132 -1133 self.ro = {} -1134 ''' The map containing the device's ro properties: secure, debuggable ''' -1135 for prop in ['secure', 'debuggable']: +
826 - def isClickable(self): +
827 return self.__getattr__('isClickable')() +
828 +
829 - def variableNameFromId(self): +
830 m = ID_RE.match(self.getUniqueId()) + 831 if m: + 832 var = m.group(1) + 833 if m.group(3): + 834 var += m.group(3) + 835 if re.match('^\d', var): + 836 var = 'id_' + var + 837 return var +
838 +
839 - def writeImageToFile(self, filename, format="PNG"): +
840 ''' + 841 Write the View image to the specified filename in the specified format. + 842 + 843 @type filename: str + 844 @param filename: Absolute path and optional filename receiving the image. If this points to + 845 a directory, then the filename is determined by this View unique ID and + 846 format extension. + 847 @type format: str + 848 @param format: Image format (default format is PNG) + 849 ''' + 850 + 851 if not os.path.isabs(filename): + 852 raise ValueError("writeImageToFile expects an absolute path") + 853 if os.path.isdir(filename): + 854 filename = os.path.join(filename, self.variableNameFromId() + '.' + format.lower()) + 855 if DEBUG: + 856 print >> sys.stderr, "writeImageToFile: saving image to '%s' in %s format" % (filename, format) + 857 self.device.takeSnapshot().getSubImage(self.getPositionAndSize()).writeToFile(filename, format) +
858 +
859 - def __smallStr__(self): +
860 __str = "View[" + 861 if "class" in self.map: + 862 __str += " class=" + self.map['class'] + 863 __str += " id=%s" % self.getId() + 864 __str += " ] parent=" + 865 if self.parent and "class" in self.parent.map: + 866 __str += "%s" % self.parent.map["class"] + 867 else: + 868 __str += "None" + 869 + 870 return __str +
871 +
872 - def __tinyStr__(self): +
873 __str = "View[" + 874 if "class" in self.map: + 875 __str += " class=" + re.sub('.*\.', '', self.map['class']) + 876 __str += " id=%s" % self.getId() + 877 __str += " ]" + 878 + 879 return __str +
880 +
881 - def __microStr__(self): +
882 __str = '' + 883 if "class" in self.map: + 884 __str += re.sub('.*\.', '', self.map['class']) + 885 id = self.getId().replace('id/no_id/', '-') + 886 __str += id + 887 ((L, T), (R, B)) = self.getCoords() + 888 __str += '@%04d%04d%04d%04d' % (L, T, R, B) + 889 __str += '' + 890 + 891 return __str +
892 + 893 +
894 - def __str__(self): +
895 __str = "View[" + 896 if "class" in self.map: + 897 __str += " class=" + self.map["class"].__str__() + " " + 898 for a in self.map: + 899 __str += a + "=" + self.map[a].__str__() + " " + 900 __str += "] parent=" + 901 if self.parent: + 902 if "class" in self.parent.map: + 903 __str += "%s" % self.parent.map["class"] + 904 else: + 905 __str += self.parent.getId().__str__() + 906 else: + 907 __str += "None" + 908 + 909 return __str +
910 +
911 -class TextView(View): +
912 ''' + 913 TextView class. + 914 ''' + 915 + 916 pass +
917 +
918 -class EditText(TextView): +
919 ''' + 920 EditText class. + 921 ''' + 922 +
923 - def type(self, text): +
924 self.touch() + 925 MonkeyRunner.sleep(1) + 926 for c in text: + 927 if c != ' ': + 928 self.device.type(c) + 929 else: + 930 self.device.press('KEYCODE_SPACE', MonkeyDevice.DOWN_AND_UP) + 931 MonkeyRunner.sleep(1) +
932 +
933 - def backspace(self): +
934 self.touch() + 935 MonkeyRunner.sleep(1) + 936 self.device.press('KEYCODE_DEL', MonkeyDevice.DOWN_AND_UP) +
937 +
939 ''' + 940 UiAutomator XML to AndroidViewClient + 941 ''' + 942 +
943 - def __init__(self, device, version): +
944 self.device = device + 945 self.version = version + 946 self.root = None + 947 self.nodeStack = [] + 948 self.parent = None + 949 self.viewsById = [] + 950 self.idCount = 1 +
951 +
952 - def StartElement(self, name, attributes): +
953 ''' + 954 Expat start element event handler + 955 ''' + 956 if name == 'hierarchy': + 957 pass + 958 elif name == 'node': + 959 # Instantiate an Element object + 960 attributes['uniqueId'] = 'id/no_id/%d' % self.idCount + 961 bounds = re.split('[\][,]', attributes['bounds']) + 962 attributes['bounds'] = ((int(bounds[1]), int(bounds[2])), (int(bounds[4]), int(bounds[5]))) + 963 if DEBUG_BOUNDS: + 964 print >> sys.stderr, "bounds=", attributes['bounds'] + 965 self.idCount += 1 + 966 child = View.factory(attributes, self.device, self.version) + 967 self.viewsById.append(child) + 968 # Push element onto the stack and make it a child of parent + 969 if not self.nodeStack: + 970 self.root = child + 971 else: + 972 self.parent = self.nodeStack[-1] + 973 self.parent.add(child) + 974 self.nodeStack.append(child) +
975 +
976 - def EndElement(self, name): +
977 ''' + 978 Expat end element event handler + 979 ''' + 980 + 981 if name == 'hierarchy': + 982 pass + 983 elif name == 'node': + 984 self.nodeStack.pop() +
985 +
986 - def CharacterData(self, data): +
987 ''' + 988 Expat character data event handler + 989 ''' + 990 + 991 if data.strip(): + 992 data = data.encode() + 993 element = self.nodeStack[-1] + 994 element.cdata += data +
995 +
996 - def Parse(self, uiautomatorxml): +
997 # Create an Expat parser + 998 parser = xml.parsers.expat.ParserCreate() + 999 # Set the Expat event handlers to our methods +1000 parser.StartElementHandler = self.StartElement +1001 parser.EndElementHandler = self.EndElement +1002 parser.CharacterDataHandler = self.CharacterData +1003 # Parse the XML File +1004 parserStatus = parser.Parse(uiautomatorxml, 1) +1005 return self.root +
1006 +
1007 -class Excerpt2Code(): +
1008 ''' Excerpt XML to code ''' +1009 +
1010 - def __init__(self): +
1011 self.data = None +
1012 +
1013 - def StartElement(self, name, attributes): +
1014 ''' +1015 Expat start element event handler +1016 ''' +1017 if name == 'excerpt': +1018 pass +1019 else: +1020 warnings.warn("Unexpected element: '%s'" % name) +
1021 +
1022 - def EndElement(self, name): +
1023 ''' +1024 Expat end element event handler +1025 ''' +1026 +1027 if name == 'excerpt': +1028 pass +
1029 +
1030 - def CharacterData(self, data): +
1031 ''' +1032 Expat character data event handler +1033 ''' +1034 +1035 if data.strip(): +1036 data = data.encode() +1037 if not self.data: +1038 self.data = data +1039 else: +1040 self.data += data +
1041 +
1042 - def Parse(self, excerpt): +
1043 # Create an Expat parser +1044 parser = xml.parsers.expat.ParserCreate() +1045 # Set the Expat event handlers to our methods +1046 parser.StartElementHandler = self.StartElement +1047 parser.EndElementHandler = self.EndElement +1048 parser.CharacterDataHandler = self.CharacterData +1049 # Parse the XML +1050 parserStatus = parser.Parse(excerpt, 1) +1051 return self.data +
1052 +
1053 -class ViewClient: +
1054 ''' +1055 ViewClient is a I{ViewServer} client. +1056 +1057 ViewServer backend +1058 ================== +1059 If not running the ViewServer is started on the target device or emulator and then the port +1060 mapping is created. +1061 +1062 UiAutomator backend +1063 =================== +1064 No service is started. +1065 ''' +1066 +
1067 - def __init__(self, device, serialno, adb=None, autodump=True, forceviewserveruse=False, localport=VIEW_SERVER_PORT, remoteport=VIEW_SERVER_PORT, startviewserver=True, ignoreuiautomatorkilled=False): +
1068 ''' +1069 Constructor +1070 +1071 @type device: MonkeyDevice +1072 @param device: The device running the C{View server} to which this client will connect +1073 @type serialno: str +1074 @param serialno: the serial number of the device or emulator to connect to +1075 @type adb: str +1076 @param adb: the path of the C{adb} executable or None and C{ViewClient} will try to find it +1077 @type autodump: boolean +1078 @param autodump: whether an automatic dump is performed at the end of this constructor +1079 @type forceviewserveruse: boolean +1080 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions to use +1081 C{UiAutomator} are satisfied +1082 @type localport: int +1083 @param localport: the local port used in the redirection +1084 @type remoteport: int +1085 @param remoteport: the remote port used to start the C{ViewServer} in the device or +1086 emulator +1087 @type startviewserver: boolean +1088 @param startviewserver: Whether to start the B{global} ViewServer +1089 @type ignoreuiautomatorkilled: boolean +1090 @param ignoreuiautomatorkilled: Ignores received B{Killed} message from C{uiautomator} +1091 ''' +1092 +1093 if not device: +1094 raise Exception('Device is not connected') +1095 self.device = device +1096 ''' The C{MonkeyDevice} device instance ''' +1097 +1098 if not serialno: +1099 raise ValueError("Serialno cannot be None") +1100 self.serialno = self.__mapSerialNo(serialno) +1101 ''' The serial number of the device ''' +1102 +1103 if DEBUG_DEVICE: print >> sys.stderr, "ViewClient: using device with serialno", self.serialno +1104 +1105 if adb: +1106 if not os.access(adb, os.X_OK): +1107 raise Exception('adb="%s" is not executable' % adb) +1108 else: +1109 adb = ViewClient.__obtainAdbPath() +1110 +1111 self.adb = adb +1112 ''' The adb command ''' +1113 self.root = None +1114 ''' The root node ''' +1115 self.viewsById = {} +1116 ''' The map containing all the L{View}s indexed by their L{View.getUniqueId()} ''' +1117 self.display = {} +1118 ''' The map containing the device's display properties: width, height and density ''' +1119 for prop in [ 'width', 'height', 'density' ]: +1120 self.display[prop] = -1 +1121 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: +1122 try: +1123 self.display[prop] = int(device.getProperty('display.' + prop)) +1124 except: +1125 if WARNINGS: +1126 warnings.warn("Couldn't determine display %s" % prop) +1127 else: +1128 # these values are usually not defined as properties, so we stick to the -1 set +1129 # before +1130 pass +1131 +1132 self.build = {} +1133 ''' The map containing the device's build properties: version.sdk, version.release ''' +1134 for prop in [VERSION_SDK_PROPERTY, 'version.release']: +1135 self.build[prop] = -1 1136 try: -1137 self.ro[prop] = device.shell('getprop ro.' + prop)[:-2] -1138 except: -1139 if WARNINGS: -1140 warnings.warn("Couldn't determine ro %s" % prop) -1141 self.ro[prop] = 'UNKNOWN' -1142 -1143 self.forceViewServerUse = forceviewserveruse -1144 ''' Force the use of ViewServer even if the conditions to use UiAutomator are satisfied ''' -1145 self.useUiAutomator = (self.build[VERSION_SDK_PROPERTY] >= 16) and not forceviewserveruse # jelly bean 4.1 & 4.2 -1146 ''' If UIAutomator is supported by the device it will be used ''' -1147 self.ignoreUiAutomatorKilled = ignoreuiautomatorkilled -1148 ''' On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed just after generating -1149 the dump file. In many cases the file is already complete so we can ask to ignore the 'Killed' -1150 message by setting L{ignoreuiautomatorkilled} to C{True}. -1151 -1152 Changes in 2.3.21 that uses C{/dev/tty} instead of a file may have turned this variable -1153 unnnecessary, however it has been kept for backward compatibility. -1154 ''' -1155 -1156 if self.useUiAutomator: -1157 self.textProperty = TEXT_PROPERTY_UI_AUTOMATOR -1158 else: -1159 if self.build[VERSION_SDK_PROPERTY] <= 10: -1160 self.textProperty = TEXT_PROPERTY_API_10 -1161 else: -1162 self.textProperty = TEXT_PROPERTY -1163 if startviewserver: -1164 if not self.serviceResponse(device.shell('service call window 3')): -1165 try: -1166 self.assertServiceResponse(device.shell('service call window 1 i32 %d' % -1167 remoteport)) -1168 except: -1169 msg = 'Cannot start View server.\n' \ -1170 'This only works on emulator and devices running developer versions.\n' \ -1171 'Does hierarchyviewer work on your device?\n' \ -1172 'See https://github.com/dtmilano/AndroidViewClient/wiki/Secure-mode\n\n' \ -1173 'Device properties:\n' \ -1174 ' ro.secure=%s\n' \ -1175 ' ro.debuggable=%s\n' % (self.ro['secure'], self.ro['debuggable']) -1176 raise Exception(msg) -1177 -1178 self.localPort = localport -1179 self.remotePort = remoteport -1180 # FIXME: it seems there's no way of obtaining the serialno from the MonkeyDevice -1181 subprocess.check_call([self.adb, '-s', self.serialno, 'forward', 'tcp:%d' % self.localPort, -1182 'tcp:%d' % self.remotePort]) -1183 -1184 self.windows = None -1185 ''' The list of windows as obtained by L{ViewClient.list()} ''' -1186 -1187 if autodump: -1188 self.dump() -
1189 -
1190 - def __del__(self): -
1191 # should clean up some things -1192 pass -
1193 -1194 @staticmethod -
1195 - def __obtainAdbPath(): -
1196 ''' -1197 Obtains the ADB path attempting know locations for different OSs -1198 ''' -1199 -1200 osName = java.lang.System.getProperty('os.name') -1201 isWindows = False -1202 if osName.startswith('Windows'): -1203 adb = 'adb.exe' -1204 isWindows = True -1205 else: -1206 adb = 'adb' -1207 -1208 ANDROID_HOME = os.environ['ANDROID_HOME'] if os.environ.has_key('ANDROID_HOME') else '/opt/android-sdk' -1209 HOME = os.environ['HOME'] if os.environ.has_key('HOME') else '' -1210 -1211 possibleChoices = [ os.path.join(ANDROID_HOME, 'platform-tools', adb), -1212 os.path.join(HOME, "android", 'platform-tools', adb), -1213 os.path.join(HOME, "android-sdk", 'platform-tools', adb), -1214 adb, -1215 ] -1216 -1217 if osName.startswith('Windows'): -1218 possibleChoices.append(os.path.join("""C:\Program Files\Android\android-sdk\platform-tools""", adb)) -1219 possibleChoices.append(os.path.join("""C:\Program Files (x86)\Android\android-sdk\platform-tools""", adb)) -1220 elif osName.startswith('Linux'): -1221 possibleChoices.append(os.path.join("opt", "android-sdk-linux", 'platform-tools', adb)) -1222 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-linux", 'platform-tools', adb)) -1223 possibleChoices.append(os.path.join(HOME, "android-sdk-linux", 'platform-tools', adb)) -1224 elif osName.startswith('Mac'): -1225 possibleChoices.append(os.path.join("opt", "android-sdk-mac_x86", 'platform-tools', adb)) -1226 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-mac", 'platform-tools', adb)) -1227 possibleChoices.append(os.path.join(HOME, "android-sdk-mac", 'platform-tools', adb)) -1228 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-mac_x86", 'platform-tools', adb)) -1229 possibleChoices.append(os.path.join(HOME, "android-sdk-mac_x86", 'platform-tools', adb)) -1230 else: -1231 # Unsupported OS -1232 pass -1233 -1234 for exeFile in possibleChoices: -1235 if os.access(exeFile, os.X_OK): -1236 return exeFile -1237 -1238 for path in os.environ["PATH"].split(os.pathsep): -1239 exeFile = os.path.join(path, adb) -1240 if exeFile != None and os.access(exeFile, os.X_OK if not isWindows else os.F_OK): -1241 return exeFile -1242 -1243 raise Exception('adb="%s" is not executable. Did you forget to set ANDROID_HOME in the environment?' % adb) -
1244 -1245 @staticmethod -
1246 - def __mapSerialNo(serialno): -
1247 serialno = serialno.strip() -1248 #ipRE = re.compile('^\d+\.\d+.\d+.\d+$') -1249 if IP_RE.match(serialno): -1250 if DEBUG_DEVICE: print >>sys.stderr, "ViewClient: adding default port to serialno", serialno, ADB_DEFAULT_PORT -1251 return serialno + ':%d' % ADB_DEFAULT_PORT -1252 -1253 ipPortRE = re.compile('^\d+\.\d+.\d+.\d+:\d+$') -1254 if ipPortRE.match(serialno): -1255 # nothing to map -1256 return serialno -1257 -1258 if re.search("[.*()+]", serialno): -1259 raise ValueError("Regular expression not supported as serialno in ViewClient") -1260 -1261 return serialno -
1262 -1263 @staticmethod -
1264 - def __obtainDeviceSerialNumber(device): -
1265 if DEBUG_DEVICE: print >>sys.stderr, "ViewClient: obtaining serial number for connected device" -1266 serialno = device.getProperty('ro.serialno') -1267 if not serialno: -1268 serialno = device.shell('getprop ro.serialno') -1269 if serialno: -1270 serialno = serialno[:-2] -1271 if not serialno: -1272 qemu = device.shell('getprop ro.kernel.qemu') -1273 if qemu: -1274 qemu = qemu[:-2] -1275 if qemu and int(qemu) == 1: -1276 # FIXME !!!!! -1277 # this must be calculated from somewhere, though using a fixed serialno for now -1278 warnings.warn("Running on emulator but no serial number was specified then 'emulator-5554' is used") -1279 serialno = 'emulator-5554' -1280 if not serialno: -1281 # If there's only one device connected get its serialno -1282 adb = ViewClient.__obtainAdbPath() -1283 if DEBUG_DEVICE: print >>sys.stderr, " using adb=%s" % adb -1284 s = subprocess.Popen([adb, 'get-serialno'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, env={}).communicate()[0][:-1] -1285 if s != 'unknown': -1286 serialno = s -1287 if DEBUG_DEVICE: print >>sys.stderr, " serialno=%s" % serialno -1288 if not serialno: -1289 warnings.warn("Couldn't obtain the serialno of the connected device") -1290 return serialno -
1291 -1292 @staticmethod -
1293 - def setAlarm(timeout): -
1294 osName = java.lang.System.getProperty('os.name') -1295 if osName.startswith('Windows'): # alarm is not implemented in Windows -1296 return -1297 signal.alarm(timeout) -
1298 -1299 @staticmethod -
1300 - def connectToDeviceOrExit(timeout=60, verbose=False, ignoresecuredevice=False, serialno=None): -
1301 ''' -1302 Connects to a device which serial number is obtained from the script arguments if available -1303 or using the default regex C{.*}. -1304 -1305 If the connection is not successful the script exits. -1306 L{MonkeyRunner.waitForConnection()} returns a L{MonkeyDevice} even if the connection failed. -1307 Then, to detect this situation, C{device.wake()} is attempted and if it fails then it is -1308 assumed the previous connection failed. -1309 -1310 @type timeout: int -1311 @param timeout: timeout for the connection -1312 @type verbose: bool -1313 @param verbose: Verbose output -1314 @type ignoresecuredevice: bool -1315 @param ignoresecuredevice: Ignores the check for a secure device -1316 @type serialno: str -1317 @param serialno: The device or emulator serial number -1318 -1319 @return: the device and serialno used for the connection -1320 ''' -1321 -1322 progname = os.path.basename(sys.argv[0]) -1323 if serialno is None: -1324 # eat all the extra options the invoking script may have added -1325 args = sys.argv -1326 while len(args) > 1 and args[1][0] == '-': -1327 args.pop(1) -1328 serialno = args[1] if len(args) > 1 else \ -1329 os.environ['ANDROID_SERIAL'] if os.environ.has_key('ANDROID_SERIAL') \ -1330 else '.*' -1331 if IP_RE.match(serialno): -1332 # If matches an IP address format and port was not specified add the default -1333 serialno += ':%d' % ADB_DEFAULT_PORT -1334 if verbose: -1335 print >> sys.stderr, 'Connecting to a device with serialno=%s with a timeout of %d secs...' % \ -1336 (serialno, timeout) -1337 # Sometimes MonkeyRunner doesn't even timeout (i.e. two connections from same process), so let's -1338 # handle it here -1339 ViewClient.setAlarm(timeout+5) -1340 device = MonkeyRunner.waitForConnection(timeout, serialno) -1341 ViewClient.setAlarm(0) -1342 try: -1343 device.wake() -1344 except java.lang.NullPointerException, e: -1345 print >> sys.stderr, "%s: ERROR: Couldn't connect to %s: %s" % (progname, serialno, e) -1346 sys.exit(3) -1347 if verbose: -1348 print >> sys.stderr, 'Connected to device with serialno=%s' % serialno -1349 secure = device.getSystemProperty('ro.secure') -1350 debuggable = device.getSystemProperty('ro.debuggable') -1351 versionProperty = device.getProperty('build.' + VERSION_SDK_PROPERTY) -1352 if versionProperty: -1353 version = int(versionProperty) -1354 else: -1355 if verbose: -1356 print "Couldn't obtain device SDK version" -1357 version = -1 -1358 -1359 # we are going to use UiAutomator for versions >= 16 that's why we ignore if the device -1360 # is secure if this is true -1361 if secure == '1' and debuggable == '0' and not ignoresecuredevice and version < 16: -1362 print >> sys.stderr, "%s: ERROR: Device is secure, AndroidViewClient won't work." % progname -1363 if verbose: -1364 print >> sys.stderr, " secure=%s debuggable=%s version=%d ignoresecuredevice=%s" % \ -1365 (secure, debuggable, version, ignoresecuredevice) -1366 sys.exit(2) -1367 if re.search("[.*()+]", serialno) and not re.search("(\d{1,3}\.){3}\d{1,3}", serialno): -1368 # if a regex was used we have to determine the serialno used -1369 serialno = ViewClient.__obtainDeviceSerialNumber(device) -1370 if verbose: -1371 print >> sys.stderr, 'Actual device serialno=%s' % serialno -1372 return device, serialno -
1373 -1374 @staticmethod -
1375 - def traverseShowClassIdAndText(view, extraInfo=None, noextrainfo=None): -
1376 ''' -1377 Shows the View class, id and text if available. -1378 This function can be used as a transform function to L{ViewClient.traverse()} -1379 -1380 @type view: I{View} -1381 @param view: the View -1382 @type extraInfo: method -1383 @param extraInfo: the View method to add extra info -1384 @type noextrainfo: bool -1385 @param noextrainfo: Don't add extra info -1386 -1387 @return: the string containing class, id, and text if available -1388 ''' -1389 -1390 try: -1391 eis = '' -1392 if extraInfo: -1393 eis = extraInfo(view).__str__() -1394 if not eis and noextrainfo: -1395 eis = noextrainfo -1396 if eis: -1397 eis = ' ' + eis -1398 return "%s %s %s%s" % (view.getClass(), view.getId(), view.getText(), eis) -1399 except Exception, e: -1400 return "Exception in view=%s: %s" % (view.__smallStr__(), e) -
1401 -1402 @staticmethod -
1404 ''' -1405 Shows the View class, id, text if available and unique id. -1406 This function can be used as a transform function to L{ViewClient.traverse()} -1407 -1408 @type view: I{View} -1409 @param view: the View -1410 @return: the string containing class, id, and text if available and unique Id -1411 ''' -1412 -1413 return ViewClient.traverseShowClassIdAndText(view, View.getUniqueId) -
1414 -1415 @staticmethod -
1417 ''' -1418 Shows the View class, id, text if available and unique id. -1419 This function can be used as a transform function to L{ViewClient.traverse()} -1420 -1421 @type view: I{View} -1422 @param view: the View -1423 @return: the string containing class, id, and text if available and the content description -1424 ''' -1425 -1426 return ViewClient.traverseShowClassIdAndText(view, View.getContentDescription, 'NAF') -
1427 -1428 @staticmethod -
1430 ''' -1431 Shows the View class, id and text if available. -1432 This function can be used as a transform function to L{ViewClient.traverse()} -1433 -1434 @type view: I{View} -1435 @param view: the View -1436 @return: the string containing class, id, and text if available -1437 ''' -1438 -1439 return ViewClient.traverseShowClassIdAndText(view, View.getCenter) -
1440 -1441 @staticmethod -
1443 ''' -1444 Shows the View class, id and text if available. -1445 This function can be used as a transform function to L{ViewClient.traverse()} -1446 -1447 @type view: I{View} -1448 @param view: the View -1449 @return: the string containing class, id, and text if available -1450 ''' -1451 -1452 return ViewClient.traverseShowClassIdAndText(view, View.getPositionAndSize) -
1453 -1454 # methods that can be used to transform ViewClient.traverse output -1455 TRAVERSE_CIT = traverseShowClassIdAndText -1456 ''' An alias for L{traverseShowClassIdAndText(view)} ''' -1457 TRAVERSE_CITUI = traverseShowClassIdTextAndUniqueId -1458 ''' An alias for L{traverseShowClassIdTextAndUniqueId(view)} ''' -1459 TRAVERSE_CITCD = traverseShowClassIdTextAndContentDescription -1460 ''' An alias for L{traverseShowClassIdTextAndContentDescription(view)} ''' -1461 TRAVERSE_CITC = traverseShowClassIdTextAndCenter -1462 ''' An alias for L{traverseShowClassIdTextAndCenter(view)} ''' -1463 TRAVERSE_CITPS = traverseShowClassIdTextPositionAndSize -1464 ''' An alias for L{traverseShowClassIdTextPositionAndSize(view)} ''' -1465 -1466 @staticmethod -
1467 - def sleep(secs=1.0): -
1468 ''' -1469 Sleeps for the specified number of seconds. -1470 -1471 @type secs: float -1472 @param secs: number of seconds -1473 ''' -1474 time.sleep(secs) -
1475 -
1476 - def assertServiceResponse(self, response): -
1477 ''' -1478 Checks whether the response received from the server is correct or raises and Exception. -1479 -1480 @type response: str -1481 @param response: Response received from the server -1482 -1483 @raise Exception: If the response received from the server is invalid -1484 ''' -1485 -1486 if not self.serviceResponse(response): -1487 raise Exception('Invalid response received from service.') -
1488 -
1489 - def serviceResponse(self, response): -
1490 ''' -1491 Checks the response received from the I{ViewServer}. -1492 -1493 @return: C{True} if the response received matches L{PARCEL_TRUE}, C{False} otherwise -1494 ''' -1495 -1496 PARCEL_TRUE = "Result: Parcel(00000000 00000001 '........')\r\n" -1497 ''' The TRUE response parcel ''' -1498 if DEBUG: -1499 print >>sys.stderr, "serviceResponse: comparing '%s' vs Parcel(%s)" % (response, PARCEL_TRUE) -1500 return response == PARCEL_TRUE -
1501 -
1502 - def setViews(self, received): -
1503 ''' -1504 Sets L{self.views} to the received value splitting it into lines. -1505 -1506 @type received: str -1507 @param received: the string received from the I{View Server} -1508 ''' -1509 -1510 if not received or received == "": -1511 raise ValueError("received is empty") -1512 self.views = [] -1513 ''' The list of Views represented as C{str} obtained after splitting it into lines after being received from the server. Done by L{self.setViews()}. ''' -1514 self.__parseTree(received.split("\n")) -1515 if DEBUG: -1516 print >>sys.stderr, "there are %d views in this dump" % len(self.views) +1137 if USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: +1138 self.build[prop] = device.getProperty('build.' + prop) +1139 else: +1140 self.build[prop] = device.shell('getprop ro.build.' + prop)[:-2] +1141 except: +1142 if WARNINGS: +1143 warnings.warn("Couldn't determine build %s" % prop) +1144 +1145 if prop == VERSION_SDK_PROPERTY: +1146 # we expect it to be an int +1147 self.build[prop] = int(self.build[prop] if self.build[prop] else -1) +1148 +1149 self.ro = {} +1150 ''' The map containing the device's ro properties: secure, debuggable ''' +1151 for prop in ['secure', 'debuggable']: +1152 try: +1153 self.ro[prop] = device.shell('getprop ro.' + prop)[:-2] +1154 except: +1155 if WARNINGS: +1156 warnings.warn("Couldn't determine ro %s" % prop) +1157 self.ro[prop] = 'UNKNOWN' +1158 +1159 self.forceViewServerUse = forceviewserveruse +1160 ''' Force the use of ViewServer even if the conditions to use UiAutomator are satisfied ''' +1161 self.useUiAutomator = (self.build[VERSION_SDK_PROPERTY] >= 16) and not forceviewserveruse # jelly bean 4.1 & 4.2 +1162 ''' If UIAutomator is supported by the device it will be used ''' +1163 self.ignoreUiAutomatorKilled = ignoreuiautomatorkilled +1164 ''' On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed just after generating +1165 the dump file. In many cases the file is already complete so we can ask to ignore the 'Killed' +1166 message by setting L{ignoreuiautomatorkilled} to C{True}. +1167 +1168 Changes in 2.3.21 that uses C{/dev/tty} instead of a file may have turned this variable +1169 unnnecessary, however it has been kept for backward compatibility. +1170 ''' +1171 +1172 if self.useUiAutomator: +1173 self.textProperty = TEXT_PROPERTY_UI_AUTOMATOR +1174 else: +1175 if self.build[VERSION_SDK_PROPERTY] <= 10: +1176 self.textProperty = TEXT_PROPERTY_API_10 +1177 else: +1178 self.textProperty = TEXT_PROPERTY +1179 if startviewserver: +1180 if not self.serviceResponse(device.shell('service call window 3')): +1181 try: +1182 self.assertServiceResponse(device.shell('service call window 1 i32 %d' % +1183 remoteport)) +1184 except: +1185 msg = 'Cannot start View server.\n' \ +1186 'This only works on emulator and devices running developer versions.\n' \ +1187 'Does hierarchyviewer work on your device?\n' \ +1188 'See https://github.com/dtmilano/AndroidViewClient/wiki/Secure-mode\n\n' \ +1189 'Device properties:\n' \ +1190 ' ro.secure=%s\n' \ +1191 ' ro.debuggable=%s\n' % (self.ro['secure'], self.ro['debuggable']) +1192 raise Exception(msg) +1193 +1194 self.localPort = localport +1195 self.remotePort = remoteport +1196 # FIXME: it seems there's no way of obtaining the serialno from the MonkeyDevice +1197 subprocess.check_call([self.adb, '-s', self.serialno, 'forward', 'tcp:%d' % self.localPort, +1198 'tcp:%d' % self.remotePort]) +1199 +1200 self.windows = None +1201 ''' The list of windows as obtained by L{ViewClient.list()} ''' +1202 +1203 if autodump: +1204 self.dump() +
1205 +
1206 - def __del__(self): +
1207 # should clean up some things +1208 pass +
1209 +1210 @staticmethod +
1211 - def __obtainAdbPath(): +
1212 ''' +1213 Obtains the ADB path attempting know locations for different OSs +1214 ''' +1215 +1216 osName = java.lang.System.getProperty('os.name') +1217 isWindows = False +1218 if osName.startswith('Windows'): +1219 adb = 'adb.exe' +1220 isWindows = True +1221 else: +1222 adb = 'adb' +1223 +1224 ANDROID_HOME = os.environ['ANDROID_HOME'] if os.environ.has_key('ANDROID_HOME') else '/opt/android-sdk' +1225 HOME = os.environ['HOME'] if os.environ.has_key('HOME') else '' +1226 +1227 possibleChoices = [ os.path.join(ANDROID_HOME, 'platform-tools', adb), +1228 os.path.join(HOME, "android", 'platform-tools', adb), +1229 os.path.join(HOME, "android-sdk", 'platform-tools', adb), +1230 adb, +1231 ] +1232 +1233 if osName.startswith('Windows'): +1234 possibleChoices.append(os.path.join("""C:\Program Files\Android\android-sdk\platform-tools""", adb)) +1235 possibleChoices.append(os.path.join("""C:\Program Files (x86)\Android\android-sdk\platform-tools""", adb)) +1236 elif osName.startswith('Linux'): +1237 possibleChoices.append(os.path.join("opt", "android-sdk-linux", 'platform-tools', adb)) +1238 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-linux", 'platform-tools', adb)) +1239 possibleChoices.append(os.path.join(HOME, "android-sdk-linux", 'platform-tools', adb)) +1240 elif osName.startswith('Mac'): +1241 possibleChoices.append(os.path.join("opt", "android-sdk-mac_x86", 'platform-tools', adb)) +1242 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-mac", 'platform-tools', adb)) +1243 possibleChoices.append(os.path.join(HOME, "android-sdk-mac", 'platform-tools', adb)) +1244 possibleChoices.append(os.path.join(HOME, "opt", "android-sdk-mac_x86", 'platform-tools', adb)) +1245 possibleChoices.append(os.path.join(HOME, "android-sdk-mac_x86", 'platform-tools', adb)) +1246 else: +1247 # Unsupported OS +1248 pass +1249 +1250 for exeFile in possibleChoices: +1251 if os.access(exeFile, os.X_OK): +1252 return exeFile +1253 +1254 for path in os.environ["PATH"].split(os.pathsep): +1255 exeFile = os.path.join(path, adb) +1256 if exeFile != None and os.access(exeFile, os.X_OK if not isWindows else os.F_OK): +1257 return exeFile +1258 +1259 raise Exception('adb="%s" is not executable. Did you forget to set ANDROID_HOME in the environment?' % adb) +
1260 +1261 @staticmethod +
1262 - def __mapSerialNo(serialno): +
1263 serialno = serialno.strip() +1264 #ipRE = re.compile('^\d+\.\d+.\d+.\d+$') +1265 if IP_RE.match(serialno): +1266 if DEBUG_DEVICE: print >>sys.stderr, "ViewClient: adding default port to serialno", serialno, ADB_DEFAULT_PORT +1267 return serialno + ':%d' % ADB_DEFAULT_PORT +1268 +1269 ipPortRE = re.compile('^\d+\.\d+.\d+.\d+:\d+$') +1270 if ipPortRE.match(serialno): +1271 # nothing to map +1272 return serialno +1273 +1274 if re.search("[.*()+]", serialno): +1275 raise ValueError("Regular expression not supported as serialno in ViewClient") +1276 +1277 return serialno +
1278 +1279 @staticmethod +
1280 - def __obtainDeviceSerialNumber(device): +
1281 if DEBUG_DEVICE: print >>sys.stderr, "ViewClient: obtaining serial number for connected device" +1282 serialno = device.getProperty('ro.serialno') +1283 if not serialno: +1284 serialno = device.shell('getprop ro.serialno') +1285 if serialno: +1286 serialno = serialno[:-2] +1287 if not serialno: +1288 qemu = device.shell('getprop ro.kernel.qemu') +1289 if qemu: +1290 qemu = qemu[:-2] +1291 if qemu and int(qemu) == 1: +1292 # FIXME !!!!! +1293 # this must be calculated from somewhere, though using a fixed serialno for now +1294 warnings.warn("Running on emulator but no serial number was specified then 'emulator-5554' is used") +1295 serialno = 'emulator-5554' +1296 if not serialno: +1297 # If there's only one device connected get its serialno +1298 adb = ViewClient.__obtainAdbPath() +1299 if DEBUG_DEVICE: print >>sys.stderr, " using adb=%s" % adb +1300 s = subprocess.Popen([adb, 'get-serialno'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, env={}).communicate()[0][:-1] +1301 if s != 'unknown': +1302 serialno = s +1303 if DEBUG_DEVICE: print >>sys.stderr, " serialno=%s" % serialno +1304 if not serialno: +1305 warnings.warn("Couldn't obtain the serialno of the connected device") +1306 return serialno +
1307 +1308 @staticmethod +
1309 - def setAlarm(timeout): +
1310 osName = java.lang.System.getProperty('os.name') +1311 if osName.startswith('Windows'): # alarm is not implemented in Windows +1312 return +1313 signal.alarm(timeout) +
1314 +1315 @staticmethod +
1316 - def connectToDeviceOrExit(timeout=60, verbose=False, ignoresecuredevice=False, serialno=None): +
1317 ''' +1318 Connects to a device which serial number is obtained from the script arguments if available +1319 or using the default regex C{.*}. +1320 +1321 If the connection is not successful the script exits. +1322 L{MonkeyRunner.waitForConnection()} returns a L{MonkeyDevice} even if the connection failed. +1323 Then, to detect this situation, C{device.wake()} is attempted and if it fails then it is +1324 assumed the previous connection failed. +1325 +1326 @type timeout: int +1327 @param timeout: timeout for the connection +1328 @type verbose: bool +1329 @param verbose: Verbose output +1330 @type ignoresecuredevice: bool +1331 @param ignoresecuredevice: Ignores the check for a secure device +1332 @type serialno: str +1333 @param serialno: The device or emulator serial number +1334 +1335 @return: the device and serialno used for the connection +1336 ''' +1337 +1338 progname = os.path.basename(sys.argv[0]) +1339 if serialno is None: +1340 # eat all the extra options the invoking script may have added +1341 args = sys.argv +1342 while len(args) > 1 and args[1][0] == '-': +1343 args.pop(1) +1344 serialno = args[1] if len(args) > 1 else \ +1345 os.environ['ANDROID_SERIAL'] if os.environ.has_key('ANDROID_SERIAL') \ +1346 else '.*' +1347 if IP_RE.match(serialno): +1348 # If matches an IP address format and port was not specified add the default +1349 serialno += ':%d' % ADB_DEFAULT_PORT +1350 if verbose: +1351 print >> sys.stderr, 'Connecting to a device with serialno=%s with a timeout of %d secs...' % \ +1352 (serialno, timeout) +1353 # Sometimes MonkeyRunner doesn't even timeout (i.e. two connections from same process), so let's +1354 # handle it here +1355 ViewClient.setAlarm(timeout+5) +1356 device = MonkeyRunner.waitForConnection(timeout, serialno) +1357 ViewClient.setAlarm(0) +1358 try: +1359 device.wake() +1360 except java.lang.NullPointerException, e: +1361 print >> sys.stderr, "%s: ERROR: Couldn't connect to %s: %s" % (progname, serialno, e) +1362 sys.exit(3) +1363 if verbose: +1364 print >> sys.stderr, 'Connected to device with serialno=%s' % serialno +1365 secure = device.getSystemProperty('ro.secure') +1366 debuggable = device.getSystemProperty('ro.debuggable') +1367 versionProperty = device.getProperty('build.' + VERSION_SDK_PROPERTY) +1368 if versionProperty: +1369 version = int(versionProperty) +1370 else: +1371 if verbose: +1372 print "Couldn't obtain device SDK version" +1373 version = -1 +1374 +1375 # we are going to use UiAutomator for versions >= 16 that's why we ignore if the device +1376 # is secure if this is true +1377 if secure == '1' and debuggable == '0' and not ignoresecuredevice and version < 16: +1378 print >> sys.stderr, "%s: ERROR: Device is secure, AndroidViewClient won't work." % progname +1379 if verbose: +1380 print >> sys.stderr, " secure=%s debuggable=%s version=%d ignoresecuredevice=%s" % \ +1381 (secure, debuggable, version, ignoresecuredevice) +1382 sys.exit(2) +1383 if re.search("[.*()+]", serialno) and not re.search("(\d{1,3}\.){3}\d{1,3}", serialno): +1384 # if a regex was used we have to determine the serialno used +1385 serialno = ViewClient.__obtainDeviceSerialNumber(device) +1386 if verbose: +1387 print >> sys.stderr, 'Actual device serialno=%s' % serialno +1388 return device, serialno +
1389 +1390 @staticmethod +
1391 - def traverseShowClassIdAndText(view, extraInfo=None, noextrainfo=None): +
1392 ''' +1393 Shows the View class, id and text if available. +1394 This function can be used as a transform function to L{ViewClient.traverse()} +1395 +1396 @type view: I{View} +1397 @param view: the View +1398 @type extraInfo: method +1399 @param extraInfo: the View method to add extra info +1400 @type noextrainfo: bool +1401 @param noextrainfo: Don't add extra info +1402 +1403 @return: the string containing class, id, and text if available +1404 ''' +1405 +1406 try: +1407 eis = '' +1408 if extraInfo: +1409 eis = extraInfo(view).__str__() +1410 if not eis and noextrainfo: +1411 eis = noextrainfo +1412 if eis: +1413 eis = ' ' + eis +1414 return "%s %s %s%s" % (view.getClass(), view.getId(), view.getText(), eis) +1415 except Exception, e: +1416 return "Exception in view=%s: %s" % (view.__smallStr__(), e) +
1417 +1418 @staticmethod +
1420 ''' +1421 Shows the View class, id, text if available and unique id. +1422 This function can be used as a transform function to L{ViewClient.traverse()} +1423 +1424 @type view: I{View} +1425 @param view: the View +1426 @return: the string containing class, id, and text if available and unique Id +1427 ''' +1428 +1429 return ViewClient.traverseShowClassIdAndText(view, View.getUniqueId) +
1430 +1431 @staticmethod +
1433 ''' +1434 Shows the View class, id, text if available and unique id. +1435 This function can be used as a transform function to L{ViewClient.traverse()} +1436 +1437 @type view: I{View} +1438 @param view: the View +1439 @return: the string containing class, id, and text if available and the content description +1440 ''' +1441 +1442 return ViewClient.traverseShowClassIdAndText(view, View.getContentDescription, 'NAF') +
1443 +1444 @staticmethod +
1446 ''' +1447 Shows the View class, id and text if available. +1448 This function can be used as a transform function to L{ViewClient.traverse()} +1449 +1450 @type view: I{View} +1451 @param view: the View +1452 @return: the string containing class, id, and text if available +1453 ''' +1454 +1455 return ViewClient.traverseShowClassIdAndText(view, View.getCenter) +
1456 +1457 @staticmethod +
1459 ''' +1460 Shows the View class, id and text if available. +1461 This function can be used as a transform function to L{ViewClient.traverse()} +1462 +1463 @type view: I{View} +1464 @param view: the View +1465 @return: the string containing class, id, and text if available +1466 ''' +1467 +1468 return ViewClient.traverseShowClassIdAndText(view, View.getPositionAndSize) +
1469 +1470 # methods that can be used to transform ViewClient.traverse output +1471 TRAVERSE_CIT = traverseShowClassIdAndText +1472 ''' An alias for L{traverseShowClassIdAndText(view)} ''' +1473 TRAVERSE_CITUI = traverseShowClassIdTextAndUniqueId +1474 ''' An alias for L{traverseShowClassIdTextAndUniqueId(view)} ''' +1475 TRAVERSE_CITCD = traverseShowClassIdTextAndContentDescription +1476 ''' An alias for L{traverseShowClassIdTextAndContentDescription(view)} ''' +1477 TRAVERSE_CITC = traverseShowClassIdTextAndCenter +1478 ''' An alias for L{traverseShowClassIdTextAndCenter(view)} ''' +1479 TRAVERSE_CITPS = traverseShowClassIdTextPositionAndSize +1480 ''' An alias for L{traverseShowClassIdTextPositionAndSize(view)} ''' +1481 +1482 @staticmethod +
1483 - def sleep(secs=1.0): +
1484 ''' +1485 Sleeps for the specified number of seconds. +1486 +1487 @type secs: float +1488 @param secs: number of seconds +1489 ''' +1490 time.sleep(secs) +
1491 +
1492 - def assertServiceResponse(self, response): +
1493 ''' +1494 Checks whether the response received from the server is correct or raises and Exception. +1495 +1496 @type response: str +1497 @param response: Response received from the server +1498 +1499 @raise Exception: If the response received from the server is invalid +1500 ''' +1501 +1502 if not self.serviceResponse(response): +1503 raise Exception('Invalid response received from service.') +
1504 +
1505 - def serviceResponse(self, response): +
1506 ''' +1507 Checks the response received from the I{ViewServer}. +1508 +1509 @return: C{True} if the response received matches L{PARCEL_TRUE}, C{False} otherwise +1510 ''' +1511 +1512 PARCEL_TRUE = "Result: Parcel(00000000 00000001 '........')\r\n" +1513 ''' The TRUE response parcel ''' +1514 if DEBUG: +1515 print >>sys.stderr, "serviceResponse: comparing '%s' vs Parcel(%s)" % (response, PARCEL_TRUE) +1516 return response == PARCEL_TRUE
1517 -
1518 - def setViewsFromUiAutomatorDump(self, received): -
1519 ''' -1520 Sets L{self.views} to the received value parsing the received XML. +
1518 - def setViews(self, received): +
1519 ''' +1520 Sets L{self.views} to the received value splitting it into lines. 1521 1522 @type received: str -1523 @param received: the string received from the I{UI Automator} +1523 @param received: the string received from the I{View Server} 1524 ''' 1525 1526 if not received or received == "": 1527 raise ValueError("received is empty") 1528 self.views = [] 1529 ''' The list of Views represented as C{str} obtained after splitting it into lines after being received from the server. Done by L{self.setViews()}. ''' -1530 self.__parseTreeFromUiAutomatorDump(received) -1531 if DEBUG: +1530 self.__parseTree(received.split("\n")) +1531 if DEBUG: 1532 print >>sys.stderr, "there are %d views in this dump" % len(self.views) -
1533 -1534 -
1535 - def __splitAttrs(self, strArgs, addViewToViewsById=False): -
1536 ''' -1537 Splits the C{View} attributes in C{strArgs} and optionally adds the view id to the C{viewsById} list. -1538 -1539 Unique Ids -1540 ========== -1541 It is very common to find C{View}s having B{NO_ID} as the Id. This turns very difficult to -1542 use L{self.findViewById()}. To help in this situation this method assigns B{unique Ids} if -1543 C{addViewToViewsById} is C{True}. -1544 -1545 The B{unique Ids} are generated using the pattern C{id/no_id/<number>} with C{<number>} starting -1546 at 1. -1547 -1548 @type strArgs: str -1549 @param strArgs: the string containing the raw list of attributes and values -1550 @type addViewToViewsById: boolean -1551 @param addViewToViewsById: whether to add the parsed list of attributes and values to the -1552 map C{self.viewsById} -1553 -1554 @return: Returns the attributes map. -1555 ''' -1556 -1557 if self.useUiAutomator: -1558 raise RuntimeError("This method is not compatible with UIAutomator") -1559 # replace the spaces in text:mText to preserve them in later split -1560 # they are translated back after the attribute matches -1561 textRE = re.compile('%s=%s,' % (self.textProperty, __nd('len'))) -1562 m = textRE.search(strArgs) -1563 if m: -1564 __textStart = m.end() -1565 __textLen = int(m.group('len')) -1566 __textEnd = m.end() + __textLen -1567 s1 = strArgs[__textStart:__textEnd] -1568 s2 = s1.replace(' ', WS) -1569 strArgs = strArgs.replace(s1, s2, 1) -1570 -1571 idRE = re.compile("(?P<viewId>id/\S+)") -1572 attrRE = re.compile('%s(?P<parens>\(\))?=%s,(?P<val>[^ ]*)' % (__ns('attr'), __nd('len')), flags=re.DOTALL) -1573 hashRE = re.compile('%s@%s' % (__ns('class'), __nh('oid'))) -1574 -1575 attrs = {} -1576 viewId = None -1577 m = idRE.search(strArgs) -1578 if m: -1579 viewId = m.group('viewId') -1580 if DEBUG: -1581 print >>sys.stderr, "found view with id=%s" % viewId -1582 -1583 for attr in strArgs.split(): -1584 m = attrRE.match(attr) -1585 if m: -1586 __attr = m.group('attr') -1587 __parens = '()' if m.group('parens') else '' -1588 __len = int(m.group('len')) -1589 __val = m.group('val') -1590 if WARNINGS and __len != len(__val): -1591 warnings.warn("Invalid len: expected: %d found: %d s=%s e=%s" % (__len, len(__val), __val[:50], __val[-50:])) -1592 if __attr == self.textProperty: -1593 # restore spaces that have been replaced -1594 __val = __val.replace(WS, ' ') -1595 attrs[__attr + __parens] = __val -1596 else: -1597 m = hashRE.match(attr) -1598 if m: -1599 attrs['class'] = m.group('class') -1600 attrs['oid'] = m.group('oid') -1601 else: -1602 if DEBUG: -1603 print >>sys.stderr, attr, "doesn't match" -1604 -1605 if addViewToViewsById: -1606 if not viewId: -1607 # If the view has NO_ID we are assigning a default id here (id/no_id) which is -1608 # immediately incremented if another view with no id was found before to generate -1609 # a unique id -1610 viewId = "id/no_id/1" -1611 if viewId in self.viewsById: -1612 # sometimes the view ids are not unique, so let's generate a unique id here -1613 i = 1 -1614 while True: -1615 newId = re.sub('/\d+$', '', viewId) + '/%d' % i -1616 if not newId in self.viewsById: -1617 break -1618 i += 1 -1619 viewId = newId -1620 if DEBUG: -1621 print >>sys.stderr, "adding viewById %s" % viewId -1622 # We are assigning a new attribute to keep the original id preserved, which could have -1623 # been NO_ID repeated multiple times -1624 attrs['uniqueId'] = viewId -1625 self.viewsById[viewId] = attrs -1626 -1627 return attrs -
1628 -
1629 - def __parseTree(self, receivedLines): -
1630 ''' -1631 Parses the View tree contained in L{receivedLines}. The tree is created and the root node assigned to L{self.root}. -1632 -1633 @type receivedLines: str -1634 @param receivedLines: the string received from B{View Server} -1635 ''' -1636 -1637 self.root = None -1638 self.viewsById = {} -1639 self.views = [] -1640 parent = None -1641 parents = [] -1642 treeLevel = -1 -1643 newLevel = -1 -1644 lastView = None -1645 for v in receivedLines: -1646 if v == '' or v == 'DONE' or v == 'DONE.': -1647 break -1648 attrs = self.__splitAttrs(v, addViewToViewsById=True) -1649 if not self.root: -1650 if v[0] == ' ': -1651 raise Exception("Unexpected root element starting with ' '.") -1652 self.root = View.factory(attrs, self.device, self.build[VERSION_SDK_PROPERTY], self.forceViewServerUse) -1653 if DEBUG: self.root.raw = v -1654 treeLevel = 0 -1655 newLevel = 0 -1656 lastView = self.root -1657 parent = self.root -1658 parents.append(parent) -1659 else: -1660 newLevel = (len(v) - len(v.lstrip())) -1661 if newLevel == 0: -1662 raise Exception("newLevel==0 treeLevel=%d but tree can have only one root, v=%s" % (treeLevel, v)) -1663 child = View.factory(attrs, self.device, self.build[VERSION_SDK_PROPERTY], self.forceViewServerUse) -1664 if DEBUG: child.raw = v -1665 if newLevel == treeLevel: -1666 parent.add(child) -1667 lastView = child -1668 elif newLevel > treeLevel: -1669 if (newLevel - treeLevel) != 1: -1670 raise Exception("newLevel jumps %d levels, v=%s" % ((newLevel-treeLevel), v)) -1671 parent = lastView -1672 parents.append(parent) -1673 parent.add(child) -1674 lastView = child -1675 treeLevel = newLevel -1676 else: # newLevel < treeLevel -1677 for i in range(treeLevel - newLevel): -1678 parents.pop() -1679 parent = parents.pop() -1680 parents.append(parent) -1681 parent.add(child) -1682 treeLevel = newLevel +
1533 +
1534 - def setViewsFromUiAutomatorDump(self, received): +
1535 ''' +1536 Sets L{self.views} to the received value parsing the received XML. +1537 +1538 @type received: str +1539 @param received: the string received from the I{UI Automator} +1540 ''' +1541 +1542 if not received or received == "": +1543 raise ValueError("received is empty") +1544 self.views = [] +1545 ''' The list of Views represented as C{str} obtained after splitting it into lines after being received from the server. Done by L{self.setViews()}. ''' +1546 self.__parseTreeFromUiAutomatorDump(received) +1547 if DEBUG: +1548 print >>sys.stderr, "there are %d views in this dump" % len(self.views) +
1549 +1550 +
1551 - def __splitAttrs(self, strArgs, addViewToViewsById=False): +
1552 ''' +1553 Splits the C{View} attributes in C{strArgs} and optionally adds the view id to the C{viewsById} list. +1554 +1555 Unique Ids +1556 ========== +1557 It is very common to find C{View}s having B{NO_ID} as the Id. This turns very difficult to +1558 use L{self.findViewById()}. To help in this situation this method assigns B{unique Ids} if +1559 C{addViewToViewsById} is C{True}. +1560 +1561 The B{unique Ids} are generated using the pattern C{id/no_id/<number>} with C{<number>} starting +1562 at 1. +1563 +1564 @type strArgs: str +1565 @param strArgs: the string containing the raw list of attributes and values +1566 @type addViewToViewsById: boolean +1567 @param addViewToViewsById: whether to add the parsed list of attributes and values to the +1568 map C{self.viewsById} +1569 +1570 @return: Returns the attributes map. +1571 ''' +1572 +1573 if self.useUiAutomator: +1574 raise RuntimeError("This method is not compatible with UIAutomator") +1575 # replace the spaces in text:mText to preserve them in later split +1576 # they are translated back after the attribute matches +1577 textRE = re.compile('%s=%s,' % (self.textProperty, __nd('len'))) +1578 m = textRE.search(strArgs) +1579 if m: +1580 __textStart = m.end() +1581 __textLen = int(m.group('len')) +1582 __textEnd = m.end() + __textLen +1583 s1 = strArgs[__textStart:__textEnd] +1584 s2 = s1.replace(' ', WS) +1585 strArgs = strArgs.replace(s1, s2, 1) +1586 +1587 idRE = re.compile("(?P<viewId>id/\S+)") +1588 attrRE = re.compile('%s(?P<parens>\(\))?=%s,(?P<val>[^ ]*)' % (__ns('attr'), __nd('len')), flags=re.DOTALL) +1589 hashRE = re.compile('%s@%s' % (__ns('class'), __nh('oid'))) +1590 +1591 attrs = {} +1592 viewId = None +1593 m = idRE.search(strArgs) +1594 if m: +1595 viewId = m.group('viewId') +1596 if DEBUG: +1597 print >>sys.stderr, "found view with id=%s" % viewId +1598 +1599 for attr in strArgs.split(): +1600 m = attrRE.match(attr) +1601 if m: +1602 __attr = m.group('attr') +1603 __parens = '()' if m.group('parens') else '' +1604 __len = int(m.group('len')) +1605 __val = m.group('val') +1606 if WARNINGS and __len != len(__val): +1607 warnings.warn("Invalid len: expected: %d found: %d s=%s e=%s" % (__len, len(__val), __val[:50], __val[-50:])) +1608 if __attr == self.textProperty: +1609 # restore spaces that have been replaced +1610 __val = __val.replace(WS, ' ') +1611 attrs[__attr + __parens] = __val +1612 else: +1613 m = hashRE.match(attr) +1614 if m: +1615 attrs['class'] = m.group('class') +1616 attrs['oid'] = m.group('oid') +1617 else: +1618 if DEBUG: +1619 print >>sys.stderr, attr, "doesn't match" +1620 +1621 if addViewToViewsById: +1622 if not viewId: +1623 # If the view has NO_ID we are assigning a default id here (id/no_id) which is +1624 # immediately incremented if another view with no id was found before to generate +1625 # a unique id +1626 viewId = "id/no_id/1" +1627 if viewId in self.viewsById: +1628 # sometimes the view ids are not unique, so let's generate a unique id here +1629 i = 1 +1630 while True: +1631 newId = re.sub('/\d+$', '', viewId) + '/%d' % i +1632 if not newId in self.viewsById: +1633 break +1634 i += 1 +1635 viewId = newId +1636 if DEBUG: +1637 print >>sys.stderr, "adding viewById %s" % viewId +1638 # We are assigning a new attribute to keep the original id preserved, which could have +1639 # been NO_ID repeated multiple times +1640 attrs['uniqueId'] = viewId +1641 self.viewsById[viewId] = attrs +1642 +1643 return attrs +
1644 +
1645 - def __parseTree(self, receivedLines): +
1646 ''' +1647 Parses the View tree contained in L{receivedLines}. The tree is created and the root node assigned to L{self.root}. +1648 +1649 @type receivedLines: str +1650 @param receivedLines: the string received from B{View Server} +1651 ''' +1652 +1653 self.root = None +1654 self.viewsById = {} +1655 self.views = [] +1656 parent = None +1657 parents = [] +1658 treeLevel = -1 +1659 newLevel = -1 +1660 lastView = None +1661 for v in receivedLines: +1662 if v == '' or v == 'DONE' or v == 'DONE.': +1663 break +1664 attrs = self.__splitAttrs(v, addViewToViewsById=True) +1665 if not self.root: +1666 if v[0] == ' ': +1667 raise Exception("Unexpected root element starting with ' '.") +1668 self.root = View.factory(attrs, self.device, self.build[VERSION_SDK_PROPERTY], self.forceViewServerUse) +1669 if DEBUG: self.root.raw = v +1670 treeLevel = 0 +1671 newLevel = 0 +1672 lastView = self.root +1673 parent = self.root +1674 parents.append(parent) +1675 else: +1676 newLevel = (len(v) - len(v.lstrip())) +1677 if newLevel == 0: +1678 raise Exception("newLevel==0 treeLevel=%d but tree can have only one root, v=%s" % (treeLevel, v)) +1679 child = View.factory(attrs, self.device, self.build[VERSION_SDK_PROPERTY], self.forceViewServerUse) +1680 if DEBUG: child.raw = v +1681 if newLevel == treeLevel: +1682 parent.add(child) 1683 lastView = child -1684 self.views.append(lastView) -
1685 -
1686 - def __parseTreeFromUiAutomatorDump(self, receivedXml): -
1687 parser = UiAutomator2AndroidViewClient(self.device, self.build[VERSION_SDK_PROPERTY]) -1688 self.root = parser.Parse(receivedXml) -1689 self.views = parser.viewsById -
1690 -
1691 - def getRoot(self): -
1692 ''' -1693 Gets the root node of the C{View} tree -1694 -1695 @return: the root node of the C{View} tree -1696 ''' -1697 return self.root -
1698 -
1699 - def traverse(self, root="ROOT", indent="", transform=View.__str__, stream=sys.stdout): -
1700 ''' -1701 Traverses the C{View} tree and prints its nodes. -1702 -1703 The nodes are printed converting them to string but other transformations can be specified -1704 by providing a method name as the C{transform} parameter. -1705 -1706 @type root: L{View} -1707 @param root: the root node from where the traverse starts -1708 @type indent: str -1709 @param indent: the indentation string to use to print the nodes -1710 @type transform: method -1711 @param transform: a method to use to transform the node before is printed +1684 elif newLevel > treeLevel: +1685 if (newLevel - treeLevel) != 1: +1686 raise Exception("newLevel jumps %d levels, v=%s" % ((newLevel-treeLevel), v)) +1687 parent = lastView +1688 parents.append(parent) +1689 parent.add(child) +1690 lastView = child +1691 treeLevel = newLevel +1692 else: # newLevel < treeLevel +1693 for i in range(treeLevel - newLevel): +1694 parents.pop() +1695 parent = parents.pop() +1696 parents.append(parent) +1697 parent.add(child) +1698 treeLevel = newLevel +1699 lastView = child +1700 self.views.append(lastView) +
1701 +
1702 - def __parseTreeFromUiAutomatorDump(self, receivedXml): +
1703 parser = UiAutomator2AndroidViewClient(self.device, self.build[VERSION_SDK_PROPERTY]) +1704 self.root = parser.Parse(receivedXml) +1705 self.views = parser.viewsById +
1706 +
1707 - def getRoot(self): +
1708 ''' +1709 Gets the root node of the C{View} tree +1710 +1711 @return: the root node of the C{View} tree 1712 ''' -1713 -1714 if type(root) == types.StringType and root == "ROOT": -1715 root = self.root -1716 -1717 if not root: -1718 return -1719 -1720 s = transform(root) -1721 if s: -1722 print >>stream, "%s%s" % (indent, s) -1723 -1724 for ch in root.children: -1725 self.traverse(ch, indent=indent+" ", transform=transform, stream=stream) -
1726 -
1727 - def dump(self, window=-1, sleep=1): -
1728 ''' -1729 Dumps the window content. -1730 -1731 Sleep is useful to wait some time before obtaining the new content when something in the -1732 window has changed. -1733 -1734 @type window: int or str -1735 @param window: the window id or name of the window to dump. -1736 The B{name} is the package name or the window name (i.e. StatusBar) for -1737 system windows. -1738 The window id can be provided as C{int} or C{str}. The C{str} should represent -1739 and C{int} in either base 10 or 16. -1740 Use -1 to dump all windows. -1741 This parameter only is used when the backend is B{ViewServer} and it's -1742 ignored for B{UiAutomator}. -1743 @type sleep: int -1744 @param sleep: sleep in seconds before proceeding to dump the content -1745 -1746 @return: the list of Views as C{str} received from the server after being split into lines -1747 ''' -1748 -1749 if sleep > 0: -1750 MonkeyRunner.sleep(sleep) -1751 -1752 if self.useUiAutomator: -1753 # NOTICE: -1754 # Using /dev/tty this works even on devices with no sdcard -1755 received = self.device.shell('uiautomator dump /dev/tty >/dev/null') -1756 if not received: -1757 raise RuntimeError('ERROR: Getting UIAutomator dump') -1758 received = received.encode('ascii', 'ignore') -1759 if DEBUG: -1760 self.received = received -1761 if DEBUG_RECEIVED: -1762 print >>sys.stderr, "received %d chars" % len(received) -1763 print >>sys.stderr -1764 print >>sys.stderr, received -1765 print >>sys.stderr -1766 if self.ignoreUiAutomatorKilled: -1767 if DEBUG_RECEIVED: -1768 print >>sys.stderr, "ignoring UiAutomator Killed" -1769 killedRE = re.compile('</hierarchy>[\n\S]*Killed', re.MULTILINE) -1770 if killedRE.search(received): -1771 received = re.sub(killedRE, '</hierarchy>', received) -1772 elif DEBUG_RECEIVED: -1773 print "UiAutomator Killed: NOT FOUND!" -1774 if DEBUG_RECEIVED: -1775 print >>sys.stderr, "received=", received -1776 if re.search('\[: not found', received): -1777 raise RuntimeError('''ERROR: Some emulator images (i.e. android 4.1.2 API 16 generic_x86) does not include the '[' command. -1778 While UiAutomator back-end might be supported 'uiautomator' command fails. -1779 You should force ViewServer back-end.''') -1780 self.setViewsFromUiAutomatorDump(received) -1781 else: -1782 if isinstance(window, str): -1783 self.list(sleep=0) -1784 found = False -1785 for wId in self.windows: -1786 try: -1787 if window == self.windows[wId]: -1788 window = wId -1789 found = True -1790 break -1791 except: -1792 pass -1793 try: -1794 if int(window) == wId: -1795 window = wId -1796 found = True -1797 break -1798 except: -1799 pass -1800 try: -1801 if int(window, 16) == wId: -1802 window = wId -1803 found = True -1804 break -1805 except: -1806 pass -1807 -1808 if not found: -1809 raise RuntimeError("ERROR: Cannot find window '%s' in %s" % (window, self.windows)) -1810 -1811 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) -1812 try: -1813 s.connect((VIEW_SERVER_HOST, self.localPort)) -1814 except socket.error, ex: -1815 raise RuntimeError("ERROR: Connecting to %s:%d: %s" % (VIEW_SERVER_HOST, self.localPort, ex)) -1816 cmd = 'dump %x\r\n' % window -1817 if DEBUG: -1818 print >>sys.stderr, "executing: '%s'" % cmd -1819 s.send(cmd) -1820 received = "" -1821 doneRE = re.compile("DONE") -1822 ViewClient.setAlarm(120) -1823 while True: -1824 if DEBUG_RECEIVED: -1825 print >>sys.stderr, " reading from socket..." -1826 received += s.recv(1024) -1827 if doneRE.search(received[-7:]): -1828 break -1829 s.close() -1830 ViewClient.setAlarm(0) -1831 if DEBUG: -1832 self.received = received -1833 if DEBUG_RECEIVED: -1834 print >>sys.stderr, "received %d chars" % len(received) -1835 print >>sys.stderr -1836 print >>sys.stderr, received -1837 print >>sys.stderr -1838 self.setViews(received) -1839 -1840 if DEBUG_TREE: -1841 self.traverse(self.root) -1842 -1843 return self.views -
1844 -
1845 - def list(self, sleep=1): -
1846 ''' -1847 List the windows. -1848 -1849 Sleep is useful to wait some time before obtaining the new content when something in the -1850 window has changed. -1851 This also sets L{self.windows} as the list of windows. -1852 -1853 @type sleep: int -1854 @param sleep: sleep in seconds before proceeding to dump the content -1855 -1856 @return: the list of windows -1857 ''' -1858 -1859 if sleep > 0: -1860 MonkeyRunner.sleep(sleep) -1861 -1862 if self.useUiAutomator: -1863 raise Exception("Not implemented yet: listing windows with UiAutomator") -1864 else: -1865 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) -1866 try: -1867 s.connect((VIEW_SERVER_HOST, self.localPort)) -1868 except socket.error, ex: -1869 raise RuntimeError("ERROR: Connecting to %s:%d: %s" % (VIEW_SERVER_HOST, self.localPort, ex)) -1870 s.send('list\r\n') -1871 received = "" -1872 doneRE = re.compile("DONE") -1873 while True: -1874 received += s.recv(1024) -1875 if doneRE.search(received[-7:]): -1876 break -1877 s.close() -1878 if DEBUG: -1879 self.received = received -1880 if DEBUG_RECEIVED: -1881 print >>sys.stderr, "received %d chars" % len(received) -1882 print >>sys.stderr -1883 print >>sys.stderr, received -1884 print >>sys.stderr -1885 -1886 self.windows = {} -1887 for line in received.split('\n'): -1888 if not line: -1889 break -1890 if doneRE.search(line): -1891 break -1892 (wid, package) = line.split() -1893 self.windows[int('0x' + wid, 16)] = package -1894 return self.windows -
1895 -1896 -
1897 - def findViewById(self, viewId, root="ROOT", viewFilter=None): -
1898 ''' -1899 Finds the View with the specified viewId. -1900 -1901 @type viewId: str -1902 @param viewId: the ID of the view to find -1903 @type root: str -1904 @type root: View -1905 @param root: the root node of the tree where the View will be searched -1906 @type: viewFilter: function -1907 @param viewFilter: a function that will be invoked providing the candidate View as a parameter -1908 and depending on the return value (C{True} or C{False}) the View will be -1909 selected and returned as the result of C{findViewById()} or ignored. -1910 This can be C{None} and no extra filtering is applied. -1911 -1912 @return: the C{View} found or C{None} -1913 ''' +1713 return self.root +
1714 +
1715 - def traverse(self, root="ROOT", indent="", transform=View.__str__, stream=sys.stdout): +
1716 ''' +1717 Traverses the C{View} tree and prints its nodes. +1718 +1719 The nodes are printed converting them to string but other transformations can be specified +1720 by providing a method name as the C{transform} parameter. +1721 +1722 @type root: L{View} +1723 @param root: the root node from where the traverse starts +1724 @type indent: str +1725 @param indent: the indentation string to use to print the nodes +1726 @type transform: method +1727 @param transform: a method to use to transform the node before is printed +1728 ''' +1729 +1730 if type(root) == types.StringType and root == "ROOT": +1731 root = self.root +1732 +1733 return ViewClient.__traverse(root, indent, transform, stream) +
1734 # if not root: +1735 # return +1736 # +1737 # s = transform(root) +1738 # if s: +1739 # print >>stream, "%s%s" % (indent, s) +1740 # +1741 # for ch in root.children: +1742 # self.traverse(ch, indent=indent+" ", transform=transform, stream=stream) +1743 +1744 @staticmethod +
1745 - def __traverse(root, indent="", transform=View.__str__, stream=sys.stdout): +
1746 if not root: +1747 return +1748 +1749 s = transform(root) +1750 if s: +1751 print >>stream, "%s%s" % (indent, s) +1752 +1753 for ch in root.children: +1754 ViewClient.__traverse(ch, indent=indent+" ", transform=transform, stream=stream) +
1755 +
1756 - def dump(self, window=-1, sleep=1): +
1757 ''' +1758 Dumps the window content. +1759 +1760 Sleep is useful to wait some time before obtaining the new content when something in the +1761 window has changed. +1762 +1763 @type window: int or str +1764 @param window: the window id or name of the window to dump. +1765 The B{name} is the package name or the window name (i.e. StatusBar) for +1766 system windows. +1767 The window id can be provided as C{int} or C{str}. The C{str} should represent +1768 and C{int} in either base 10 or 16. +1769 Use -1 to dump all windows. +1770 This parameter only is used when the backend is B{ViewServer} and it's +1771 ignored for B{UiAutomator}. +1772 @type sleep: int +1773 @param sleep: sleep in seconds before proceeding to dump the content +1774 +1775 @return: the list of Views as C{str} received from the server after being split into lines +1776 ''' +1777 +1778 if sleep > 0: +1779 MonkeyRunner.sleep(sleep) +1780 +1781 if self.useUiAutomator: +1782 # NOTICE: +1783 # Using /dev/tty this works even on devices with no sdcard +1784 received = self.device.shell('uiautomator dump /dev/tty >/dev/null') +1785 if not received: +1786 raise RuntimeError('ERROR: Getting UIAutomator dump') +1787 received = received.encode('ascii', 'ignore') +1788 if DEBUG: +1789 self.received = received +1790 if DEBUG_RECEIVED: +1791 print >>sys.stderr, "received %d chars" % len(received) +1792 print >>sys.stderr +1793 print >>sys.stderr, received +1794 print >>sys.stderr +1795 if self.ignoreUiAutomatorKilled: +1796 if DEBUG_RECEIVED: +1797 print >>sys.stderr, "ignoring UiAutomator Killed" +1798 killedRE = re.compile('</hierarchy>[\n\S]*Killed', re.MULTILINE) +1799 if killedRE.search(received): +1800 received = re.sub(killedRE, '</hierarchy>', received) +1801 elif DEBUG_RECEIVED: +1802 print "UiAutomator Killed: NOT FOUND!" +1803 if DEBUG_RECEIVED: +1804 print >>sys.stderr, "received=", received +1805 if re.search('\[: not found', received): +1806 raise RuntimeError('''ERROR: Some emulator images (i.e. android 4.1.2 API 16 generic_x86) does not include the '[' command. +1807 While UiAutomator back-end might be supported 'uiautomator' command fails. +1808 You should force ViewServer back-end.''') +1809 self.setViewsFromUiAutomatorDump(received) +1810 else: +1811 if isinstance(window, str): +1812 self.list(sleep=0) +1813 found = False +1814 for wId in self.windows: +1815 try: +1816 if window == self.windows[wId]: +1817 window = wId +1818 found = True +1819 break +1820 except: +1821 pass +1822 try: +1823 if int(window) == wId: +1824 window = wId +1825 found = True +1826 break +1827 except: +1828 pass +1829 try: +1830 if int(window, 16) == wId: +1831 window = wId +1832 found = True +1833 break +1834 except: +1835 pass +1836 +1837 if not found: +1838 raise RuntimeError("ERROR: Cannot find window '%s' in %s" % (window, self.windows)) +1839 +1840 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) +1841 try: +1842 s.connect((VIEW_SERVER_HOST, self.localPort)) +1843 except socket.error, ex: +1844 raise RuntimeError("ERROR: Connecting to %s:%d: %s" % (VIEW_SERVER_HOST, self.localPort, ex)) +1845 cmd = 'dump %x\r\n' % window +1846 if DEBUG: +1847 print >>sys.stderr, "executing: '%s'" % cmd +1848 s.send(cmd) +1849 received = "" +1850 doneRE = re.compile("DONE") +1851 ViewClient.setAlarm(120) +1852 while True: +1853 if DEBUG_RECEIVED: +1854 print >>sys.stderr, " reading from socket..." +1855 received += s.recv(1024) +1856 if doneRE.search(received[-7:]): +1857 break +1858 s.close() +1859 ViewClient.setAlarm(0) +1860 if DEBUG: +1861 self.received = received +1862 if DEBUG_RECEIVED: +1863 print >>sys.stderr, "received %d chars" % len(received) +1864 print >>sys.stderr +1865 print >>sys.stderr, received +1866 print >>sys.stderr +1867 self.setViews(received) +1868 +1869 if DEBUG_TREE: +1870 self.traverse(self.root) +1871 +1872 return self.views +
1873 +
1874 - def list(self, sleep=1): +
1875 ''' +1876 List the windows. +1877 +1878 Sleep is useful to wait some time before obtaining the new content when something in the +1879 window has changed. +1880 This also sets L{self.windows} as the list of windows. +1881 +1882 @type sleep: int +1883 @param sleep: sleep in seconds before proceeding to dump the content +1884 +1885 @return: the list of windows +1886 ''' +1887 +1888 if sleep > 0: +1889 MonkeyRunner.sleep(sleep) +1890 +1891 if self.useUiAutomator: +1892 raise Exception("Not implemented yet: listing windows with UiAutomator") +1893 else: +1894 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) +1895 try: +1896 s.connect((VIEW_SERVER_HOST, self.localPort)) +1897 except socket.error, ex: +1898 raise RuntimeError("ERROR: Connecting to %s:%d: %s" % (VIEW_SERVER_HOST, self.localPort, ex)) +1899 s.send('list\r\n') +1900 received = "" +1901 doneRE = re.compile("DONE") +1902 while True: +1903 received += s.recv(1024) +1904 if doneRE.search(received[-7:]): +1905 break +1906 s.close() +1907 if DEBUG: +1908 self.received = received +1909 if DEBUG_RECEIVED: +1910 print >>sys.stderr, "received %d chars" % len(received) +1911 print >>sys.stderr +1912 print >>sys.stderr, received +1913 print >>sys.stderr 1914 -1915 if not root: -1916 return None -1917 -1918 if type(root) == types.StringType and root == "ROOT": -1919 return self.findViewById(viewId, self.root, viewFilter) -1920 -1921 if root.getId() == viewId: -1922 if viewFilter: -1923 if viewFilter(root): -1924 return root -1925 else: -1926 return root -1927 -1928 if re.match('^id/no_id', viewId) or re.match('^id/.+/.+', viewId): -1929 if root.getUniqueId() == viewId: -1930 if viewFilter: -1931 if viewFilter(root): -1932 return root; -1933 else: -1934 return root -1935 -1936 -1937 for ch in root.children: -1938 foundView = self.findViewById(viewId, ch, viewFilter) -1939 if foundView: -1940 if viewFilter: -1941 if viewFilter(foundView): -1942 return foundView -1943 else: -1944 return foundView -
1945 -
1946 - def findViewByIdOrRaise(self, viewId, root="ROOT", viewFilter=None): -
1947 ''' -1948 Finds the View or raise a ViewNotFoundException. -1949 -1950 @type viewId: str -1951 @param viewId: the ID of the view to find -1952 @type root: str -1953 @type root: View -1954 @param root: the root node of the tree where the View will be searched -1955 @type: viewFilter: function -1956 @param viewFilter: a function that will be invoked providing the candidate View as a parameter -1957 and depending on the return value (C{True} or C{False}) the View will be -1958 selected and returned as the result of C{findViewById()} or ignored. -1959 This can be C{None} and no extra filtering is applied. -1960 @return: the View found -1961 @raise ViewNotFoundException: raise the exception if View not found -1962 ''' -1963 -1964 view = self.findViewById(viewId, root, viewFilter) -1965 if view: -1966 return view -1967 else: -1968 raise ViewNotFoundException("ID", viewId, root) -
1969 -
1970 - def findViewByTag(self, tag, root="ROOT"): -
1971 ''' -1972 Finds the View with the specified tag -1973 ''' -1974 -1975 return self.findViewWithAttribute('getTag()', tag, root) -
1976 -
1977 - def findViewByTagOrRaise(self, tag, root="ROOT"): -
1978 ''' -1979 Finds the View with the specified tag or raise a ViewNotFoundException -1980 ''' -1981 -1982 view = self.findViewWithAttribute('getTag()', tag, root) -1983 if view: -1984 return view -1985 else: -1986 raise ViewNotFoundException("tag", tag, root) -
1987 -
1988 - def __findViewWithAttributeInTree(self, attr, val, root): -
1989 if not self.root: -1990 print >>sys.stderr, "ERROR: no root, did you forget to call dump()?" -1991 return None -1992 -1993 if type(root) == types.StringType and root == "ROOT": -1994 root = self.root -1995 -1996 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTree: checking if root=%s has attr=%s == %s" % (root.__smallStr__(), attr, val) -1997 -1998 if isinstance(val, org.python.modules.sre.PatternObject): -1999 return self.__findViewWithAttributeInTreeThatMatches(attr, val, root) -2000 else: -2001 if root and attr in root.map and root.map[attr] == val: -2002 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTree: FOUND: %s" % root.__smallStr__() -2003 return root -2004 else: -2005 for ch in root.children: -2006 v = self.__findViewWithAttributeInTree(attr, val, ch) -2007 if v: -2008 return v -2009 -2010 return None -
2011 -
2012 - def __findViewWithAttributeInTreeOrRaise(self, attr, val, root): -
2013 view = self.__findViewWithAttributeInTree(attr, val, root) -2014 if view: -2015 return view -2016 else: -2017 raise ViewNotFoundException(attr, val, root) -
2018 -
2019 - def __findViewWithAttributeInTreeThatMatches(self, attr, regex, root, rlist=[]): -
2020 if not self.root: -2021 print >>sys.stderr, "ERROR: no root, did you forget to call dump()?" -2022 return None -2023 -2024 if type(root) == types.StringType and root == "ROOT": -2025 root = self.root -2026 -2027 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTreeThatMatches: checking if root=%s attr=%s matches %s" % (root.__smallStr__(), attr, regex) -2028 -2029 if root and attr in root.map and regex.match(root.map[attr]): -2030 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTreeThatMatches: FOUND: %s" % root.__smallStr__() -2031 return root -2032 #print >>sys.stderr, "appending root=%s to rlist=%s" % (root.__smallStr__(), rlist) -2033 #return rlist.append(root) -2034 else: -2035 for ch in root.children: -2036 v = self.__findViewWithAttributeInTreeThatMatches(attr, regex, ch, rlist) -2037 if v: -2038 return v -2039 #print >>sys.stderr, "appending v=%s to rlist=%s" % (v.__smallStr__(), rlist) -2040 #return rlist.append(v) -2041 -2042 return None -
2043 #return rlist -2044 -
2045 - def findViewWithAttribute(self, attr, val, root="ROOT"): -
2046 ''' -2047 Finds the View with the specified attribute and value -2048 ''' -2049 -2050 return self.__findViewWithAttributeInTree(attr, val, root) -
2051 -
2052 - def findViewWithAttributeOrRaise(self, attr, val, root="ROOT"): -
2053 ''' -2054 Finds the View or raise a ViewNotFoundException. -2055 -2056 @return: the View found -2057 @raise ViewNotFoundException: raise the exception if View not found -2058 ''' -2059 -2060 view = self.findViewWithAttribute(attr, val, root) -2061 if view: -2062 return view +1915 self.windows = {} +1916 for line in received.split('\n'): +1917 if not line: +1918 break +1919 if doneRE.search(line): +1920 break +1921 (wid, package) = line.split() +1922 self.windows[int('0x' + wid, 16)] = package +1923 return self.windows +
1924 +1925 +
1926 - def findViewById(self, viewId, root="ROOT", viewFilter=None): +
1927 ''' +1928 Finds the View with the specified viewId. +1929 +1930 @type viewId: str +1931 @param viewId: the ID of the view to find +1932 @type root: str +1933 @type root: View +1934 @param root: the root node of the tree where the View will be searched +1935 @type: viewFilter: function +1936 @param viewFilter: a function that will be invoked providing the candidate View as a parameter +1937 and depending on the return value (C{True} or C{False}) the View will be +1938 selected and returned as the result of C{findViewById()} or ignored. +1939 This can be C{None} and no extra filtering is applied. +1940 +1941 @return: the C{View} found or C{None} +1942 ''' +1943 +1944 if not root: +1945 return None +1946 +1947 if type(root) == types.StringType and root == "ROOT": +1948 return self.findViewById(viewId, self.root, viewFilter) +1949 +1950 if root.getId() == viewId: +1951 if viewFilter: +1952 if viewFilter(root): +1953 return root +1954 else: +1955 return root +1956 +1957 if re.match('^id/no_id', viewId) or re.match('^id/.+/.+', viewId): +1958 if root.getUniqueId() == viewId: +1959 if viewFilter: +1960 if viewFilter(root): +1961 return root; +1962 else: +1963 return root +1964 +1965 +1966 for ch in root.children: +1967 foundView = self.findViewById(viewId, ch, viewFilter) +1968 if foundView: +1969 if viewFilter: +1970 if viewFilter(foundView): +1971 return foundView +1972 else: +1973 return foundView +
1974 +
1975 - def findViewByIdOrRaise(self, viewId, root="ROOT", viewFilter=None): +
1976 ''' +1977 Finds the View or raise a ViewNotFoundException. +1978 +1979 @type viewId: str +1980 @param viewId: the ID of the view to find +1981 @type root: str +1982 @type root: View +1983 @param root: the root node of the tree where the View will be searched +1984 @type: viewFilter: function +1985 @param viewFilter: a function that will be invoked providing the candidate View as a parameter +1986 and depending on the return value (C{True} or C{False}) the View will be +1987 selected and returned as the result of C{findViewById()} or ignored. +1988 This can be C{None} and no extra filtering is applied. +1989 @return: the View found +1990 @raise ViewNotFoundException: raise the exception if View not found +1991 ''' +1992 +1993 view = self.findViewById(viewId, root, viewFilter) +1994 if view: +1995 return view +1996 else: +1997 raise ViewNotFoundException("ID", viewId, root) +
1998 +
1999 - def findViewByTag(self, tag, root="ROOT"): +
2000 ''' +2001 Finds the View with the specified tag +2002 ''' +2003 +2004 return self.findViewWithAttribute('getTag()', tag, root) +
2005 +
2006 - def findViewByTagOrRaise(self, tag, root="ROOT"): +
2007 ''' +2008 Finds the View with the specified tag or raise a ViewNotFoundException +2009 ''' +2010 +2011 view = self.findViewWithAttribute('getTag()', tag, root) +2012 if view: +2013 return view +2014 else: +2015 raise ViewNotFoundException("tag", tag, root) +
2016 +
2017 - def __findViewWithAttributeInTree(self, attr, val, root): +
2018 if not self.root: +2019 print >>sys.stderr, "ERROR: no root, did you forget to call dump()?" +2020 return None +2021 +2022 if type(root) == types.StringType and root == "ROOT": +2023 root = self.root +2024 +2025 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTree: checking if root=%s has attr=%s == %s" % (root.__smallStr__(), attr, val) +2026 +2027 if isinstance(val, org.python.modules.sre.PatternObject): +2028 return self.__findViewWithAttributeInTreeThatMatches(attr, val, root) +2029 else: +2030 if root and attr in root.map and root.map[attr] == val: +2031 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTree: FOUND: %s" % root.__smallStr__() +2032 return root +2033 else: +2034 for ch in root.children: +2035 v = self.__findViewWithAttributeInTree(attr, val, ch) +2036 if v: +2037 return v +2038 +2039 return None +
2040 +
2041 - def __findViewWithAttributeInTreeOrRaise(self, attr, val, root): +
2042 view = self.__findViewWithAttributeInTree(attr, val, root) +2043 if view: +2044 return view +2045 else: +2046 raise ViewNotFoundException(attr, val, root) +
2047 +
2048 - def __findViewWithAttributeInTreeThatMatches(self, attr, regex, root, rlist=[]): +
2049 if not self.root: +2050 print >>sys.stderr, "ERROR: no root, did you forget to call dump()?" +2051 return None +2052 +2053 if type(root) == types.StringType and root == "ROOT": +2054 root = self.root +2055 +2056 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTreeThatMatches: checking if root=%s attr=%s matches %s" % (root.__smallStr__(), attr, regex) +2057 +2058 if root and attr in root.map and regex.match(root.map[attr]): +2059 if DEBUG: print >>sys.stderr, "__findViewWithAttributeInTreeThatMatches: FOUND: %s" % root.__smallStr__() +2060 return root +2061 #print >>sys.stderr, "appending root=%s to rlist=%s" % (root.__smallStr__(), rlist) +2062 #return rlist.append(root) 2063 else: -2064 raise ViewNotFoundException(attr, val, root) -
2065 -
2066 - def findViewWithAttributeThatMatches(self, attr, regex, root="ROOT"): -
2067 ''' -2068 Finds the list of Views with the specified attribute matching -2069 regex -2070 ''' -2071 -2072 return self.__findViewWithAttributeInTreeThatMatches(attr, regex, root) -
2073 -
2074 - def findViewWithText(self, text, root="ROOT"): -
2075 if isinstance(text, org.python.modules.sre.PatternObject): -2076 return self.findViewWithAttributeThatMatches(self.textProperty, text, root) -2077 #l = self.findViewWithAttributeThatMatches(TEXT_PROPERTY, text) -2078 #ll = len(l) -2079 #if ll == 0: -2080 # return None -2081 #elif ll == 1: -2082 # return l[0] -2083 #else: -2084 # print >>sys.stderr, "WARNING: findViewWithAttributeThatMatches invoked by findViewWithText returns %d items." % ll -2085 # return l -2086 else: -2087 return self.findViewWithAttribute(self.textProperty, text, root) -
2088 -
2089 - def findViewWithTextOrRaise(self, text, root="ROOT"): -
2090 ''' -2091 Finds the View or raise a ViewNotFoundException. -2092 -2093 @return: the View found -2094 @raise ViewNotFoundException: raise the exception if View not found -2095 ''' -2096 -2097 view = self.findViewWithText(text, root) -2098 if view: -2099 return view -2100 else: -2101 raise ViewNotFoundException("text", text, root) -
2102 -
2103 - def findViewWithContentDescription(self, contentdescription, root="ROOT"): -
2104 ''' -2105 Finds the View with the specified content description -2106 ''' -2107 -2108 return self.__findViewWithAttributeInTree('content-desc', contentdescription, root) -
2109 -
2110 - def findViewWithContentDescriptionOrRaise(self, contentdescription, root="ROOT"): -
2111 ''' -2112 Finds the View with the specified content description -2113 ''' -2114 -2115 return self.__findViewWithAttributeInTreeOrRaise('content-desc', contentdescription, root) -
2116 -
2117 - def findViewsContainingPoint(self, (x, y), filter=None): -
2118 ''' -2119 Finds the list of Views that contain the point (x, y). -2120 ''' -2121 -2122 if not filter: -2123 filter = lambda v: True -2124 -2125 return [v for v in self.views if (v.containsPoint((x,y)) and filter(v))] -
2126 -
2127 - def getViewIds(self): -
2128 ''' -2129 Returns the Views map. -2130 ''' -2131 -2132 return self.viewsById -
2133 -
2134 - def __getFocusedWindowPosition(self): -
2135 return self.__getFocusedWindowId() -
2136 -
2137 - def getSdkVersion(self): -
2138 ''' -2139 Gets the SDK version. -2140 ''' -2141 -2142 return self.build[VERSION_SDK_PROPERTY] -
2143 -
2144 - def isKeyboardShown(self): -
2145 ''' -2146 Whether the keyboard is displayed. -2147 ''' -2148 -2149 dim = self.device.shell('dumpsys input_method') -2150 if dim: -2151 # FIXME: API >= 15 ? -2152 return "mInputShown=true" in dim -2153 return False -
2154 -
2155 - def writeImageToFile(self, filename, format="PNG"): -
2156 ''' -2157 Write the View image to the specified filename in the specified format. -2158 -2159 @type filename: str -2160 @param filename: Absolute path and optional filename receiving the image. If this points to -2161 a directory, then the filename is determined by the serialno of the device and -2162 format extension. -2163 @type format: str -2164 @param format: Image format (default format is PNG) -2165 ''' -2166 -2167 if not os.path.isabs(filename): -2168 raise ValueError("writeImageToFile expects an absolute path") -2169 if os.path.isdir(filename): -2170 filename = os.path.join(filename, self.serialno + '.' + format.lower()) -2171 if DEBUG: -2172 print >> sys.stderr, "writeImageToFile: saving image to '%s' in %s format" % (filename, format) -2173 self.device.takeSnapshot().writeToFile(filename, format) -
2174 -2175 @staticmethod -
2176 - def excerpt(str, execute=False): -
2177 code = Excerpt2Code().Parse(str) -2178 if execute: -2179 exec code -2180 else: -2181 return code -
2182 -2183 -2184 if __name__ == "__main__": -2185 try: -2186 vc = ViewClient(None) -2187 except: -2188 print "%s: Don't expect this to do anything" % __file__ -2189