pax_global_header 0000666 0000000 0000000 00000000064 14156000053 0014504 g ustar 00root root 0000000 0000000 52 comment=475078b7337b70bdb9e7f8a12d0d2b53ca02bbfd
AndroidViewClient-20.4.4/ 0000775 0000000 0000000 00000000000 14156000053 0015145 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.github/ 0000775 0000000 0000000 00000000000 14156000053 0016505 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.github/workflows/ 0000775 0000000 0000000 00000000000 14156000053 0020542 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.github/workflows/pythonpublish.yml 0000664 0000000 0000000 00000001161 14156000053 0024174 0 ustar 00root root 0000000 0000000 name: Upload Python Package
on:
release:
types: [created]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
run: |
python setup.py clean sdist bdist_wheel
twine upload dist/*
AndroidViewClient-20.4.4/.gitignore 0000664 0000000 0000000 00000000441 14156000053 0017134 0 ustar 00root root 0000000 0000000 # Compiled classes #
####################
*$py.class
*.pyc
# Mac files #
#############
.DS_Store
# vi files #
############
.*.swp
# other files #
###############
*~
build/
dist/
**/*.egg-info/
# idea #
########
*.iws
**/.idea/workspace.xml
**/.idea/tasks.xml
# venv #
########
venv/*
AndroidViewClient-20.4.4/.idea/ 0000775 0000000 0000000 00000000000 14156000053 0016125 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/.name 0000664 0000000 0000000 00000000021 14156000053 0017037 0 ustar 00root root 0000000 0000000 AndroidViewClient AndroidViewClient-20.4.4/.idea/AndroidViewClient.iml 0000664 0000000 0000000 00000000713 14156000053 0022203 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.idea/dictionaries/ 0000775 0000000 0000000 00000000000 14156000053 0020602 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/dictionaries/diego.xml 0000664 0000000 0000000 00000000502 14156000053 0022410 0 ustar 00root root 0000000 0000000 automatorcheckableclickableculebraculebrondalvikfocusablemilanoscreenshot AndroidViewClient-20.4.4/.idea/encodings.xml 0000664 0000000 0000000 00000000334 14156000053 0020620 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.idea/inspectionProfiles/ 0000775 0000000 0000000 00000000000 14156000053 0022004 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/inspectionProfiles/Project_Default.xml 0000664 0000000 0000000 00000002357 14156000053 0025607 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/markdown-navigator.xml 0000664 0000000 0000000 00000007406 14156000053 0022470 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.idea/markdown-navigator/ 0000775 0000000 0000000 00000000000 14156000053 0021737 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/markdown-navigator/profiles_settings.xml 0000664 0000000 0000000 00000000150 14156000053 0026220 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/misc.xml 0000664 0000000 0000000 00000000455 14156000053 0017606 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.idea/modules.xml 0000664 0000000 0000000 00000000436 14156000053 0020322 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.idea/runConfigurations/ 0000775 0000000 0000000 00000000000 14156000053 0021644 5 ustar 00root root 0000000 0000000 Unittests_for_tests_com_dtmilano_android_adb_dumpsystests2_DumpsysTests.xml 0000664 0000000 0000000 00000004275 14156000053 0041144 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__G__A_auto__ZB.xml 0000664 0000000 0000000 00000001744 14156000053 0026577 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__G___null_back_end.xml 0000664 0000000 0000000 00000001610 14156000053 0027544 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__GuU.xml 0000664 0000000 0000000 00000001555 14156000053 0024730 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__GuUh.xml 0000664 0000000 0000000 00000001557 14156000053 0025102 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__Guc___concertina_config_1___scale_0_5.xml 0000664 0000000 0000000 00000002107 14156000053 0033320 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__Guc___concertina_config_2___scale_0_5.xml 0000664 0000000 0000000 00000002106 14156000053 0033320 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__Guhc.xml 0000664 0000000 0000000 00000001722 14156000053 0025112 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra___install_apk_FILENAME_apk__uU.xml 0000664 0000000 0000000 00000001624 14156000053 0031570 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__h.xml 0000664 0000000 0000000 00000001534 14156000053 0024454 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__pGUOu___scale_0_5_015d262e330bf804.xml 0000664 0000000 0000000 00000001673 14156000053 0031462 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__pGUOu___scale_0_5_0936964802203bc7.xml 0000664 0000000 0000000 00000001673 14156000053 0031337 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/culebra__pGUu___scale_0_5___multi_device.xml 0000664 0000000 0000000 00000001720 14156000053 0032241 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump.xml 0000664 0000000 0000000 00000001662 14156000053 0023340 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump__D__A_auto__ZB__f__tmp_f1_png.xml 0000664 0000000 0000000 00000002066 14156000053 0031037 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump___help.xml 0000664 0000000 0000000 00000001533 14156000053 0024643 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump__a.xml 0000664 0000000 0000000 00000001523 14156000053 0023773 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump__a__X_UI_AUTOMATOR_True_RECEIVED_True.xml 0000664 0000000 0000000 00000001631 14156000053 0031715 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump__f___tmp_avc_sc1_png.xml 0000664 0000000 0000000 00000001601 14156000053 0027416 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/runConfigurations/dump__h__a.xml 0000664 0000000 0000000 00000001531 14156000053 0024440 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/scopes/ 0000775 0000000 0000000 00000000000 14156000053 0017421 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/scopes/scope_settings.xml 0000664 0000000 0000000 00000000213 14156000053 0023170 0 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.idea/vcs.xml 0000664 0000000 0000000 00000000264 14156000053 0017444 0 ustar 00root root 0000000 0000000
AndroidViewClient-20.4.4/.project 0000664 0000000 0000000 00000000563 14156000053 0016620 0 ustar 00root root 0000000 0000000
AndroidViewClientorg.python.pydev.PyDevBuilderorg.python.pydev.pythonNature
AndroidViewClient-20.4.4/.pydevproject 0000664 0000000 0000000 00000000726 14156000053 0017671 0 ustar 00root root 0000000 0000000
python 2.7python 2.7/AndroidViewClient/src/AndroidViewClient/examples
AndroidViewClient-20.4.4/.settings/ 0000775 0000000 0000000 00000000000 14156000053 0017063 5 ustar 00root root 0000000 0000000 AndroidViewClient-20.4.4/.settings/org.eclipse.core.resources.prefs 0000664 0000000 0000000 00000000671 14156000053 0025302 0 ustar 00root root 0000000 0000000 eclipse.preferences.version=1
encoding//src/com/dtmilano/android/common.py=utf-8
encoding//src/com/dtmilano/android/controlpanel.py=utf-8
encoding//src/com/dtmilano/android/culebron.py=utf-8
encoding//src/com/dtmilano/android/viewclient.py=utf-8
encoding//src/com/dtmilano/android/window.py=utf-8
encoding//tests/com/dtmilano/android/mocks.py=utf-8
encoding//tests/com/dtmilano/android/viewclienttests.py=utf-8
encoding//tools/culebra=utf-8
AndroidViewClient-20.4.4/.settings/org.eclipse.ltk.core.refactoring.prefs 0000664 0000000 0000000 00000000150 14156000053 0026354 0 ustar 00root root 0000000 0000000 eclipse.preferences.version=1
org.eclipse.ltk.core.refactoring.enable.project.refactoring.history=false
AndroidViewClient-20.4.4/LICENSE 0000664 0000000 0000000 00000026136 14156000053 0016162 0 ustar 00root root 0000000 0000000
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
AndroidViewClient-20.4.4/README.md 0000664 0000000 0000000 00000004536 14156000053 0016434 0 ustar 00root root 0000000 0000000 AndroidViewClient
=================
**AndroidViewClient** was originally conceived as an extension to [monkeyrunner](http://developer.android.com/tools/help/monkeyrunner_concepts.html) but lately evolved
as a pure python tool that automates or simplifies test script creation.
It is a test framework for Android applications that:
Uses 'logical' screen comparison (UI Automator Hierarchy based) over image comparison (Avoiding extraneous
detail issues, such as time or data changes)
Supports running on multiple devices
Provides simple control for high level operations like language change and activity start
Supports all Android APIs
Is written in python (python 3.6+ support in 20.x.y+)
com.dtmilano.android.viewclient.UiCollection:
Used to enumerate a container's user interface (UI) elements for
the purpose of counting, or targeting a sub elements by a child's
text or description.
Copyright (C) 2012-2017 Diego Torres Milano
Created on Dec 1, 2012
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
1''' 2Copyright (C) 2012-2013 Diego Torres Milano 3Created on Dec 1, 2012 4 5Licensed under the Apache License, Version 2.0 (the "License"); 6you may not use this file except in compliance with the License. 7You may obtain a copy of the License at 8 9 http://www.apache.org/licenses/LICENSE-2.0 10 11Unless required by applicable law or agreed to in writing, software 12distributed under the License is distributed on an "AS IS" BASIS, 13WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14See the License for the specific language governing permissions and 15limitations under the License. 16 17@author: Diego Torres Milano 18''' 19 20__version__='5.7.0' 21 22importsys 23importwarnings 24ifsys.executable: 25if'monkeyrunner'insys.executable: 26warnings.warn( 27''' 28 29 You should use a 'python' interpreter, not 'monkeyrunner' for this module 30 31 ''',RuntimeWarning) 32importsocket 33importtime 34importre 35importsignal 36importos 37importtypes 38importplatform 39 40DEBUG=False 41 42HOSTNAME='localhost' 43try: 44PORT=int(os.environ['ANDROID_ADB_SERVER_PORT']) 45exceptKeyError: 46PORT=5037 47 48OKAY='OKAY' 49FAIL='FAIL' 50 51UP=0 52DOWN=1 53DOWN_AND_UP=2 54 55TIMEOUT=15 56 57# some device properties 58VERSION_SDK_PROPERTY='ro.build.version.sdk' 59VERSION_RELEASE_PROPERTY='ro.build.version.release'
104osName=platform.system()105ifosName.startswith('Windows'):# alarm is not implemented in Windows106return107ifDEBUG:108print>>sys.stderr,"setAlarm(%d)"%timeout109signal.alarm(timeout)
122ifDEBUG:123print>>sys.stderr,"__connect()"124self.socket=socket.socket(socket.AF_INET,socket.SOCK_STREAM)125self.socket.settimeout(TIMEOUT)126try:127self.socket.connect((self.hostname,self.port))128exceptsocket.error,ex:129raiseRuntimeError("ERROR: Connecting to %s:%d: %s.\nIs adb running on your computer?"%(self.socket,self.port,ex))
207ifDEBUG:208print>>sys.stderr,"checkVersion(reconnect=%s)"%reconnect209self.__send('host:version',reconnect=False)210version=self.socket.recv(8)211VERSION='0004001f'212ifversion!=VERSION:213raiseRuntimeError("ERROR: Incorrect ADB server version %s (expecting %s)"%(version,VERSION))214ifreconnect:215self.__connect()
218ifDEBUG:219print>>sys.stderr,"__setTransport()"220ifnotself.serialno:221raiseValueError("serialno not set, empty or None")222self.checkConnected()223serialnoRE=re.compile(self.serialno)224found=False225fordeviceinself.getDevices():226ifserialnoRE.match(device.serialno):227found=True228break229ifnotfound:230raiseRuntimeError("ERROR: couldn't find device that matches '%s'"%self.serialno)231self.serialno=device.serialno232msg='host:transport:%s'%self.serialno233ifDEBUG:234print>>sys.stderr," __setTransport: msg=",msg235self.__send(msg,reconnect=False)236self.isTransportSet=True
284''' Gets C{mRestrictedScreen} values from dumpsys. This is a method to obtain display dimensions '''285286rsRE=re.compile('\s*mRestrictedScreen=\((?P<x>\d+),(?P<y>\d+)\) (?P<w>\d+)x(?P<h>\d+)')287forlineinself.shell('dumpsys window').splitlines():288m=rsRE.match(line)289ifm:290returnm.groups()291raiseRuntimeError("Couldn't find mRestrictedScreen in dumpsys")
311''' Gets the property value for key '''312313importcollections314MAP_KEYS=collections.OrderedDict([315(re.compile('display.width'),self.__getDisplayWidth),316(re.compile('display.height'),self.__getDisplayHeight),317(re.compile('.*'),self.__getProp),318])319'''Maps properties key values (as regexps) to instance methods to obtain its values.'''320321forkreinMAP_KEYS.keys():322ifkre.match(key):323returnMAP_KEYS[kre](key=key,strip=strip)324raiseValueError("key='%s' does not match any map entry")
340# WORKAROUND:341# Using 'input keyevent --longpress POWER' does not work correctly in342# KitKat (API 19), it sends a short instead of a long press.343# This uses the events instead, but it may vary from device to device.344# The events sent are device dependent and may not work on other devices.345# If this does not work on your device please do:346# $ adb shell getevent -l347# and post the output to https://github.com/dtmilano/AndroidViewClient/issues348# specifying the device and API level.349ifname=='POWER'orname=='KEY_POWER':350self.shell('sendevent /dev/input/event0 1 116 1')351self.shell('sendevent /dev/input/event0 0 0 0')352time.sleep(0.5)353self.shell('sendevent /dev/input/event0 1 116 0')354self.shell('sendevent /dev/input/event0 0 0 0')355return356357version=self.getSdkVersion()358ifversion>=19:359cmd='input keyevent --longpress %s'%name360ifDEBUG:361print>>sys.stderr,"longPress(%s)"%cmd362self.shell(cmd)363else:364raiseRuntimeError("longpress: not supported for API < 19 (version=%d)"%version)
381'''382 Takes a snapshot of the device and return it as a PIL Image.383 '''384385try:386fromPILimportImage387except:388raiseException("You have to install PIL to use takeSnapshot()")389self.__send('framebuffer:',checkok=True,reconnect=False)390importstruct391# case 1: // version392# return 12; // bpp, size, width, height, 4*(length, offset)393received=self.__receive(1*4+12*4)394(version,bpp,size,width,height,roffset,rlen,boffset,blen,goffset,glen,aoffset,alen)=struct.unpack('<'+'L'*13,received)395ifDEBUG:396print>>sys.stderr," takeSnapshot:",(version,bpp,size,width,height,roffset,rlen,boffset,blen,goffset,glen,aoffset,alen)397offsets={roffset:'R',goffset:'G',boffset:'B'}398ifbpp==32:399ifalen!=0:400offsets[aoffset]='A'401else:402warnings.warn('''framebuffer is specified as 32bpp but alpha length is 0''')403argMode=''.join([offsets[o]foroinsorted(offsets)])404ifDEBUG:405print>>sys.stderr," takeSnapshot:",(version,bpp,size,width,height,roffset,rlen,boffset,blen,goffset,blen,aoffset,alen,argMode)406ifargMode=='BGRA':407argMode='RGBA'408ifbpp==16:409mode='RGB'410argMode+=';16'411else:412mode=argMode413self.__send('\0',checkok=False,reconnect=False)414ifDEBUG:415print>>sys.stderr," takeSnapshot: reading %d bytes"%(size)416received=self.__receive(size)417ifreconnect:418self.__connect()419self.__setTransport()420ifDEBUG:421print>>sys.stderr," takeSnapshot: Image.frombuffer(%s, %s, %s, %s, %s, %s, %s)"%(mode,(width,height),'data','raw',argMode,0,1)422returnImage.frombuffer(mode,(width,height),received,'raw',argMode,0,1)
453'''454 Checks if the device screen is locked.455456 @return True if the device screen is locked457 '''458459lockScreenRE=re.compile('mShowingLockscreen=(true|false)')460m=lockScreenRE.search(self.shell('dumpsys window policy'))461ifm:462return(m.group(1)=='true')463raiseRuntimeError("Couldn't determine screen lock state")
466'''467 Checks if the screen is ON.468469 @return True if the device screen is ON470 '''471472screenOnRE=re.compile('mScreenOnFully=(true|false)')473m=screenOnRE.search(self.shell('dumpsys window policy'))474ifm:475return(m.group(1)=='true')476raiseRuntimeError("Couldn't determine screen ON state")
488'''489 Returns the percent of pixels that are equal490491 @author: catshoes492 '''493494# If the images differ in size, return 0% same.495size_x1,size_y1=image1.size496size_x2,size_y2=image2.size497if(size_x1!=size_x2or498size_y1!=size_y2):499return0500501# Images are the same size502# Return the percent of pixels that are equal.503numPixelsSame=0504numPixelsTotal=size_x1*size_y1505image1Pixels=image1.load()506image2Pixels=image2.load()507508# Loop over all pixels, comparing pixel in image1 to image2509forxinrange(size_x1):510foryinrange(size_y1):511if(image1Pixels[x,y]==image2Pixels[x,y]):512numPixelsSame+=1513514returnnumPixelsSame/float(numPixelsTotal)
525526527if__name__=='__main__':528adbClient=AdbClient(os.environ['ANDROID_SERIAL'])529INTERACTIVE=False530ifINTERACTIVE:531sout=adbClient.shell()532prompt=re.compile(".+@android:(.*) [$#] \r\r\n")533whileTrue:534try:535cmd=raw_input('adb $ ')536exceptEOFError:537break538ifcmd=='exit':539break540adbClient.socket.__send(cmd+"\r\n")541sout.readline(4096)# eat first line, which is the command542whileTrue:543line=sout.readline(4096)544ifprompt.match(line):545break546printline,547ifnotline:548break549550print"\nBye"551else:552print'date:',adbClient.shell('date')553
Copyright (C) 2012-2017 Diego Torres Milano
Created on Dec 1, 2012
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
Copyright (C) 2012-2017 Diego Torres Milano
Created on Jan 5, 2015
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
Copyright (C) 2012-2017 Diego Torres Milano
Created on Jul 6, 2015
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
['Chicken Wings grow on trees','Carrot sticks help the mind think','Farts cause neurological damage','Jennifer Lopez is a Man (only on Tuesday)','That... Is what she said','Make me a sandwich','King Kongs brother was a Rabbit... Hmmm','Tuesday, thats when it will all begin',...
Copyright (C) 2012-2017 Diego Torres Milano Created on oct 30,
2014
Licensed under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing permissions
and limitations under the License.
Copyright (C) 2012-2017 Diego Torres Milano
Created on oct 6, 2014
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
printOperation (method) - the method invoked to print operations to the script
scale (float @:param concertina: bool @:type concertina: enable
concertina mode (see documentation)) - the scale of the device screen used to show it on the window
Touches a point in the device screen.
The generated operation will use the units specified in L{coordinatesUnit} and the
orientation in L{vc.display['orientation']}.
Long-touches a point in the device screen.
The generated operation will use the units specified in L{coordinatesUnit} and the
orientation in L{vc.display['orientation']}.
Toggles the touch point operation using the units specified in coordinatesUnit.
When there are Views (obtained from the back-end) we have to determine
if the intention when something is touched on the window if we want to
touch the View or the point.
If there's no back-end, we don't allow self.isTouchingPoint to be disabled so we will never be
attempting to touch Views.
Listens for touch events and draws the corresponding shapes on the
Culebron canvas. If the starting point is being grabbed it draws the
touching point via Culebron.drawTouchedPoint() and if the
end point is being grabbed it draws using
Culebron.drawDragLine().
Creates a new item and return the item identifier of the newly created
item.
parent is the item ID of the parent item, or the empty string to
create a new top-level item. index is an integer, or the value end,
specifying where in the list of parent's children to insert the new item.
If index is less than or equal to zero, the new node is inserted at the
beginning, if index is greater than or equal to the current number of
children, it is inserted at the end. If iid is specified, it is used as
the item identifier, iid must not already exist in the tree. Otherwise, a
new unique identifier is generated.
With one argument, returns a dictionary of column/value pairs for the
specified item. With two arguments, returns the current value of the
specified column. With three arguments, sets the value of given column in
given item to the specified value.
Copyright (C) 2012-2017 Diego Torres Milano
Created on mar 11, 2017
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
Copyright (C) 2012-2017 Diego Torres Milano
Created on Nov 10, 2015
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
Copyright (C) 2012-2017 Diego Torres Milano
Created on Feb 2, 2015
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
__init__(self,
group=None,
target=None,
name=None,
args=(),
kwargs=None,
verbose=None,
adbClient=None,
testClass=None,
testRunner=None)
This constructor should always be called with keyword arguments.
This constructor should always be called with keyword arguments.
Arguments are:
*group* should be None; reserved for future extension when a
ThreadGroup class is implemented.
*target* is the callable object to be invoked by the run() method.
Defaults to None, meaning nothing is called.
*name* is the thread name. By default, a unique name is constructed of
the form "Thread-N" where N is a small decimal number.
*args* is the argument tuple for the target invocation. Defaults to
().
*kwargs* is a dictionary of keyword arguments for the target
invocation. Defaults to {}.
If a subclass overrides the constructor, it must make sure to invoke
the base class constructor (Thread.__init__()) before doing anything else
to the thread.
You may override this method in a subclass. The standard run() method
invokes the callable object passed to the object's constructor as the
target argument, if any, with sequential and keyword arguments taken from
the args and kwargs arguments, respectively.
Copyright (C) 2012-2017 Diego Torres Milano
Created on Feb 2, 2012
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
UiDevice
Provides access to state information about the device.
UiCollection
Used to enumerate a container's user interface (UI) elements for
the purpose of counting, or targeting a sub elements by a child's
text or description.
SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED = False
Skips some classes related with the Action Bar and the
PhoneWindow$DecorView in the coordinates calculation
1# -*- coding: utf-8 -*- 2''' 3Copyright (C) 2012-2014 Diego Torres Milano 4Created on Feb 2, 2012 5 6Licensed under the Apache License, Version 2.0 (the "License"); 7you may not use this file except in compliance with the License. 8You may obtain a copy of the License at 9 10 http://www.apache.org/licenses/LICENSE-2.0 11 12Unless required by applicable law or agreed to in writing, software 13distributed under the License is distributed on an "AS IS" BASIS, 14WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15See the License for the specific language governing permissions and 16limitations under the License. 17 18@author: Diego Torres Milano 19''' 20 21__version__='5.6.3' 22 23importsys 24importwarnings 25ifsys.executable: 26if'monkeyrunner'insys.executable: 27warnings.warn( 28''' 29 30 You should use a 'python' interpreter, not 'monkeyrunner' for this module 31 32 ''',RuntimeWarning) 33importsubprocess 34importre 35importsocket 36importos 37importtypes 38importtime 39importsignal 40importcopy 41importpickle 42importplatform 43importxml.parsers.expat 44fromcom.dtmilano.android.adbimportadbclient 45 46DEBUG=False 47DEBUG_DEVICE=DEBUGandFalse 48DEBUG_RECEIVED=DEBUGandFalse 49DEBUG_TREE=DEBUGandFalse 50DEBUG_GETATTR=DEBUGandFalse 51DEBUG_CALL=DEBUGandFalse 52DEBUG_COORDS=DEBUGandFalse 53DEBUG_TOUCH=DEBUGandFalse 54DEBUG_STATUSBAR=DEBUGandFalse 55DEBUG_WINDOWS=DEBUGandFalse 56DEBUG_BOUNDS=DEBUGandFalse 57DEBUG_DISTANCE=DEBUGandFalse 58 59WARNINGS=False 60 61VIEW_SERVER_HOST='localhost' 62VIEW_SERVER_PORT=4939 63 64ADB_DEFAULT_PORT=5555 65 66OFFSET=25 67''' This assumes the smallest touchable view on the screen is approximately 50px x 50px 68 and touches it at M{(x+OFFSET, y+OFFSET)} ''' 69 70USE_ADB_CLIENT_TO_GET_BUILD_PROPERTIES=True 71''' Use C{AdbClient} to obtain the needed properties. If this is 72 C{False} then C{adb shell getprop} is used ''' 73 74SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED=False 75''' Skips some classes related with the Action Bar and the PhoneWindow$DecorView in the 76 coordinates calculation 77 @see: L{View.getXY()} ''' 78 79VIEW_CLIENT_TOUCH_WORKAROUND_ENABLED=False 80''' Under some conditions the touch event should be longer [t(DOWN) << t(UP)]. C{True} enables a 81 workaround to delay the events.''' 82 83# some device properties 84VERSION_SDK_PROPERTY='ro.build.version.sdk' 85VERSION_RELEASE_PROPERTY='ro.build.version.release' 86 87# some constants for the attributes 88ID_PROPERTY='mID' 89ID_PROPERTY_UI_AUTOMATOR='uniqueId' 90TEXT_PROPERTY='text:mText' 91TEXT_PROPERTY_API_10='mText' 92TEXT_PROPERTY_UI_AUTOMATOR='text' 93WS="\xfe"# the whitespace replacement char for TEXT_PROPERTY 94LEFT_PROPERTY='layout:mLeft' 95LEFT_PROPERTY_API_8='mLeft' 96TOP_PROPERTY='layout:mTop' 97TOP_PROPERTY_API_8='mTop' 98WIDTH_PROPERTY='layout:getWidth()' 99WIDTH_PROPERTY_API_8='getWidth()' 100HEIGHT_PROPERTY='layout:getHeight()' 101HEIGHT_PROPERTY_API_8='getHeight()' 102GET_VISIBILITY_PROPERTY='getVisibility()' 103LAYOUT_TOP_MARGIN_PROPERTY='layout:layout_topMargin' 104 105# visibility 106VISIBLE=0x0 107INVISIBLE=0x4 108GONE=0x8 109 110RegexType=type(re.compile('')) 111IP_RE=re.compile('^(\d{1,3}\.){3}\d{1,3}$') 112ID_RE=re.compile('id/([^/]*)(/(\d+))?')
127''' 128 NOTICE: this is using a non-greedy (or minimal) regex 129 130 @type name: str 131 @param name: the name used to tag the expression 132 @type greedy: bool 133 @param greedy: Whether the regex is greedy or not 134 135 @return: Returns a named string regex (only non-whitespace characters allowed) 136 ''' 137return'(?P<%s>\S+%s)'%(name,''ifgreedyelse'?')
195ifisinstance(value,RegexType): 196msg="Couldn't find View with %s that matches '%s' in tree with root=%s"%(attr,value.pattern,root) 197else: 198msg="Couldn't find View with %s='%s' in tree with root=%s"%(attr,value,root) 199super(Exception,self).__init__(msg)
255''' 256 Constructor 257 258 @type map: map 259 @param map: the map containing the (attribute, value) pairs 260 @type device: MonkeyDevice 261 @param device: the device containing this View 262 @type version: int 263 @param version: the Android SDK version number of the platform where this View belongs. If 264 this is C{-1} then the Android SDK version will be obtained in this 265 constructor. 266 @type forceviewserveruse: boolean 267 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions were given 268 to use C{UiAutomator}. 269 ''' 270 271self.map=map 272''' The map that contains the C{attr},C{value} pairs ''' 273self.device=device 274''' The MonkeyDevice ''' 275self.children=[] 276''' The children of this View ''' 277self.parent=None 278''' The parent of this View ''' 279self.windows={} 280self.currentFocus=None 281''' The current focus ''' 282self.build={} 283''' Build properties ''' 284self.version=version 285''' API version number ''' 286self.forceviewserveruse=forceviewserveruse 287''' Force ViewServer use ''' 288 289ifversion!=-1: 290self.build[VERSION_SDK_PROPERTY]=version 291else: 292try: 293ifUSE_ADB_CLIENT_TO_GET_BUILD_PROPERTIES: 294self.build[VERSION_SDK_PROPERTY]=int(device.getProperty(VERSION_SDK_PROPERTY)) 295else: 296self.build[VERSION_SDK_PROPERTY]=int(device.shell('getprop '+VERSION_SDK_PROPERTY)[:-2]) 297except: 298self.build[VERSION_SDK_PROPERTY]=-1 299 300version=self.build[VERSION_SDK_PROPERTY] 301self.useUiAutomator=(version>=16)andnotforceviewserveruse 302''' Whether to use UIAutomator or ViewServer ''' 303self.idProperty=None 304''' The id property depending on the View attribute format ''' 305self.textProperty=None 306''' The text property depending on the View attribute format ''' 307self.leftProperty=None 308''' The left property depending on the View attribute format ''' 309self.topProperty=None 310''' The top property depending on the View attribute format ''' 311self.widthProperty=None 312''' The width property depending on the View attribute format ''' 313self.heightProperty=None 314''' The height property depending on the View attribute format ''' 315ifversion>=16andself.useUiAutomator: 316self.idProperty=ID_PROPERTY_UI_AUTOMATOR 317self.textProperty=TEXT_PROPERTY_UI_AUTOMATOR 318self.leftProperty=LEFT_PROPERTY 319self.topProperty=TOP_PROPERTY 320self.widthProperty=WIDTH_PROPERTY 321self.heightProperty=HEIGHT_PROPERTY 322elifversion>10and(version<16orself.useUiAutomator): 323self.idProperty=ID_PROPERTY 324self.textProperty=TEXT_PROPERTY 325self.leftProperty=LEFT_PROPERTY 326self.topProperty=TOP_PROPERTY 327self.widthProperty=WIDTH_PROPERTY 328self.heightProperty=HEIGHT_PROPERTY 329elifversion==10: 330self.idProperty=ID_PROPERTY 331self.textProperty=TEXT_PROPERTY_API_10 332self.leftProperty=LEFT_PROPERTY 333self.topProperty=TOP_PROPERTY 334self.widthProperty=WIDTH_PROPERTY 335self.heightProperty=HEIGHT_PROPERTY 336elifversion>=7andversion<10: 337self.idProperty=ID_PROPERTY 338self.textProperty=TEXT_PROPERTY_API_10 339self.leftProperty=LEFT_PROPERTY_API_8 340self.topProperty=TOP_PROPERTY_API_8 341self.widthProperty=WIDTH_PROPERTY_API_8 342self.heightProperty=HEIGHT_PROPERTY_API_8 343elifversion>0andversion<7: 344self.idProperty=ID_PROPERTY 345self.textProperty=TEXT_PROPERTY_API_10 346self.leftProperty=LEFT_PROPERTY 347self.topProperty=TOP_PROPERTY 348self.widthProperty=WIDTH_PROPERTY 349self.heightProperty=HEIGHT_PROPERTY 350elifversion==-1: 351self.idProperty=ID_PROPERTY 352self.textProperty=TEXT_PROPERTY 353self.leftProperty=LEFT_PROPERTY 354self.topProperty=TOP_PROPERTY 355self.widthProperty=WIDTH_PROPERTY 356self.heightProperty=HEIGHT_PROPERTY 357else: 358self.idProperty=ID_PROPERTY 359self.textProperty=TEXT_PROPERTY 360self.leftProperty=LEFT_PROPERTY 361self.topProperty=TOP_PROPERTY 362self.widthProperty=WIDTH_PROPERTY 363self.heightProperty=HEIGHT_PROPERTY
369ifDEBUG_GETATTR: 370print>>sys.stderr,"__getattr__(%s) version: %d"%(name,self.build[VERSION_SDK_PROPERTY]) 371 372# NOTE: 373# I should try to see if 'name' is a defined method 374# but it seems that if I call locals() here an infinite loop is entered 375 376ifself.map.has_key(name): 377r=self.map[name] 378elifself.map.has_key(name+'()'): 379# the method names are stored in the map with their trailing '()' 380r=self.map[name+'()'] 381elifname.count("_")>0: 382mangledList=self.allPossibleNamesWithColon(name) 383mangledName=self.intersection(mangledList,self.map.keys()) 384iflen(mangledName)>0andself.map.has_key(mangledName[0]): 385r=self.map[mangledName[0]] 386else: 387# Default behavior 388raiseAttributeError,name 389else: 390# try removing 'is' prefix 391ifDEBUG_GETATTR: 392print>>sys.stderr," __getattr__: trying without 'is' prefix" 393suffix=name[2:].lower() 394ifself.map.has_key(suffix): 395r=self.map[suffix] 396else: 397# Default behavior 398raiseAttributeError,name 399 400# if the method name starts with 'is' let's assume its return value is boolean 401# if name[:2] == 'is': 402# r = True if r == 'true' else False 403ifr=='true': 404r=True 405elifr=='false': 406r=False 407 408# this should not cached in some way 409definnerMethod(): 410ifDEBUG_GETATTR: 411print>>sys.stderr,"innerMethod: %s returning %s"%(innerMethod.__name__,r) 412returnr
413 414innerMethod.__name__=name 415 416# this should work, but then there's problems with the arguments of innerMethod 417# even if innerMethod(self) is added 418#setattr(View, innerMethod.__name__, innerMethod) 419#setattr(self, innerMethod.__name__, innerMethod) 420 421returninnerMethod
428''' 429 Gets the L{View} class 430 431 @return: the L{View} class or C{None} if not defined 432 ''' 433 434try: 435returnself.map['class'] 436except: 437returnNone
440''' 441 Gets the L{View} Id 442 443 @return: the L{View} C{Id} or C{None} if not defined 444 @see: L{getUniqueId()} 445 ''' 446 447try: 448returnself.map['resource-id'] 449except: 450pass 451 452try: 453returnself.map[self.idProperty] 454except: 455returnNone
475''' 476 Gets the text attribute. 477 478 @return: the text attribute or C{None} if not defined 479 ''' 480 481try: 482returnself.map[self.textProperty] 483exceptException: 484returnNone
513''' 514 Gets the unique Id of this View. 515 516 @see: L{ViewClient.__splitAttrs()} for a discussion on B{Unique Ids} 517 ''' 518 519try: 520returnself.map['uniqueId'] 521except: 522returnNone
684''' 685 Gets the position and size (X,Y, W, H) 686 687 @return: A tuple containing the View's coordinates (X, Y, W, H) 688 ''' 689 690(x,y)=self.getXY(); 691w=self.getWidth() 692h=self.getHeight() 693return(x,y,w,h)
900''' 901 Write the View image to the specified filename in the specified format. 902 903 @type filename: str 904 @param filename: Absolute path and optional filename receiving the image. If this points to 905 a directory, then the filename is determined by this View unique ID and 906 format extension. 907 @type format: str 908 @param format: Image format (default format is PNG) 909 ''' 910 911ifnotos.path.isabs(filename): 912raiseValueError("writeImageToFile expects an absolute path") 913ifos.path.isdir(filename): 914filename=os.path.join(filename,self.variableNameFromId()+'.'+format.lower()) 915ifDEBUG: 916print>>sys.stderr,"writeImageToFile: saving image to '%s' in %s format"%(filename,format) 917#self.device.takeSnapshot().getSubImage(self.getPositionAndSize()).writeToFile(filename, format) 918# crop: 919# im.crop(box) ⇒ image 920# Returns a copy of a rectangular region from the current image. 921# The box is a 4-tuple defining the left, upper, right, and lower pixel coordinate. 922((l,t),(r,b))=self.getCoords() 923box=(l,t,r,b) 924ifDEBUG: 925print>>sys.stderr,"writeImageToFile: cropping",box," reconnect=",self.device.reconnect 926self.device.takeSnapshot(reconnect=self.device.reconnect).crop(box).save(filename,format)
1026'''1027 Expat start element event handler1028 '''1029ifname=='hierarchy':1030pass1031elifname=='node':1032# Instantiate an Element object1033attributes['uniqueId']='id/no_id/%d'%self.idCount1034bounds=re.split('[\][,]',attributes['bounds'])1035attributes['bounds']=((int(bounds[1]),int(bounds[2])),(int(bounds[4]),int(bounds[5])))1036ifDEBUG_BOUNDS:1037print>>sys.stderr,"bounds=",attributes['bounds']1038self.idCount+=11039child=View.factory(attributes,self.device,self.version)1040self.views.append(child)1041# Push element onto the stack and make it a child of parent1042ifnotself.nodeStack:1043self.root=child1044else:1045self.parent=self.nodeStack[-1]1046self.parent.add(child)1047self.nodeStack.append(child)
1060'''1061 Expat character data event handler1062 '''10631064ifdata.strip():1065data=data.encode()1066element=self.nodeStack[-1]1067element.cdata+=data
1070# Create an Expat parser1071parser=xml.parsers.expat.ParserCreate()1072# Set the Expat event handlers to our methods1073parser.StartElementHandler=self.StartElement1074parser.EndElementHandler=self.EndElement1075parser.CharacterDataHandler=self.CharacterData1076# Parse the XML File1077try:1078parserStatus=parser.Parse(uiautomatorxml.encode(encoding='utf-8',errors='replace'),True)1079exceptxml.parsers.expat.ExpatError,ex:1080print>>sys.stderr,"ERROR: Offending XML:\n",repr(uiautomatorxml)1081raiseRuntimeError(ex)1082returnself.root
1108'''1109 Expat character data event handler1110 '''11111112ifdata.strip():1113data=data.encode()1114ifnotself.data:1115self.data=data1116else:1117self.data+=data
1120# Create an Expat parser1121parser=xml.parsers.expat.ParserCreate()1122# Set the Expat event handlers to our methods1123parser.StartElementHandler=self.StartElement1124parser.EndElementHandler=self.EndElement1125parser.CharacterDataHandler=self.CharacterData1126# Parse the XML1127parserStatus=parser.Parse(excerpt,1)1128returnself.data
1131'''1132 ViewClient is a I{ViewServer} client.11331134 ViewServer backend1135 ==================1136 If not running the ViewServer is started on the target device or emulator and then the port1137 mapping is created.11381139 UiAutomator backend1140 ===================1141 No service is started.1142 '''1143
1145'''1146 Constructor11471148 @type device: MonkeyDevice1149 @param device: The device running the C{View server} to which this client will connect1150 @type serialno: str1151 @param serialno: the serial number of the device or emulator to connect to1152 @type adb: str1153 @param adb: the path of the C{adb} executable or None and C{ViewClient} will try to find it1154 @type autodump: boolean1155 @param autodump: whether an automatic dump is performed at the end of this constructor1156 @type forceviewserveruse: boolean1157 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions to use1158 C{UiAutomator} are satisfied1159 @type localport: int1160 @param localport: the local port used in the redirection1161 @type remoteport: int1162 @param remoteport: the remote port used to start the C{ViewServer} in the device or1163 emulator1164 @type startviewserver: boolean1165 @param startviewserver: Whether to start the B{global} ViewServer1166 @type ignoreuiautomatorkilled: boolean1167 @param ignoreuiautomatorkilled: Ignores received B{Killed} message from C{uiautomator}1168 '''11691170ifnotdevice:1171raiseException('Device is not connected')1172self.device=device1173''' The C{MonkeyDevice} device instance '''11741175ifnotserialno:1176raiseValueError("Serialno cannot be None")1177self.serialno=self.__mapSerialNo(serialno)1178''' The serial number of the device '''11791180ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: using device with serialno",self.serialno11811182ifadb:1183ifnotos.access(adb,os.X_OK):1184raiseException('adb="%s" is not executable'%adb)1185else:1186# Using adbclient we don't need adb executable yet (maybe it's needed if we want to1187# start adb if not running)1188adb=ViewClient.__obtainAdbPath()11891190self.adb=adb1191''' The adb command '''1192self.root=None1193''' The root node '''1194self.viewsById={}1195''' The map containing all the L{View}s indexed by their L{View.getUniqueId()} '''1196self.display={}1197''' The map containing the device's display properties: width, height and density '''1198forpropin['width','height','density']:1199self.display[prop]=-11200ifUSE_ADB_CLIENT_TO_GET_BUILD_PROPERTIES:1201try:1202self.display[prop]=int(device.getProperty('display.'+prop))1203except:1204ifWARNINGS:1205warnings.warn("Couldn't determine display %s"%prop)1206else:1207# these values are usually not defined as properties, so we stick to the -1 set1208# before1209pass12101211self.build={}1212''' The map containing the device's build properties: version.sdk, version.release '''12131214forpropin[VERSION_SDK_PROPERTY,VERSION_RELEASE_PROPERTY]:1215self.build[prop]=-11216try:1217ifUSE_ADB_CLIENT_TO_GET_BUILD_PROPERTIES:1218self.build[prop]=device.getProperty(prop)1219else:1220self.build[prop]=device.shell('getprop ro.build.'+prop)[:-2]1221except:1222ifWARNINGS:1223warnings.warn("Couldn't determine build %s"%prop)12241225ifprop==VERSION_SDK_PROPERTY:1226# we expect it to be an int1227self.build[prop]=int(self.build[prop]ifself.build[prop]else-1)12281229self.ro={}1230''' The map containing the device's ro properties: secure, debuggable '''1231forpropin['secure','debuggable']:1232try:1233self.ro[prop]=device.shell('getprop ro.'+prop)[:-2]1234except:1235ifWARNINGS:1236warnings.warn("Couldn't determine ro %s"%prop)1237self.ro[prop]='UNKNOWN'12381239self.forceViewServerUse=forceviewserveruse1240''' Force the use of ViewServer even if the conditions to use UiAutomator are satisfied '''1241self.useUiAutomator=(self.build[VERSION_SDK_PROPERTY]>=16)andnotforceviewserveruse# jelly bean 4.1 & 4.21242ifDEBUG:1243print>>sys.stderr," ViewClient.__init__: useUiAutomator=",self.useUiAutomator,"sdk=",self.build[VERSION_SDK_PROPERTY],"forceviewserveruse=",forceviewserveruse1244''' If UIAutomator is supported by the device it will be used '''1245self.ignoreUiAutomatorKilled=ignoreuiautomatorkilled1246''' On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed just after generating1247 the dump file. In many cases the file is already complete so we can ask to ignore the 'Killed'1248 message by setting L{ignoreuiautomatorkilled} to C{True}.12491250 Changes in v2.3.21 that uses C{/dev/tty} instead of a file may have turned this variable1251 unnecessary, however it has been kept for backward compatibility.1252 '''12531254ifself.useUiAutomator:1255self.textProperty=TEXT_PROPERTY_UI_AUTOMATOR1256else:1257ifself.build[VERSION_SDK_PROPERTY]<=10:1258self.textProperty=TEXT_PROPERTY_API_101259else:1260self.textProperty=TEXT_PROPERTY1261ifstartviewserver:1262ifnotself.serviceResponse(device.shell('service call window 3')):1263try:1264self.assertServiceResponse(device.shell('service call window 1 i32 %d'%1265remoteport))1266except:1267msg='Cannot start View server.\n' \ 1268'This only works on emulator and devices running developer versions.\n' \ 1269'Does hierarchyviewer work on your device?\n' \ 1270'See https://github.com/dtmilano/AndroidViewClient/wiki/Secure-mode\n\n' \ 1271'Device properties:\n' \ 1272' ro.secure=%s\n' \ 1273' ro.debuggable=%s\n'%(self.ro['secure'],self.ro['debuggable'])1274raiseException(msg)12751276self.localPort=localport1277self.remotePort=remoteport1278# FIXME: it seems there's no way of obtaining the serialno from the MonkeyDevice1279subprocess.check_call([self.adb,'-s',self.serialno,'forward','tcp:%d'%self.localPort,1280'tcp:%d'%self.remotePort])12811282self.windows=None1283''' The list of windows as obtained by L{ViewClient.list()} '''12841285ifautodump:1286self.dump()
1294'''1295 Obtains the ADB path attempting know locations for different OSs1296 '''12971298osName=platform.system()1299isWindows=False1300ifosName.startswith('Windows'):1301adb='adb.exe'1302isWindows=True1303else:1304adb='adb'13051306ANDROID_HOME=os.environ['ANDROID_HOME']ifos.environ.has_key('ANDROID_HOME')else'/opt/android-sdk'1307HOME=os.environ['HOME']ifos.environ.has_key('HOME')else''13081309possibleChoices=[os.path.join(ANDROID_HOME,'platform-tools',adb),1310os.path.join(HOME,"android",'platform-tools',adb),1311os.path.join(HOME,"android-sdk",'platform-tools',adb),1312adb,1313]13141315ifosName.startswith('Windows'):1316possibleChoices.append(os.path.join("""C:\Program Files\Android\android-sdk\platform-tools""",adb))1317possibleChoices.append(os.path.join("""C:\Program Files (x86)\Android\android-sdk\platform-tools""",adb))1318elifosName.startswith('Linux'):1319possibleChoices.append(os.path.join("opt","android-sdk-linux",'platform-tools',adb))1320possibleChoices.append(os.path.join(HOME,"opt","android-sdk-linux",'platform-tools',adb))1321possibleChoices.append(os.path.join(HOME,"android-sdk-linux",'platform-tools',adb))1322elifosName.startswith('Mac'):1323possibleChoices.append(os.path.join("opt","android-sdk-mac_x86",'platform-tools',adb))1324possibleChoices.append(os.path.join(HOME,"opt","android-sdk-mac",'platform-tools',adb))1325possibleChoices.append(os.path.join(HOME,"android-sdk-mac",'platform-tools',adb))1326possibleChoices.append(os.path.join(HOME,"opt","android-sdk-mac_x86",'platform-tools',adb))1327possibleChoices.append(os.path.join(HOME,"android-sdk-mac_x86",'platform-tools',adb))1328else:1329# Unsupported OS1330pass13311332forexeFileinpossibleChoices:1333ifos.access(exeFile,os.X_OK):1334returnexeFile13351336forpathinos.environ["PATH"].split(os.pathsep):1337exeFile=os.path.join(path,adb)1338ifexeFile!=Noneandos.access(exeFile,os.X_OKifnotisWindowselseos.F_OK):1339returnexeFile13401341raiseException('adb="%s" is not executable. Did you forget to set ANDROID_HOME in the environment?'%adb)
1345serialno=serialno.strip()1346#ipRE = re.compile('^\d+\.\d+.\d+.\d+$')1347ifIP_RE.match(serialno):1348ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: adding default port to serialno",serialno,ADB_DEFAULT_PORT1349returnserialno+':%d'%ADB_DEFAULT_PORT13501351ipPortRE=re.compile('^\d+\.\d+.\d+.\d+:\d+$')1352ifipPortRE.match(serialno):1353# nothing to map1354returnserialno13551356ifre.search("[.*()+]",serialno):1357raiseValueError("Regular expression not supported as serialno in ViewClient")13581359returnserialno
1363ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: obtaining serial number for connected device"1364serialno=device.getProperty('ro.serialno')1365ifnotserialno:1366serialno=device.shell('getprop ro.serialno')1367ifserialno:1368serialno=serialno[:-2]1369ifnotserialno:1370qemu=device.shell('getprop ro.kernel.qemu')1371ifqemu:1372qemu=qemu[:-2]1373ifqemuandint(qemu)==1:1374# FIXME !!!!!1375# this must be calculated from somewhere, though using a fixed serialno for now1376warnings.warn("Running on emulator but no serial number was specified then 'emulator-5554' is used")1377serialno='emulator-5554'1378ifnotserialno:1379# If there's only one device connected get its serialno1380adb=ViewClient.__obtainAdbPath()1381ifDEBUG_DEVICE:print>>sys.stderr," using adb=%s"%adb1382s=subprocess.Popen([adb,'get-serialno'],stdout=subprocess.PIPE,stderr=subprocess.PIPE,env={}).communicate()[0][:-1]1383ifs!='unknown':1384serialno=s1385ifDEBUG_DEVICE:print>>sys.stderr," serialno=%s"%serialno1386ifnotserialno:1387warnings.warn("Couldn't obtain the serialno of the connected device")1388returnserialno
1399'''1400 Connects to a device which serial number is obtained from the script arguments if available1401 or using the default regex C{.*}.14021403 If the connection is not successful the script exits.1404 L{MonkeyRunner.waitForConnection()} returns a L{MonkeyDevice} even if the connection failed.1405 Then, to detect this situation, C{device.wake()} is attempted and if it fails then it is1406 assumed the previous connection failed.14071408 @type timeout: int1409 @param timeout: timeout for the connection1410 @type verbose: bool1411 @param verbose: Verbose output1412 @type ignoresecuredevice: bool1413 @param ignoresecuredevice: Ignores the check for a secure device1414 @type serialno: str1415 @param serialno: The device or emulator serial number14161417 @return: the device and serialno used for the connection1418 '''14191420progname=os.path.basename(sys.argv[0])1421ifserialnoisNone:1422# eat all the extra options the invoking script may have added1423args=sys.argv1424whilelen(args)>1andargs[1][0]=='-':1425args.pop(1)1426serialno=args[1]iflen(args)>1else \ 1427os.environ['ANDROID_SERIAL']ifos.environ.has_key('ANDROID_SERIAL') \ 1428else'.*'1429ifIP_RE.match(serialno):1430# If matches an IP address format and port was not specified add the default1431serialno+=':%d'%ADB_DEFAULT_PORT1432ifverbose:1433print>>sys.stderr,'Connecting to a device with serialno=%s with a timeout of %d secs...'% \ 1434(serialno,timeout)1435ViewClient.setAlarm(timeout+5)1436device=adbclient.AdbClient(serialno)1437ViewClient.setAlarm(0)1438ifverbose:1439print>>sys.stderr,'Connected to device with serialno=%s'%serialno1440secure=device.getSystemProperty('ro.secure')1441debuggable=device.getSystemProperty('ro.debuggable')1442versionProperty=device.getProperty(VERSION_SDK_PROPERTY)1443ifversionProperty:1444version=int(versionProperty)1445else:1446ifverbose:1447print"Couldn't obtain device SDK version"1448version=-114491450# we are going to use UiAutomator for versions >= 16 that's why we ignore if the device1451# is secure if this is true1452ifsecure=='1'anddebuggable=='0'andnotignoresecuredeviceandversion<16:1453print>>sys.stderr,"%s: ERROR: Device is secure, AndroidViewClient won't work."%progname1454ifverbose:1455print>>sys.stderr," secure=%s debuggable=%s version=%d ignoresecuredevice=%s"% \ 1456(secure,debuggable,version,ignoresecuredevice)1457sys.exit(2)1458ifre.search("[.*()+]",serialno)andnotre.search("(\d{1,3}\.){3}\d{1,3}",serialno):1459# if a regex was used we have to determine the serialno used1460serialno=ViewClient.__obtainDeviceSerialNumber(device)1461ifverbose:1462print>>sys.stderr,'Actual device serialno=%s'%serialno1463returndevice,serialno
1467'''1468 Shows the View class, id and text if available.1469 This function can be used as a transform function to L{ViewClient.traverse()}14701471 @type view: I{View}1472 @param view: the View1473 @type extraInfo: method1474 @param extraInfo: the View method to add extra info1475 @type noextrainfo: bool1476 @param noextrainfo: Don't add extra info14771478 @return: the string containing class, id, and text if available1479 '''14801481try:1482eis=''1483ifextraInfo:1484eis=extraInfo(view).__str__()1485ifnoteisandnoextrainfo:1486eis=noextrainfo1487ifeis:1488eis=' '+eis1489return"%s %s %s%s"%(view.getClass(),view.getId(),view.getText(),eis)1490exceptException,e:1491return"Exception in view=%s: %s"%(view.__smallStr__(),e)
1495'''1496 Shows the View class, id, text if available and unique id.1497 This function can be used as a transform function to L{ViewClient.traverse()}14981499 @type view: I{View}1500 @param view: the View1501 @return: the string containing class, id, and text if available and unique Id1502 '''15031504returnViewClient.traverseShowClassIdAndText(view,View.getUniqueId)
1508'''1509 Shows the View class, id, text if available and unique id.1510 This function can be used as a transform function to L{ViewClient.traverse()}15111512 @type view: I{View}1513 @param view: the View1514 @return: the string containing class, id, and text if available and the content description1515 '''15161517returnViewClient.traverseShowClassIdAndText(view,View.getContentDescription,'NAF')
1521'''1522 Shows the View class, id and text if available.1523 This function can be used as a transform function to L{ViewClient.traverse()}15241525 @type view: I{View}1526 @param view: the View1527 @return: the string containing class, id, and text if available1528 '''15291530returnViewClient.traverseShowClassIdAndText(view,View.getCenter)
1534'''1535 Shows the View class, id and text if available.1536 This function can be used as a transform function to L{ViewClient.traverse()}15371538 @type view: I{View}1539 @param view: the View1540 @return: the string containing class, id, and text if available1541 '''15421543returnViewClient.traverseShowClassIdAndText(view,View.getPositionAndSize)
15441545# methods that can be used to transform ViewClient.traverse output1546TRAVERSE_CIT=traverseShowClassIdAndText1547''' An alias for L{traverseShowClassIdAndText(view)} '''1548TRAVERSE_CITUI=traverseShowClassIdTextAndUniqueId1549''' An alias for L{traverseShowClassIdTextAndUniqueId(view)} '''1550TRAVERSE_CITCD=traverseShowClassIdTextAndContentDescription1551''' An alias for L{traverseShowClassIdTextAndContentDescription(view)} '''1552TRAVERSE_CITC=traverseShowClassIdTextAndCenter1553''' An alias for L{traverseShowClassIdTextAndCenter(view)} '''1554TRAVERSE_CITPS=traverseShowClassIdTextPositionAndSize1555''' An alias for L{traverseShowClassIdTextPositionAndSize(view)} '''15561557@staticmethod
1568'''1569 Checks whether the response received from the server is correct or raises and Exception.15701571 @type response: str1572 @param response: Response received from the server15731574 @raise Exception: If the response received from the server is invalid1575 '''15761577ifnotself.serviceResponse(response):1578raiseException('Invalid response received from service.')
1581'''1582 Checks the response received from the I{ViewServer}.15831584 @return: C{True} if the response received matches L{PARCEL_TRUE}, C{False} otherwise1585 '''15861587PARCEL_TRUE="Result: Parcel(00000000 00000001 '........')\r\n"1588''' The TRUE response parcel '''1589ifDEBUG:1590print>>sys.stderr,"serviceResponse: comparing '%s' vs Parcel(%s)"%(response,PARCEL_TRUE)1591returnresponse==PARCEL_TRUE
1594'''1595 Sets L{self.views} to the received value splitting it into lines.15961597 @type received: str1598 @param received: the string received from the I{View Server}1599 '''16001601ifnotreceivedorreceived=="":1602raiseValueError("received is empty")1603self.views=[]1604''' 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()}. '''1605self.__parseTree(received.split("\n"))1606ifDEBUG:1607print>>sys.stderr,"there are %d views in this dump"%len(self.views)
1610'''1611 Sets L{self.views} to the received value parsing the received XML.16121613 @type received: str1614 @param received: the string received from the I{UI Automator}1615 '''16161617ifnotreceivedorreceived=="":1618raiseValueError("received is empty")1619self.views=[]1620''' 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()}. '''1621self.__parseTreeFromUiAutomatorDump(received)1622ifDEBUG:1623print>>sys.stderr,"there are %d views in this dump"%len(self.views)
1627'''1628 Splits the C{View} attributes in C{strArgs} and optionally adds the view id to the C{viewsById} list.16291630 Unique Ids1631 ==========1632 It is very common to find C{View}s having B{NO_ID} as the Id. This turns very difficult to1633 use L{self.findViewById()}. To help in this situation this method assigns B{unique Ids}.16341635 The B{unique Ids} are generated using the pattern C{id/no_id/<number>} with C{<number>} starting1636 at 1.16371638 @type strArgs: str1639 @param strArgs: the string containing the raw list of attributes and values16401641 @return: Returns the attributes map.1642 '''16431644ifself.useUiAutomator:1645raiseRuntimeError("This method is not compatible with UIAutomator")1646# replace the spaces in text:mText to preserve them in later split1647# they are translated back after the attribute matches1648textRE=re.compile('%s=%s,'%(self.textProperty,_nd('len')))1649m=textRE.search(strArgs)1650ifm:1651__textStart=m.end()1652__textLen=int(m.group('len'))1653__textEnd=m.end()+__textLen1654s1=strArgs[__textStart:__textEnd]1655s2=s1.replace(' ',WS)1656strArgs=strArgs.replace(s1,s2,1)16571658idRE=re.compile("(?P<viewId>id/\S+)")1659attrRE=re.compile('%s(?P<parens>\(\))?=%s,(?P<val>[^ ]*)'%(_ns('attr'),_nd('len')),flags=re.DOTALL)1660hashRE=re.compile('%s@%s'%(_ns('class'),_nh('oid')))16611662attrs={}1663viewId=None1664m=idRE.search(strArgs)1665ifm:1666viewId=m.group('viewId')1667ifDEBUG:1668print>>sys.stderr,"found view with id=%s"%viewId16691670forattrinstrArgs.split():1671m=attrRE.match(attr)1672ifm:1673__attr=m.group('attr')1674__parens='()'ifm.group('parens')else''1675__len=int(m.group('len'))1676__val=m.group('val')1677ifWARNINGSand__len!=len(__val):1678warnings.warn("Invalid len: expected: %d found: %d s=%s e=%s"%(__len,len(__val),__val[:50],__val[-50:]))1679if__attr==self.textProperty:1680# restore spaces that have been replaced1681__val=__val.replace(WS,' ')1682attrs[__attr+__parens]=__val1683else:1684m=hashRE.match(attr)1685ifm:1686attrs['class']=m.group('class')1687attrs['oid']=m.group('oid')1688else:1689ifDEBUG:1690print>>sys.stderr,attr,"doesn't match"16911692ifTrue:# was assignViewById1693ifnotviewId:1694# If the view has NO_ID we are assigning a default id here (id/no_id) which is1695# immediately incremented if another view with no id was found before to generate1696# a unique id1697viewId="id/no_id/1"1698ifviewIdinself.viewsById:1699# sometimes the view ids are not unique, so let's generate a unique id here1700i=11701whileTrue:1702newId=re.sub('/\d+$','',viewId)+'/%d'%i1703ifnotnewIdinself.viewsById:1704break1705i+=11706viewId=newId1707ifDEBUG:1708print>>sys.stderr,"adding viewById %s"%viewId1709# We are assigning a new attribute to keep the original id preserved, which could have1710# been NO_ID repeated multiple times1711attrs['uniqueId']=viewId17121713returnattrs
1716'''1717 Parses the View tree contained in L{receivedLines}. The tree is created and the root node assigned to L{self.root}.1718 This method also assigns L{self.viewsById} values using L{View.getUniqueId} as the key.17191720 @type receivedLines: str1721 @param receivedLines: the string received from B{View Server}1722 '''17231724self.root=None1725self.viewsById={}1726self.views=[]1727parent=None1728parents=[]1729treeLevel=-11730newLevel=-11731lastView=None1732forvinreceivedLines:1733ifv==''orv=='DONE'orv=='DONE.':1734break1735attrs=self.__splitAttrs(v)1736ifnotself.root:1737ifv[0]==' ':1738raiseException("Unexpected root element starting with ' '.")1739self.root=View.factory(attrs,self.device,self.build[VERSION_SDK_PROPERTY],self.forceViewServerUse)1740ifDEBUG:self.root.raw=v1741treeLevel=01742newLevel=01743lastView=self.root1744parent=self.root1745parents.append(parent)1746else:1747newLevel=(len(v)-len(v.lstrip()))1748ifnewLevel==0:1749raiseException("newLevel==0 treeLevel=%d but tree can have only one root, v=%s"%(treeLevel,v))1750child=View.factory(attrs,self.device,self.build[VERSION_SDK_PROPERTY],self.forceViewServerUse)1751ifDEBUG:child.raw=v1752ifnewLevel==treeLevel:1753parent.add(child)1754lastView=child1755elifnewLevel>treeLevel:1756if(newLevel-treeLevel)!=1:1757raiseException("newLevel jumps %d levels, v=%s"%((newLevel-treeLevel),v))1758parent=lastView1759parents.append(parent)1760parent.add(child)1761lastView=child1762treeLevel=newLevel1763else:# newLevel < treeLevel1764foriinrange(treeLevel-newLevel):1765parents.pop()1766parent=parents.pop()1767parents.append(parent)1768parent.add(child)1769treeLevel=newLevel1770lastView=child1771self.views.append(lastView)1772self.viewsById[lastView.getUniqueId()]=lastView
1791'''1792 Traverses the C{View} tree and prints its nodes.17931794 The nodes are printed converting them to string but other transformations can be specified1795 by providing a method name as the C{transform} parameter.17961797 @type root: L{View}1798 @param root: the root node from where the traverse starts1799 @type indent: str1800 @param indent: the indentation string to use to print the nodes1801 @type transform: method1802 @param transform: a method to use to transform the node before is printed1803 '''18041805iftype(root)==types.StringTypeandroot=="ROOT":1806root=self.root18071808returnViewClient.__traverse(root,indent,transform,stream)
1809# if not root:1810# return1811#1812# s = transform(root)1813# if s:1814# print >>stream, "%s%s" % (indent, s)1815#1816# for ch in root.children:1817# self.traverse(ch, indent=indent+" ", transform=transform, stream=stream)18181819@staticmethod
1833'''1834 Dumps the window content.18351836 Sleep is useful to wait some time before obtaining the new content when something in the1837 window has changed.18381839 @type window: int or str1840 @param window: the window id or name of the window to dump.1841 The B{name} is the package name or the window name (i.e. StatusBar) for1842 system windows.1843 The window id can be provided as C{int} or C{str}. The C{str} should represent1844 and C{int} in either base 10 or 16.1845 Use -1 to dump all windows.1846 This parameter only is used when the backend is B{ViewServer} and it's1847 ignored for B{UiAutomator}.1848 @type sleep: int1849 @param sleep: sleep in seconds before proceeding to dump the content18501851 @return: the list of Views as C{str} received from the server after being split into lines1852 '''18531854ifsleep>0:1855time.sleep(sleep)18561857ifself.useUiAutomator:1858# NOTICE:1859# Using /dev/tty this works even on devices with no sdcard1860received=unicode(self.device.shell('uiautomator dump /dev/tty >/dev/null'),encoding='utf-8',errors='replace')1861ifnotreceived:1862raiseRuntimeError('ERROR: Empty UiAutomator dump was received')1863ifDEBUG:1864self.received=received1865ifDEBUG_RECEIVED:1866print>>sys.stderr,"received %d chars"%len(received)1867print>>sys.stderr1868print>>sys.stderr,repr(received)1869print>>sys.stderr1870onlyKilledRE=re.compile('[\n\S]*Killed[\n\r\S]*',re.MULTILINE)1871ifonlyKilledRE.search(received):1872raiseRuntimeError('''ERROR: UiAutomator output contains no valid information. UiAutomator was killed, no reason given.''')1873ifself.ignoreUiAutomatorKilled:1874ifDEBUG_RECEIVED:1875print>>sys.stderr,"ignoring UiAutomator Killed"1876killedRE=re.compile('</hierarchy>[\n\S]*Killed',re.MULTILINE)1877ifkilledRE.search(received):1878received=re.sub(killedRE,'</hierarchy>',received)1879elifDEBUG_RECEIVED:1880print"UiAutomator Killed: NOT FOUND!"1881# It seems that API18 uiautomator spits this message to stdout1882dumpedToDevTtyRE=re.compile('</hierarchy>[\n\S]*UI hierchary dumped to: /dev/tty.*',re.MULTILINE)1883ifdumpedToDevTtyRE.search(received):1884received=re.sub(dumpedToDevTtyRE,'</hierarchy>',received)1885# API19 seems to send this warning as part of the XML.1886# Let's remove it if present1887received=received.replace('WARNING: linker: libdvm.so has text relocations. This is wasting memory and is a security risk. Please fix.\r\n','')1888ifDEBUG_RECEIVED:1889print>>sys.stderr,"received=",received1890ifre.search('\[: not found',received):1891raiseRuntimeError('''ERROR: Some emulator images (i.e. android 4.1.2 API 16 generic_x86) does not include the '[' command.1892While UiAutomator back-end might be supported 'uiautomator' command fails.1893You should force ViewServer back-end.''')1894self.setViewsFromUiAutomatorDump(received)1895else:1896ifisinstance(window,str):1897ifwindow!='-1':1898self.list(sleep=0)1899found=False1900forwIdinself.windows:1901try:1902ifwindow==self.windows[wId]:1903window=wId1904found=True1905break1906except:1907pass1908try:1909ifint(window)==wId:1910window=wId1911found=True1912break1913except:1914pass1915try:1916ifint(window,16)==wId:1917window=wId1918found=True1919break1920except:1921pass19221923ifnotfound:1924raiseRuntimeError("ERROR: Cannot find window '%s' in %s"%(window,self.windows))1925else:1926window=-119271928s=socket.socket(socket.AF_INET,socket.SOCK_STREAM)1929try:1930s.connect((VIEW_SERVER_HOST,self.localPort))1931exceptsocket.error,ex:1932raiseRuntimeError("ERROR: Connecting to %s:%d: %s"%(VIEW_SERVER_HOST,self.localPort,ex))1933cmd='dump %x\r\n'%window1934ifDEBUG:1935print>>sys.stderr,"executing: '%s'"%cmd1936s.send(cmd)1937received=""1938doneRE=re.compile("DONE")1939ViewClient.setAlarm(120)1940whileTrue:1941ifDEBUG_RECEIVED:1942print>>sys.stderr," reading from socket..."1943received+=s.recv(1024)1944ifdoneRE.search(received[-7:]):1945break1946s.close()1947ViewClient.setAlarm(0)1948ifDEBUG:1949self.received=received1950ifDEBUG_RECEIVED:1951print>>sys.stderr,"received %d chars"%len(received)1952print>>sys.stderr1953print>>sys.stderr,received1954print>>sys.stderr1955self.setViews(received)19561957ifDEBUG_TREE:1958self.traverse(self.root)19591960returnself.views
1963'''1964 List the windows.19651966 Sleep is useful to wait some time before obtaining the new content when something in the1967 window has changed.1968 This also sets L{self.windows} as the list of windows.19691970 @type sleep: int1971 @param sleep: sleep in seconds before proceeding to dump the content19721973 @return: the list of windows1974 '''19751976ifsleep>0:1977time.sleep(sleep)19781979ifself.useUiAutomator:1980raiseException("Not implemented yet: listing windows with UiAutomator")1981else:1982s=socket.socket(socket.AF_INET,socket.SOCK_STREAM)1983try:1984s.connect((VIEW_SERVER_HOST,self.localPort))1985exceptsocket.error,ex:1986raiseRuntimeError("ERROR: Connecting to %s:%d: %s"%(VIEW_SERVER_HOST,self.localPort,ex))1987s.send('list\r\n')1988received=""1989doneRE=re.compile("DONE")1990whileTrue:1991received+=s.recv(1024)1992ifdoneRE.search(received[-7:]):1993break1994s.close()1995ifDEBUG:1996self.received=received1997ifDEBUG_RECEIVED:1998print>>sys.stderr,"received %d chars"%len(received)1999print>>sys.stderr2000print>>sys.stderr,received2001print>>sys.stderr20022003self.windows={}2004forlineinreceived.split('\n'):2005ifnotline:2006break2007ifdoneRE.search(line):2008break2009values=line.split()2010iflen(values)>1:2011package=values[1]2012else:2013package="UNKNOWN"2014iflen(values)>0:2015wid=values[0]2016else:2017wid='00000000'2018self.windows[int('0x'+wid,16)]=package2019returnself.windows
2023'''2024 Finds the View with the specified viewId.20252026 @type viewId: str2027 @param viewId: the ID of the view to find2028 @type root: str2029 @type root: View2030 @param root: the root node of the tree where the View will be searched2031 @type: viewFilter: function2032 @param viewFilter: a function that will be invoked providing the candidate View as a parameter2033 and depending on the return value (C{True} or C{False}) the View will be2034 selected and returned as the result of C{findViewById()} or ignored.2035 This can be C{None} and no extra filtering is applied.20362037 @return: the C{View} found or C{None}2038 '''20392040ifnotroot:2041returnNone20422043iftype(root)==types.StringTypeandroot=="ROOT":2044returnself.findViewById(viewId,self.root,viewFilter)20452046ifroot.getId()==viewId:2047ifviewFilter:2048ifviewFilter(root):2049returnroot2050else:2051returnroot20522053ifre.match('^id/no_id',viewId)orre.match('^id/.+/.+',viewId):2054ifroot.getUniqueId()==viewId:2055ifviewFilter:2056ifviewFilter(root):2057returnroot;2058else:2059returnroot206020612062forchinroot.children:2063foundView=self.findViewById(viewId,ch,viewFilter)2064iffoundView:2065ifviewFilter:2066ifviewFilter(foundView):2067returnfoundView2068else:2069returnfoundView
2072'''2073 Finds the View or raise a ViewNotFoundException.20742075 @type viewId: str2076 @param viewId: the ID of the view to find2077 @type root: str2078 @type root: View2079 @param root: the root node of the tree where the View will be searched2080 @type: viewFilter: function2081 @param viewFilter: a function that will be invoked providing the candidate View as a parameter2082 and depending on the return value (C{True} or C{False}) the View will be2083 selected and returned as the result of C{findViewById()} or ignored.2084 This can be C{None} and no extra filtering is applied.2085 @return: the View found2086 @raise ViewNotFoundException: raise the exception if View not found2087 '''20882089view=self.findViewById(viewId,root,viewFilter)2090ifview:2091returnview2092else:2093raiseViewNotFoundException("ID",viewId,root)
2103'''2104 Finds the View with the specified tag or raise a ViewNotFoundException2105 '''21062107view=self.findViewWithAttribute('getTag()',tag,root)2108ifview:2109returnview2110else:2111raiseViewNotFoundException("tag",tag,root)
2114ifnotself.root:2115print>>sys.stderr,"ERROR: no root, did you forget to call dump()?"2116returnNone21172118iftype(root)==types.StringTypeandroot=="ROOT":2119root=self.root21202121ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: type val=",type(val)2122ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: checking if root=%s has attr=%s == %s"%(root.__smallStr__(),attr,val)21232124ifisinstance(val,RegexType):2125returnself.__findViewWithAttributeInTreeThatMatches(attr,val,root)2126else:2127ifrootandattrinroot.mapandroot.map[attr]==val:2128ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: FOUND: %s"%root.__smallStr__()2129returnroot2130else:2131forchinroot.children:2132v=self.__findViewWithAttributeInTree(attr,val,ch)2133ifv:2134returnv21352136returnNone
2146ifnotself.root:2147print>>sys.stderr,"ERROR: no root, did you forget to call dump()?"2148returnNone21492150iftype(root)==types.StringTypeandroot=="ROOT":2151root=self.root21522153ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTreeThatMatches: checking if root=%s attr=%s matches %s"%(root.__smallStr__(),attr,regex)21542155ifrootandattrinroot.mapandregex.match(root.map[attr]):2156ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTreeThatMatches: FOUND: %s"%root.__smallStr__()2157returnroot2158#print >>sys.stderr, "appending root=%s to rlist=%s" % (root.__smallStr__(), rlist)2159#return rlist.append(root)2160else:2161forchinroot.children:2162v=self.__findViewWithAttributeInTreeThatMatches(attr,regex,ch,rlist)2163ifv:2164returnv2165#print >>sys.stderr, "appending v=%s to rlist=%s" % (v.__smallStr__(), rlist)2166#return rlist.append(v)21672168returnNone
2179'''2180 Finds the View or raise a ViewNotFoundException.21812182 @return: the View found2183 @raise ViewNotFoundException: raise the exception if View not found2184 '''21852186view=self.findViewWithAttribute(attr,val,root)2187ifview:2188returnview2189else:2190raiseViewNotFoundException(attr,val,root)
2193'''2194 Finds the list of Views with the specified attribute matching2195 regex2196 '''21972198returnself.__findViewWithAttributeInTreeThatMatches(attr,regex,root)
2218'''2219 Finds the View or raise a ViewNotFoundException.22202221 @return: the View found2222 @raise ViewNotFoundException: raise the exception if View not found2223 '''22242225ifDEBUG:2226print>>sys.stderr,"findViewWithTextOrRaise(%s, %s)"%(text,root)2227view=self.findViewWithText(text,root)2228ifview:2229returnview2230else:2231raiseViewNotFoundException("text",text,root)
2234'''2235 Finds the View with the specified content description2236 '''22372238returnself.__findViewWithAttributeInTree('content-desc',contentdescription,root)
2241'''2242 Finds the View with the specified content description2243 '''22442245returnself.__findViewWithAttributeInTreeOrRaise('content-desc',contentdescription,root)
2248'''2249 Finds the list of Views that contain the point (x, y).2250 '''22512252ifnotfilter:2253filter=lambdav:True22542255return[vforvinself.viewsif(v.containsPoint((x,y))andfilter(v))]
2284'''2285 Whether the keyboard is displayed.2286 '''22872288dim=self.device.shell('dumpsys input_method')2289ifdim:2290# FIXME: API >= 15 ?2291return"mInputShown=true"indim2292returnFalse
2295'''2296 Write the View image to the specified filename in the specified format.22972298 @type filename: str2299 @param filename: Absolute path and optional filename receiving the image. If this points to2300 a directory, then the filename is determined by the serialno of the device and2301 format extension.2302 @type format: str2303 @param format: Image format (default format is PNG)2304 '''23052306ifnotos.path.isabs(filename):2307raiseValueError("writeImageToFile expects an absolute path")2308ifos.path.isdir(filename):2309filename=os.path.join(filename,self.serialno+'.'+format.lower())2310ifDEBUG:2311print>>sys.stderr,"writeImageToFile: saving image to '%s' in %s format"%(filename,format)2312self.device.takeSnapshot().save(filename,format)
2316'''2317 Makes the tree pickleable.2318 '''23192320defremoveDeviceReference(view):2321'''2322 Removes the reference to a L{MonkeyDevice}.2323 '''23242325view.device=None
23262327###########################################################################################2328# FIXME: Unfortunatelly deepcopy does not work with MonkeyDevice objects, which is2329# sadly the reason why we cannot pickle the tree and we need to remove the MonkeyDevice2330# references.2331# We wanted to copy the tree to preserve the original and make piclkleable the copy.2332#treeCopy = copy.deepcopy(tree)2333treeCopy=tree2334# IMPORTANT:2335# This assumes that the first element in the list is the tree root2336ViewClient.__traverse(treeCopy[0],transform=removeDeviceReference)2337###########################################################################################2338returntreeCopy
2341'''2342 Calculates the distance between this tree and the tree passed as argument.23432344 @type tree: list of Views2345 @param tree: Tree of Views2346 @return: the distance2347 '''2348################################################################2349#FIXME: this should copy the entire tree and then transform it #2350################################################################2351pickleableViews=ViewClient.__pickleable(self.views)2352pickleableTree=ViewClient.__pickleable(tree)2353s1=pickle.dumps(pickleableViews)2354s2=pickle.dumps(pickleableTree)23552356ifDEBUG_DISTANCE:2357print>>sys.stderr,"distance: calculating distance between",s1[:20],"and",s2[:20]23582359l1=len(s1)2360l2=len(s2)2361t=float(max(l1,l2))23622363ifl1==l2:2364ifDEBUG_DISTANCE:2365print>>sys.stderr,"distance: trees have same length, using Hamming distance"2366returnViewClient.__hammingDistance(s1,s2)/t2367else:2368ifDEBUG_DISTANCE:2369print>>sys.stderr,"distance: trees have different length, using Levenshtein distance"2370returnViewClient.__levenshteinDistance(s1,s2)/t
2374'''2375 Finds the Hamming distance between two strings.23762377 @param s1: string2378 @param s2: string2379 @return: the distance2380 @raise ValueError: if the lenght of the strings differ2381 '''23822383l1=len(s1)2384l2=len(s2)23852386ifl1!=l2:2387raiseValueError("Hamming distance requires strings of same size.")23882389returnsum(ch1!=ch2forch1,ch2inzip(s1,s2))
2392'''2393 Finds the Hamming distance between this tree and the one passed as argument.2394 '''23952396s1=' '.join(map(View.__str__,self.views))2397s2=' '.join(map(View.__str__,tree))23982399returnViewClient.__hammingDistance(s1,s2)
2403'''2404 Find the Levenshtein distance between two Strings.24052406 Python version of Levenshtein distance method implemented in Java at2407 U{http://www.java2s.com/Code/Java/Data-Type/FindtheLevenshteindistancebetweentwoStrings.htm}.24082409 This is the number of changes needed to change one String into2410 another, where each change is a single character modification (deletion,2411 insertion or substitution).24122413 The previous implementation of the Levenshtein distance algorithm2414 was from U{http://www.merriampark.com/ld.htm}24152416 Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError2417 which can occur when my Java implementation is used with very large strings.2418 This implementation of the Levenshtein distance algorithm2419 is from U{http://www.merriampark.com/ldjava.htm}::24202421 StringUtils.getLevenshteinDistance(null, *) = IllegalArgumentException2422 StringUtils.getLevenshteinDistance(*, null) = IllegalArgumentException2423 StringUtils.getLevenshteinDistance("","") = 02424 StringUtils.getLevenshteinDistance("","a") = 12425 StringUtils.getLevenshteinDistance("aaapppp", "") = 72426 StringUtils.getLevenshteinDistance("frog", "fog") = 12427 StringUtils.getLevenshteinDistance("fly", "ant") = 32428 StringUtils.getLevenshteinDistance("elephant", "hippo") = 72429 StringUtils.getLevenshteinDistance("hippo", "elephant") = 72430 StringUtils.getLevenshteinDistance("hippo", "zzzzzzzz") = 82431 StringUtils.getLevenshteinDistance("hello", "hallo") = 124322433 @param s: the first String, must not be null2434 @param t: the second String, must not be null2435 @return: result distance2436 @raise ValueError: if either String input C{null}2437 '''2438ifsisNoneortisNone:2439raiseValueError("Strings must not be null")24402441n=len(s)2442m=len(t)24432444ifn==0:2445returnm2446elifm==0:2447returnn24482449ifn>m:2450tmp=s2451s=t2452t=tmp2453n=m;2454m=len(t)24552456p=[None]*(n+1)2457d=[None]*(n+1)24582459foriinrange(0,n+1):2460p[i]=i24612462forjinrange(1,m+1):2463ifDEBUG_DISTANCE:2464ifj%100==0:2465print>>sys.stderr,"DEBUG:",int(j/(m+1.0)*100),"%\r",2466t_j=t[j-1]2467d[0]=j24682469foriinrange(1,n+1):2470cost=0ifs[i-1]==t_jelse12471# minimum of cell to the left+1, to the top+1, diagonally left and up +cost2472d[i]=min(min(d[i-1]+1,p[i]+1),p[i-1]+cost)24732474_d=p2475p=d2476d=_d24772478ifDEBUG_DISTANCE:2479print>>sys.stderr,"\n"2480returnp[n]
{'0': 'use a null back-end (no View tree obtained)','1': 'install APK as precondition','A': 'device art model to frame screenshot (auto: autodetected)','B': 'screen glare over screenshot','D': 'use a dictionary to store the Views found','E': 'ignores ADB version check','G': 'presents the GUI (EXPERIMENTAL)','H': 'prints this help',...
The base class for all CulebraTests.
Class variables
---------------
There are some class variables that can be used to change the behavior of the tests.
B{serialno}: The serial number of the device. This can also be a list of devices for I{mutli-devices}
tests or the keyword C{all} to run the tests on all available devices or C{default} to run the tests
only on the default (first) device.
When a I{multi-device} test is running the available devices are available in a list named
L{self.devices} which has the corresponding L{ConnectedDevices} entries.
Also, in the case of I{multi-devices} tests and to be backward compatible with I{single-device} tests
the default device, the first one in the devices list, is assigned to L{self.device}, L{self.vc} and
L{self.serialno} too.
B{verbose}: The verbosity of the tests. This can be changed from the test command line using the
command line option C{-v} or C{--verbose}.
Create an instance of the class that will use the named test method
when executed. Raises a ValueError if the instance does not have a method
with the specified name.
Used to enumerate a container's user interface (UI) elements for the
purpose of counting, or targeting a sub elements by a child's text or
description.
Provides access to state information about the device. You can also
use this class to simulate user actions on the device, such as pressing
the d-pad or pressing the Home and Menu buttons.
scrollTextIntoView(self,
text)
Performs a forward scroll action on the scrollable layout element
until the text you provided is visible, or until swipe attempts have
been exhausted.
Performs a forward scroll action on the scrollable layout element
until the text you provided is visible, or until swipe attempts have been
exhausted. See setMaxSearchSwipes(int)
_map (map) - the map containing the (attribute, value) pairs
device (AdbClient) - the device containing this View
version (int) - the Android SDK version number of the platform where this View
belongs. If this is -1 then the Android SDK version
will be obtained in this constructor.
forceviewserveruse (boolean) - Force the use of ViewServer even if the conditions
were given to use UiAutomator.
uiAutomatorHelper (UiAutomatorHelper @:param uiAutomatorHelper: The
UiAutomatorHelper if available)
Write the View image to the specified filename in the specified
format.
Parameters:
filename (str) - Absolute path and optional filename receiving the image. If this
points to a directory, then the filename is determined by this
View unique ID and format extension.
_format (str) - Image format (default format is PNG)
writeImageToFile(self,
filename,
_format='PNG',
deviceart=None,
dropshadow=True,
screenglare=True)
Write the View image to the specified filename in the specified
format.
connectToDeviceOrExit(timeout=60,
verbose=False,
ignoresecuredevice=False,
ignoreversioncheck=False,
serialno=None)
Connects to a device which serial number is obtained from the script arguments if available
or using the default regex C{.*}.
Connects to a device which serial number is obtained from the script arguments if available
or using the default regex C{.*}.
If the connection is not successful the script exits.
History
-------
In MonkeyRunner times, this method was a way of overcoming one of its limitations.
L{MonkeyRunner.waitForConnection()} returns a L{MonkeyDevice} even if the connection failed.
Then, to detect this situation, C{device.wake()} is attempted and if it fails then it is
assumed the previous connection failed.
@type timeout: int
@param timeout: timeout for the connection
@type verbose: bool
@param verbose: Verbose output
@type ignoresecuredevice: bool
@param ignoresecuredevice: Ignores the check for a secure device
@type ignoreversioncheck: bool
@param ignoreversioncheck: Ignores the check for a supported ADB version
@type serialno: str
@param serialno: The device or emulator serial number
@return: the device and serialno used for the connection
Shows the View class, id, text if available and unique id and takes
the screenshot. This function can be used as a transform function to ViewClient.traverse()
Parameters:
view (View) - the View
Returns:
the string containing class, id, and text if available and the
content description
Splits the View attributes in strArgs and
optionally adds the view id to the viewsById list.
Unique Ids
It is very common to find Views having NO_ID as
the Id. This turns very difficult to use self.findViewById(). To help in this situation this
method assigns unique Ids.
The unique Ids are generated using the pattern
id/no_id/<number> with <number>
starting at 1.
Parameters:
strArgs (str) - the string containing the raw list of attributes and values
Parses the View tree contained in receivedLines. The tree is created and the root node
assigned to self.root. This method also assigns self.viewsById values using View.getUniqueId as the key.
Parameters:
receivedLines (str) - the string received from View Server
Sleep is useful to wait some time before obtaining the new content
when something in the window has changed.
Parameters:
window (int or str) - the window id or name of the window to dump. The name is
the package name or the window name (i.e. StatusBar) for system
windows. The window id can be provided as int or
str. The str should represent and
int in either base 10 or 16. Use -1 to dump all
windows. This parameter only is used when the backend is
ViewServer and it's ignored for UiAutomator.
sleep (int) - sleep in seconds before proceeding to dump the content
Returns:
the list of Views as str received from the server
after being split into lines
Sleep is useful to wait some time before obtaining the new content
when something in the window has changed. This also sets self.windows as the list of windows.
Parameters:
sleep (int) - sleep in seconds before proceeding to dump the content
root (str) - the root node of the tree where the View will be searched
viewFilter - a function that will be invoked providing the candidate View as a
parameter and depending on the return value (True or
False) the View will be selected and returned as the
result of findViewById() or ignored. This can be
None and no extra filtering is applied.
root (str) - the root node of the tree where the View will be searched
viewFilter - a function that will be invoked providing the candidate View as a
parameter and depending on the return value (True or
False) the View will be selected and returned as the
result of findViewById() or ignored. This can be
None and no extra filtering is applied.
Finds the Views with the specified attribute and value.
This allows you to see all items that match your criteria in the view hierarchy
Usage:
buttons = v.findViewsWithAttribute("class", "android.widget.Button")
Write the View image to the specified filename in the specified
format.
Parameters:
filename (str) - Absolute path and optional filename receiving the image. If this
points to a directory, then the filename is determined by the
serialno of the device and format extension.
_format (str) - Image format (default format is PNG)
This is the number of changes needed to change one String into
another, where each change is a single character modification (deletion,
insertion or substitution).
Chas Emerick has written an implementation in Java, which avoids an
OutOfMemoryError which can occur when my Java implementation is used with
very large strings. This implementation of the Levenshtein distance
algorithm is from http://www.merriampark.com/ldjava.htm:
On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed
just after generating the dump file. In many cases the file is already
complete so we can ask to ignore the 'Killed' message by setting ignoreuiautomatorkilled to True.
Changes in v2.3.21 that uses /dev/tty instead of a file
may have turned this variable unnecessary, however it has been kept for
backward compatibility.
uiDevice
The output of compressed dump is different than output of uncompressed
one. If one requires uncompressed output, this option should be set to
False
views
The list of Views represented as str obtained after
splitting it into lines after being received from the server. Done by self.setViews().
Copyright (C) 2012-2017 Diego Torres Milano
Created on Jan 5, 2015
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
AndroidViewClient-20.4.4/docs/epydoc.css 0000664 0000000 0000000 00000037227 14156000053 0020105 0 ustar 00root root 0000000 0000000
/* Epydoc CSS Stylesheet
*
* This stylesheet can be used to customize the appearance of epydoc's
* HTML output.
*
*/
/* Default Colors & Styles
* - Set the default foreground & background color with 'body'; and
* link colors with 'a:link' and 'a:visited'.
* - Use bold for decision list terms.
* - The heading styles defined here are used for headings *within*
* docstring descriptions. All headings used by epydoc itself use
* either class='epydoc' or class='toc' (CSS styles for both
* defined below).
*/
body { background: #ffffff; color: #000000; }
p { margin-top: 0.5em; margin-bottom: 0.5em; }
a:link { color: #0000ff; }
a:visited { color: #204080; }
dt { font-weight: bold; }
h1 { font-size: +140%; font-style: italic;
font-weight: bold; }
h2 { font-size: +125%; font-style: italic;
font-weight: bold; }
h3 { font-size: +110%; font-style: italic;
font-weight: normal; }
code { font-size: 100%; }
/* N.B.: class, not pseudoclass */
a.link { font-family: monospace; }
/* Page Header & Footer
* - The standard page header consists of a navigation bar (with
* pointers to standard pages such as 'home' and 'trees'); a
* breadcrumbs list, which can be used to navigate to containing
* classes or modules; options links, to show/hide private
* variables and to show/hide frames; and a page title (using
*
). The page title may be followed by a link to the
* corresponding source code (using 'span.codelink').
* - The footer consists of a navigation bar, a timestamp, and a
* pointer to epydoc's homepage.
*/
h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
h2.epydoc { font-size: +130%; font-weight: bold; }
h3.epydoc { font-size: +115%; font-weight: bold;
margin-top: 0.2em; }
td h3.epydoc { font-size: +115%; font-weight: bold;
margin-bottom: 0; }
table.navbar { background: #a0c0ff; color: #000000;
border: 2px groove #c0d0d0; }
table.navbar table { color: #000000; }
th.navbar-select { background: #70b0ff;
color: #000000; }
table.navbar a { text-decoration: none; }
table.navbar a:link { color: #0000ff; }
table.navbar a:visited { color: #204080; }
span.breadcrumbs { font-size: 85%; font-weight: bold; }
span.options { font-size: 70%; }
span.codelink { font-size: 85%; }
td.footer { font-size: 85%; }
/* Table Headers
* - Each summary table and details section begins with a 'header'
* row. This row contains a section title (marked by
* 'span.table-header') as well as a show/hide private link
* (marked by 'span.options', defined above).
* - Summary tables that contain user-defined groups mark those
* groups using 'group header' rows.
*/
td.table-header { background: #70b0ff; color: #000000;
border: 1px solid #608090; }
td.table-header table { color: #000000; }
td.table-header table a:link { color: #0000ff; }
td.table-header table a:visited { color: #204080; }
span.table-header { font-size: 120%; font-weight: bold; }
th.group-header { background: #c0e0f8; color: #000000;
text-align: left; font-style: italic;
font-size: 115%;
border: 1px solid #608090; }
/* Summary Tables (functions, variables, etc)
* - Each object is described by a single row of the table with
* two cells. The left cell gives the object's type, and is
* marked with 'code.summary-type'. The right cell gives the
* object's name and a summary description.
* - CSS styles for the table's header and group headers are
* defined above, under 'Table Headers'
*/
table.summary { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin-bottom: 0.5em; }
td.summary { border: 1px solid #608090; }
code.summary-type { font-size: 85%; }
table.summary a:link { color: #0000ff; }
table.summary a:visited { color: #204080; }
/* Details Tables (functions, variables, etc)
* - Each object is described in its own div.
* - A single-row summary table w/ table-header is used as
* a header for each details section (CSS style for table-header
* is defined above, under 'Table Headers').
*/
table.details { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin: .2em 0 0 0; }
table.details table { color: #000000; }
table.details a:link { color: #0000ff; }
table.details a:visited { color: #204080; }
/* Fields */
dl.fields { margin-left: 2em; margin-top: 1em;
margin-bottom: 1em; }
dl.fields dd ul { margin-left: 0em; padding-left: 0em; }
dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; }
div.fields { margin-left: 2em; }
div.fields p { margin-bottom: 0.5em; }
/* Index tables (identifier index, term index, etc)
* - link-index is used for indices containing lists of links
* (namely, the identifier index & term index).
* - index-where is used in link indices for the text indicating
* the container/source for each link.
* - metadata-index is used for indices containing metadata
* extracted from fields (namely, the bug index & todo index).
*/
table.link-index { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090; }
td.link-index { border-width: 0px; }
table.link-index a:link { color: #0000ff; }
table.link-index a:visited { color: #204080; }
span.index-where { font-size: 70%; }
table.metadata-index { border-collapse: collapse;
background: #e8f0f8; color: #000000;
border: 1px solid #608090;
margin: .2em 0 0 0; }
td.metadata-index { border-width: 1px; border-style: solid; }
table.metadata-index a:link { color: #0000ff; }
table.metadata-index a:visited { color: #204080; }
/* Function signatures
* - sig* is used for the signature in the details section.
* - .summary-sig* is used for the signature in the summary
* table, and when listing property accessor functions.
* */
.sig-name { color: #006080; }
.sig-arg { color: #008060; }
.sig-default { color: #602000; }
.summary-sig { font-family: monospace; }
.summary-sig-name { color: #006080; font-weight: bold; }
table.summary a.summary-sig-name:link
{ color: #006080; font-weight: bold; }
table.summary a.summary-sig-name:visited
{ color: #006080; font-weight: bold; }
.summary-sig-arg { color: #006040; }
.summary-sig-default { color: #501800; }
/* Subclass list
*/
ul.subclass-list { display: inline; }
ul.subclass-list li { display: inline; }
/* To render variables, classes etc. like functions */
table.summary .summary-name { color: #006080; font-weight: bold;
font-family: monospace; }
table.summary
a.summary-name:link { color: #006080; font-weight: bold;
font-family: monospace; }
table.summary
a.summary-name:visited { color: #006080; font-weight: bold;
font-family: monospace; }
/* Variable values
* - In the 'variable details' sections, each varaible's value is
* listed in a 'pre.variable' box. The width of this box is
* restricted to 80 chars; if the value's repr is longer than
* this it will be wrapped, using a backslash marked with
* class 'variable-linewrap'. If the value's repr is longer
* than 3 lines, the rest will be ellided; and an ellipsis
* marker ('...' marked with 'variable-ellipsis') will be used.
* - If the value is a string, its quote marks will be marked
* with 'variable-quote'.
* - If the variable is a regexp, it is syntax-highlighted using
* the re* CSS classes.
*/
pre.variable { padding: .5em; margin: 0;
background: #dce4ec; color: #000000;
border: 1px solid #708890; }
.variable-linewrap { color: #604000; font-weight: bold; }
.variable-ellipsis { color: #604000; font-weight: bold; }
.variable-quote { color: #604000; font-weight: bold; }
.variable-group { color: #008000; font-weight: bold; }
.variable-op { color: #604000; font-weight: bold; }
.variable-string { color: #006030; }
.variable-unknown { color: #a00000; font-weight: bold; }
.re { color: #000000; }
.re-char { color: #006030; }
.re-op { color: #600000; }
.re-group { color: #003060; }
.re-ref { color: #404040; }
/* Base tree
* - Used by class pages to display the base class hierarchy.
*/
pre.base-tree { font-size: 80%; margin: 0; }
/* Frames-based table of contents headers
* - Consists of two frames: one for selecting modules; and
* the other listing the contents of the selected module.
* - h1.toc is used for each frame's heading
* - h2.toc is used for subheadings within each frame.
*/
h1.toc { text-align: center; font-size: 105%;
margin: 0; font-weight: bold;
padding: 0; }
h2.toc { font-size: 100%; font-weight: bold;
margin: 0.5em 0 0 -0.3em; }
/* Syntax Highlighting for Source Code
* - doctest examples are displayed in a 'pre.py-doctest' block.
* If the example is in a details table entry, then it will use
* the colors specified by the 'table pre.py-doctest' line.
* - Source code listings are displayed in a 'pre.py-src' block.
* Each line is marked with 'span.py-line' (used to draw a line
* down the left margin, separating the code from the line
* numbers). Line numbers are displayed with 'span.py-lineno'.
* The expand/collapse block toggle button is displayed with
* 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not
* modify the font size of the text.)
* - If a source code page is opened with an anchor, then the
* corresponding code block will be highlighted. The code
* block's header is highlighted with 'py-highlight-hdr'; and
* the code block's body is highlighted with 'py-highlight'.
* - The remaining py-* classes are used to perform syntax
* highlighting (py-string for string literals, py-name for names,
* etc.)
*/
pre.py-doctest { padding: .5em; margin: 1em;
background: #e8f0f8; color: #000000;
border: 1px solid #708890; }
table pre.py-doctest { background: #dce4ec;
color: #000000; }
pre.py-src { border: 2px solid #000000;
background: #f0f0f0; color: #000000; }
.py-line { border-left: 2px solid #000000;
margin-left: .2em; padding-left: .4em; }
.py-lineno { font-style: italic; font-size: 90%;
padding-left: .5em; }
a.py-toggle { text-decoration: none; }
div.py-highlight-hdr { border-top: 2px solid #000000;
border-bottom: 2px solid #000000;
background: #d8e8e8; }
div.py-highlight { border-bottom: 2px solid #000000;
background: #d0e0e0; }
.py-prompt { color: #005050; font-weight: bold;}
.py-more { color: #005050; font-weight: bold;}
.py-string { color: #006030; }
.py-comment { color: #003060; }
.py-keyword { color: #600000; }
.py-output { color: #404040; }
.py-name { color: #000050; }
.py-name:link { color: #000050 !important; }
.py-name:visited { color: #000050 !important; }
.py-number { color: #005000; }
.py-defname { color: #000060; font-weight: bold; }
.py-def-name { color: #000060; font-weight: bold; }
.py-base-class { color: #000060; }
.py-param { color: #000060; }
.py-docstring { color: #006030; }
.py-decorator { color: #804020; }
/* Use this if you don't want links to names underlined: */
/*a.py-name { text-decoration: none; }*/
/* Graphs & Diagrams
* - These CSS styles are used for graphs & diagrams generated using
* Graphviz dot. 'img.graph-without-title' is used for bare
* diagrams (to remove the border created by making the image
* clickable).
*/
img.graph-without-title { border: none; }
img.graph-with-title { border: 1px solid #000000; }
span.graph-title { font-weight: bold; }
span.graph-caption { }
/* General-purpose classes
* - 'p.indent-wrapped-lines' defines a paragraph whose first line
* is not indented, but whose subsequent lines are.
* - The 'nomargin-top' class is used to remove the top margin (e.g.
* from lists). The 'nomargin' class is used to remove both the
* top and bottom margin (but not the left or right margin --
* for lists, that would cause the bullets to disappear.)
*/
p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em;
margin: 0; }
.nomargin-top { margin-top: 0; }
.nomargin { margin-top: 0; margin-bottom: 0; }
/* HTML Log */
div.log-block { padding: 0; margin: .5em 0 .5em 0;
background: #e8f0f8; color: #000000;
border: 1px solid #000000; }
div.log-error { padding: .1em .3em .1em .3em; margin: 4px;
background: #ffb0b0; color: #000000;
border: 1px solid #000000; }
div.log-warning { padding: .1em .3em .1em .3em; margin: 4px;
background: #ffffb0; color: #000000;
border: 1px solid #000000; }
div.log-info { padding: .1em .3em .1em .3em; margin: 4px;
background: #b0ffb0; color: #000000;
border: 1px solid #000000; }
h2.log-hdr { background: #70b0ff; color: #000000;
margin: 0; padding: 0em 0.5em 0em 0.5em;
border-bottom: 1px solid #000000; font-size: 110%; }
p.log { font-weight: bold; margin: .5em 0 .5em 0; }
tr.opt-changed { color: #000000; font-weight: bold; }
tr.opt-default { color: #606060; }
pre.log { margin: 0; padding: 0; padding-left: 1em; }
AndroidViewClient-20.4.4/docs/epydoc.js 0000664 0000000 0000000 00000024525 14156000053 0017726 0 ustar 00root root 0000000 0000000 function toggle_private() {
// Search for any private/public links on this page. Store
// their old text in "cmd," so we will know what action to
// take; and change their text to the opposite action.
var cmd = "?";
var elts = document.getElementsByTagName("a");
for(var i=0; i... ";
elt.innerHTML = s;
}
}
function toggle(id) {
elt = document.getElementById(id+"-toggle");
if (elt.innerHTML == "-")
collapse(id);
else
expand(id);
return false;
}
function highlight(id) {
var elt = document.getElementById(id+"-def");
if (elt) elt.className = "py-highlight-hdr";
var elt = document.getElementById(id+"-expanded");
if (elt) elt.className = "py-highlight";
var elt = document.getElementById(id+"-collapsed");
if (elt) elt.className = "py-highlight";
}
function num_lines(s) {
var n = 1;
var pos = s.indexOf("\n");
while ( pos > 0) {
n += 1;
pos = s.indexOf("\n", pos+1);
}
return n;
}
// Collapse all blocks that mave more than `min_lines` lines.
function collapse_all(min_lines) {
var elts = document.getElementsByTagName("div");
for (var i=0; i 0)
if (elt.id.substring(split, elt.id.length) == "-expanded")
if (num_lines(elt.innerHTML) > min_lines)
collapse(elt.id.substring(0, split));
}
}
function expandto(href) {
var start = href.indexOf("#")+1;
if (start != 0 && start != href.length) {
if (href.substring(start, href.length) != "-") {
collapse_all(4);
pos = href.indexOf(".", start);
while (pos != -1) {
var id = href.substring(start, pos);
expand(id);
pos = href.indexOf(".", pos+1);
}
var id = href.substring(start, href.length);
expand(id);
highlight(id);
}
}
}
function kill_doclink(id) {
var parent = document.getElementById(id);
parent.removeChild(parent.childNodes.item(0));
}
function auto_kill_doclink(ev) {
if (!ev) var ev = window.event;
if (!this.contains(ev.toElement)) {
var parent = document.getElementById(this.parentID);
parent.removeChild(parent.childNodes.item(0));
}
}
function doclink(id, name, targets_id) {
var elt = document.getElementById(id);
// If we already opened the box, then destroy it.
// (This case should never occur, but leave it in just in case.)
if (elt.childNodes.length > 1) {
elt.removeChild(elt.childNodes.item(0));
}
else {
// The outer box: relative + inline positioning.
var box1 = document.createElement("div");
box1.style.position = "relative";
box1.style.display = "inline";
box1.style.top = 0;
box1.style.left = 0;
// A shadow for fun
var shadow = document.createElement("div");
shadow.style.position = "absolute";
shadow.style.left = "-1.3em";
shadow.style.top = "-1.3em";
shadow.style.background = "#404040";
// The inner box: absolute positioning.
var box2 = document.createElement("div");
box2.style.position = "relative";
box2.style.border = "1px solid #a0a0a0";
box2.style.left = "-.2em";
box2.style.top = "-.2em";
box2.style.background = "white";
box2.style.padding = ".3em .4em .3em .4em";
box2.style.fontStyle = "normal";
box2.onmouseout=auto_kill_doclink;
box2.parentID = id;
// Get the targets
var targets_elt = document.getElementById(targets_id);
var targets = targets_elt.getAttribute("targets");
var links = "";
target_list = targets.split(",");
for (var i=0; i" +
target[0] + "";
}
// Put it all together.
elt.insertBefore(box1, elt.childNodes.item(0));
//box1.appendChild(box2);
box1.appendChild(shadow);
shadow.appendChild(box2);
box2.innerHTML =
"Which "+name+" do you want to see documentation for?" +
"
";
}
return false;
}
function get_anchor() {
var href = location.href;
var start = href.indexOf("#")+1;
if ((start != 0) && (start != href.length))
return href.substring(start, href.length);
}
function redirect_url(dottedName) {
// Scan through each element of the "pages" list, and check
// if "name" matches with any of them.
for (var i=0; i-m" or "-c";
// extract the portion & compare it to dottedName.
var pagename = pages[i].substring(0, pages[i].length-2);
if (pagename == dottedName.substring(0,pagename.length)) {
// We've found a page that matches `dottedName`;
// construct its URL, using leftover `dottedName`
// content to form an anchor.
var pagetype = pages[i].charAt(pages[i].length-1);
var url = pagename + ((pagetype=="m")?"-module.html":
"-class.html");
if (dottedName.length > pagename.length)
url += "#" + dottedName.substring(pagename.length+1,
dottedName.length);
return url;
}
}
}
AndroidViewClient-20.4.4/docs/exceptions.AssertionError-class.html 0000664 0000000 0000000 00000031035 14156000053 0025231 0 ustar 00root root 0000000 0000000
exceptions.AssertionError
You probably don't want to use this function. It exists mainly to be
used in Python's test suite.
typestr must be 'double' or 'float'. This function returns whichever
of 'unknown', 'IEEE, big-endian' or 'IEEE, little-endian' best describes
the format of floating point numbers used by the C type named by
typestr.
Returns: string
__hash__(x) (Hashing function)
hash(x)
Overrides:
object.__hash__
__new__(T,
S,
...)
Returns: a new object with type S, a subtype of T
Overrides:
object.__new__
__repr__(x) (Representation operator)
repr(x)
Overrides:
object.__repr__
__setformat__(float,
typestr,
fmt)
You probably don't want to use this function. It exists mainly to be
used in Python's test suite.
typestr must be 'double' or 'float'. fmt must be one of 'unknown',
'IEEE, big-endian' or 'IEEE, little-endian', and in addition can only be
one of the latter two if it appears to match the underlying C
reality.
Override the automatic determination of C-level floating point type.
This affects how floats are converted to and from binary strings.
Returns: None
__str__(x) (Informal representation operator)
str(x)
Overrides:
object.__str__
as_integer_ratio(float)
Return a pair of integers, whose ratio is exactly equal to the
original float and with a positive denominator. Raise OverflowError on
infinities and a ValueError on NaNs.
Create a floating-point number from a hexadecimal string. >>>
float.fromhex('0x1.ffffp10') 2047.984375 >>>
float.fromhex('-0x1p-1074') -4.9406564584124654e-324
Returns: float
hex(float)
Return a hexadecimal representation of a floating-point number.
>>> (-0.1).hex() '-0x1.999999999999ap-4' >>>
3.14159.hex() '0x1.921f9f01b866ep+1'
This document contains the API (Application Programming Interface)
documentation for this project. Documentation for the Python
objects defined by the project is divided into separate pages for each
package, module, and class. The API documentation also includes two
pages containing information about the project as a whole: a trees
page, and an index page.
Object Documentation
Each Package Documentation page contains:
A description of the package.
A list of the modules and sub-packages contained by the
package.
A summary of the classes defined by the package.
A summary of the functions defined by the package.
A summary of the variables defined by the package.
A detailed description of each function defined by the
package.
A detailed description of each variable defined by the
package.
Each Module Documentation page contains:
A description of the module.
A summary of the classes defined by the module.
A summary of the functions defined by the module.
A summary of the variables defined by the module.
A detailed description of each function defined by the
module.
A detailed description of each variable defined by the
module.
Each Class Documentation page contains:
A class inheritance diagram.
A list of known subclasses.
A description of the class.
A summary of the methods defined by the class.
A summary of the instance variables defined by the class.
A summary of the class (static) variables defined by the
class.
A detailed description of each method defined by the
class.
A detailed description of each instance variable defined by the
class.
A detailed description of each class (static) variable defined
by the class.
Project Documentation
The Trees page contains the module and class hierarchies:
The module hierarchy lists every package and module, with
modules grouped into packages. At the top level, and within each
package, modules and sub-packages are listed alphabetically.
The class hierarchy lists every class, grouped by base
class. If a class has more than one base class, then it will be
listed under each base class. At the top level, and under each base
class, classes are listed alphabetically.
The Index page contains indices of terms and
identifiers:
The term index lists every term indexed by any object's
documentation. For each term, the index provides links to each
place where the term is indexed.
The identifier index lists the (short) name of every package,
module, class, method, function, variable, and parameter. For each
identifier, the index provides a short description, and a link to
its documentation.
The Table of Contents
The table of contents occupies the two frames on the left side of
the window. The upper-left frame displays the project
contents, and the lower-left frame displays the module
contents:
Project Contents...
API Documentation Frame
Module Contents ...
The project contents frame contains a list of all packages
and modules that are defined by the project. Clicking on an entry
will display its contents in the module contents frame. Clicking on a
special entry, labeled "Everything," will display the contents of
the entire project.
The module contents frame contains a list of every
submodule, class, type, exception, function, and variable defined by a
module or package. Clicking on an entry will display its
documentation in the API documentation frame. Clicking on the name of
the module, at the top of the frame, will display the documentation
for the module itself.
The "frames" and "no frames" buttons below the top
navigation bar can be used to control whether the table of contents is
displayed or not.
The Navigation Bar
A navigation bar is located at the top and bottom of every page.
It indicates what type of page you are currently viewing, and allows
you to go to related pages. The following table describes the labels
on the navigation bar. Note that not some labels (such as
[Parent]) are not displayed on all pages.
Label
Highlighted when...
Links to...
[Parent]
(never highlighted)
the parent of the current package
[Package]
viewing a package
the package containing the current object
[Module]
viewing a module
the module containing the current object
[Class]
viewing a class
the class containing the current object
[Trees]
viewing the trees page
the trees page
[Index]
viewing the index page
the index page
[Help]
viewing the help page
the help page
The "show private" and "hide private" buttons below
the top navigation bar can be used to control whether documentation
for private objects is displayed. Private objects are usually defined
as objects whose (short) names begin with a single underscore, but do
not end with an underscore. For example, "_x",
"__pprint", and "epydoc.epytext._tokenize"
are private objects; but "re.sub",
"__init__", and "type_" are not. However,
if a module defines the "__all__" variable, then its
contents are used to decide which objects are private.
A timestamp below the bottom navigation bar indicates when each
page was last updated.
When javascript is enabled, this page will redirect URLs of
the form redirect.html#dotted.name to the
documentation for the object with the given fully-qualified
dotted name.
Copyright (C) 2012-2013 Diego Torres Milano
Created on Feb 2, 2012
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@author: Diego Torres Milano
SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED = False
Skips some classes related with the Action Bar and the
PhoneWindow$DecorView in the coordinates calculation
1# -*- coding: utf-8 -*- 2''' 3Copyright (C) 2012-2013 Diego Torres Milano 4Created on Feb 2, 2012 5 6Licensed under the Apache License, Version 2.0 (the "License"); 7you may not use this file except in compliance with the License. 8You may obtain a copy of the License at 9 10 http://www.apache.org/licenses/LICENSE-2.0 11 12Unless required by applicable law or agreed to in writing, software 13distributed under the License is distributed on an "AS IS" BASIS, 14WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15See the License for the specific language governing permissions and 16limitations under the License. 17 18@author: Diego Torres Milano 19''' 20 21__version__='3.2.0' 22 23importsys 24importsubprocess 25importre 26importsocket 27importos 28importjava 29importtypes 30importtime 31importsignal 32importwarnings 33importcopy 34importpickle 35importxml.parsers.expat 36importorg.python.modules.sre.PatternObject 37fromcom.android.monkeyrunnerimportMonkeyDevice,MonkeyRunner 38 39DEBUG=False 40DEBUG_DEVICE=DEBUGandFalse 41DEBUG_RECEIVED=DEBUGandFalse 42DEBUG_TREE=DEBUGandFalse 43DEBUG_GETATTR=DEBUGandFalse 44DEBUG_CALL=DEBUGandFalse 45DEBUG_COORDS=DEBUGandFalse 46DEBUG_TOUCH=DEBUGandFalse 47DEBUG_STATUSBAR=DEBUGandFalse 48DEBUG_WINDOWS=DEBUGandFalse 49DEBUG_BOUNDS=DEBUGandFalse 50DEBUG_DISTANCE=DEBUGandFalse 51 52WARNINGS=False 53 54VIEW_SERVER_HOST='localhost' 55VIEW_SERVER_PORT=4939 56 57ADB_DEFAULT_PORT=5555 58 59OFFSET=25 60''' This assumes the smallest touchable view on the screen is approximately 50px x 50px 61 and touches it at M{(x+OFFSET, y+OFFSET)} ''' 62 63USE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES=True 64''' Use monkeyrunner (C{MonkeyDevice.getProperty()}) to obtain the needed properties. If this is 65 C{False} then C{adb shell getprop} is used ''' 66 67SKIP_CERTAIN_CLASSES_IN_GET_XY_ENABLED=False 68''' Skips some classes related with the Action Bar and the PhoneWindow$DecorView in the 69 coordinates calculation 70 @see: L{View.getXY()} ''' 71 72# some device properties 73VERSION_SDK_PROPERTY='version.sdk' 74 75# some constants for the attributes 76ID_PROPERTY='mID' 77ID_PROPERTY_UI_AUTOMATOR='uniqueId' 78TEXT_PROPERTY='text:mText' 79TEXT_PROPERTY_API_10='mText' 80TEXT_PROPERTY_UI_AUTOMATOR='text' 81WS="\xfe"# the whitespace replacement char for TEXT_PROPERTY 82LEFT_PROPERTY='layout:mLeft' 83LEFT_PROPERTY_API_8='mLeft' 84TOP_PROPERTY='layout:mTop' 85TOP_PROPERTY_API_8='mTop' 86WIDTH_PROPERTY='layout:getWidth()' 87WIDTH_PROPERTY_API_8='getWidth()' 88HEIGHT_PROPERTY='layout:getHeight()' 89HEIGHT_PROPERTY_API_8='getHeight()' 90GET_VISIBILITY_PROPERTY='getVisibility()' 91LAYOUT_TOP_MARGIN_PROPERTY='layout:layout_topMargin' 92 93# visibility 94VISIBLE=0x0 95INVISIBLE=0x4 96GONE=0x8 97 98IP_RE=re.compile('^(\d{1,3}\.){3}\d{1,3}$') 99ID_RE=re.compile('id/([^/]*)(/(\d+))?')
114''' 115 NOTICE: this is using a non-greedy (or minimal) regex 116 117 @type name: str 118 @param name: the name used to tag the expression 119 @type greedy: bool 120 @param greedy: Whether the regex is greedy or not 121 122 @return: Returns a named string regex (only non-whitespace characters allowed) 123 ''' 124return'(?P<%s>\S+%s)'%(name,''ifgreedyelse'?')
182ifisinstance(value,org.python.modules.sre.PatternObject): 183msg="Couldn't find View with %s that matches '%s' in tree with root=%s"%(attr,value.pattern,root) 184else: 185msg="Couldn't find View with %s='%s' in tree with root=%s"%(attr,value,root) 186super(Exception,self).__init__(msg)
211''' 212 Constructor 213 214 @type map: map 215 @param map: the map containing the (attribute, value) pairs 216 @type device: MonkeyDevice 217 @param device: the device containing this View 218 @type version: int 219 @param version: the Android SDK version number of the platform where this View belongs. If 220 this is C{-1} then the Android SDK version will be obtained in this 221 constructor. 222 @type forceviewserveruse: boolean 223 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions were given 224 to use C{UiAutomator}. 225 ''' 226 227self.map=map 228''' The map that contains the C{attr},C{value} pairs ''' 229self.device=device 230''' The MonkeyDevice ''' 231self.children=[] 232''' The children of this View ''' 233self.parent=None 234''' The parent of this View ''' 235self.windows={} 236self.currentFocus=None 237''' The current focus ''' 238self.build={} 239''' Build properties ''' 240 241ifversion!=-1: 242self.build[VERSION_SDK_PROPERTY]=version 243else: 244try: 245ifUSE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES: 246self.build[VERSION_SDK_PROPERTY]=int(device.getProperty('build.'+VERSION_SDK_PROPERTY)) 247else: 248self.build[VERSION_SDK_PROPERTY]=int(device.shell('getprop ro.build.'+VERSION_SDK_PROPERTY)[:-2]) 249except: 250self.build[VERSION_SDK_PROPERTY]=-1 251 252version=self.build[VERSION_SDK_PROPERTY] 253self.useUiAutomator=(version>=16)andnotforceviewserveruse 254''' Whether to use UIAutomator or ViewServer ''' 255self.idProperty=None 256''' The id property depending on the View attribute format ''' 257self.textProperty=None 258''' The text property depending on the View attribute format ''' 259self.leftProperty=None 260''' The left property depending on the View attribute format ''' 261self.topProperty=None 262''' The top property depending on the View attribute format ''' 263self.widthProperty=None 264''' The width property depending on the View attribute format ''' 265self.heightProperty=None 266''' The height property depending on the View attribute format ''' 267ifversion>=16andself.useUiAutomator: 268self.idProperty=ID_PROPERTY_UI_AUTOMATOR 269self.textProperty=TEXT_PROPERTY_UI_AUTOMATOR 270self.leftProperty=LEFT_PROPERTY 271self.topProperty=TOP_PROPERTY 272self.widthProperty=WIDTH_PROPERTY 273self.heightProperty=HEIGHT_PROPERTY 274elifversion>10and(version<16orself.useUiAutomator): 275self.idProperty=ID_PROPERTY 276self.textProperty=TEXT_PROPERTY 277self.leftProperty=LEFT_PROPERTY 278self.topProperty=TOP_PROPERTY 279self.widthProperty=WIDTH_PROPERTY 280self.heightProperty=HEIGHT_PROPERTY 281elifversion==10: 282self.idProperty=ID_PROPERTY 283self.textProperty=TEXT_PROPERTY_API_10 284self.leftProperty=LEFT_PROPERTY 285self.topProperty=TOP_PROPERTY 286self.widthProperty=WIDTH_PROPERTY 287self.heightProperty=HEIGHT_PROPERTY 288elifversion>=7andversion<10: 289self.idProperty=ID_PROPERTY 290self.textProperty=TEXT_PROPERTY_API_10 291self.leftProperty=LEFT_PROPERTY_API_8 292self.topProperty=TOP_PROPERTY_API_8 293self.widthProperty=WIDTH_PROPERTY_API_8 294self.heightProperty=HEIGHT_PROPERTY_API_8 295elifversion>0andversion<7: 296self.idProperty=ID_PROPERTY 297self.textProperty=TEXT_PROPERTY_API_10 298self.leftProperty=LEFT_PROPERTY 299self.topProperty=TOP_PROPERTY 300self.widthProperty=WIDTH_PROPERTY 301self.heightProperty=HEIGHT_PROPERTY 302elifversion==-1: 303self.idProperty=ID_PROPERTY 304self.textProperty=TEXT_PROPERTY 305self.leftProperty=LEFT_PROPERTY 306self.topProperty=TOP_PROPERTY 307self.widthProperty=WIDTH_PROPERTY 308self.heightProperty=HEIGHT_PROPERTY 309else: 310self.idProperty=ID_PROPERTY 311self.textProperty=TEXT_PROPERTY 312self.leftProperty=LEFT_PROPERTY 313self.topProperty=TOP_PROPERTY 314self.widthProperty=WIDTH_PROPERTY 315self.heightProperty=HEIGHT_PROPERTY
321ifDEBUG_GETATTR: 322print>>sys.stderr,"__getattr__(%s) version: %d"%(name,self.build[VERSION_SDK_PROPERTY]) 323 324# NOTE: 325# I should try to see if 'name' is a defined method 326# but it seems that if I call locals() here an infinite loop is entered 327 328ifself.map.has_key(name): 329r=self.map[name] 330elifself.map.has_key(name+'()'): 331# the method names are stored in the map with their trailing '()' 332r=self.map[name+'()'] 333elifname.count("_")>0: 334mangledList=self.allPossibleNamesWithColon(name) 335mangledName=self.intersection(mangledList,self.map.keys()) 336iflen(mangledName)>0andself.map.has_key(mangledName[0]): 337r=self.map[mangledName[0]] 338else: 339# Default behavior 340raiseAttributeError,name 341else: 342# try removing 'is' prefix 343ifDEBUG_GETATTR: 344print>>sys.stderr," __getattr__: trying without 'is' prefix" 345suffix=name[2:].lower() 346ifself.map.has_key(suffix): 347r=self.map[suffix] 348else: 349# Default behavior 350raiseAttributeError,name 351 352# if the method name starts with 'is' let's assume its return value is boolean 353# if name[:2] == 'is': 354# r = True if r == 'true' else False 355ifr=='true': 356r=True 357elifr=='false': 358r=False 359 360# this should not cached in some way 361definnerMethod(): 362ifDEBUG_GETATTR: 363print>>sys.stderr,"innerMethod: %s returning %s"%(innerMethod.__name__,r) 364returnr
365 366innerMethod.__name__=name 367 368# this should work, but then there's problems with the arguments of innerMethod 369# even if innerMethod(self) is added 370#setattr(View, innerMethod.__name__, innerMethod) 371#setattr(self, innerMethod.__name__, innerMethod) 372 373returninnerMethod
380''' 381 Gets the L{View} class 382 383 @return: the L{View} class or C{None} if not defined 384 ''' 385 386try: 387returnself.map['class'] 388except: 389returnNone
392''' 393 Gets the L{View} Id 394 395 @return: the L{View} C{Id} or C{None} if not defined 396 @see: L{getUniqueId()} 397 ''' 398 399try: 400returnself.map[self.idProperty] 401except: 402returnNone
422''' 423 Gets the text attribute. 424 425 @return: the text attribute or C{None} if not defined 426 ''' 427 428try: 429returnself.map[self.textProperty] 430exceptException: 431returnNone
460''' 461 Gets the unique Id of this View. 462 463 @see: L{ViewClient.__splitAttrs()} for a discussion on B{Unique Ids} 464 ''' 465 466try: 467returnself.map['uniqueId'] 468except: 469returnNone
630''' 631 Gets the position and size (X,Y, W, H) 632 633 @return: A tuple containing the View's coordinates (X, Y, W, H) 634 ''' 635 636(x,y)=self.getXY(); 637w=self.getWidth() 638h=self.getHeight() 639return(x,y,w,h)
841''' 842 Write the View image to the specified filename in the specified format. 843 844 @type filename: str 845 @param filename: Absolute path and optional filename receiving the image. If this points to 846 a directory, then the filename is determined by this View unique ID and 847 format extension. 848 @type format: str 849 @param format: Image format (default format is PNG) 850 ''' 851 852ifnotos.path.isabs(filename): 853raiseValueError("writeImageToFile expects an absolute path") 854ifos.path.isdir(filename): 855filename=os.path.join(filename,self.variableNameFromId()+'.'+format.lower()) 856ifDEBUG: 857print>>sys.stderr,"writeImageToFile: saving image to '%s' in %s format"%(filename,format) 858self.device.takeSnapshot().getSubImage(self.getPositionAndSize()).writeToFile(filename,format)
954''' 955 Expat start element event handler 956 ''' 957ifname=='hierarchy': 958pass 959elifname=='node': 960# Instantiate an Element object 961attributes['uniqueId']='id/no_id/%d'%self.idCount 962bounds=re.split('[\][,]',attributes['bounds']) 963attributes['bounds']=((int(bounds[1]),int(bounds[2])),(int(bounds[4]),int(bounds[5]))) 964ifDEBUG_BOUNDS: 965print>>sys.stderr,"bounds=",attributes['bounds'] 966self.idCount+=1 967child=View.factory(attributes,self.device,self.version) 968self.views.append(child) 969# Push element onto the stack and make it a child of parent 970ifnotself.nodeStack: 971self.root=child 972else: 973self.parent=self.nodeStack[-1] 974self.parent.add(child) 975self.nodeStack.append(child)
998# Create an Expat parser 999parser=xml.parsers.expat.ParserCreate()1000# Set the Expat event handlers to our methods1001parser.StartElementHandler=self.StartElement1002parser.EndElementHandler=self.EndElement1003parser.CharacterDataHandler=self.CharacterData1004# Parse the XML File1005try:1006parserStatus=parser.Parse(uiautomatorxml,1)1007exceptxml.parsers.expat.ExpatError,ex:1008print>>sys.stderr,"ERROR: Offending XML:\n",repr(uiautomatorxml)1009raiseRuntimeError(ex)1010returnself.root
1036'''1037 Expat character data event handler1038 '''10391040ifdata.strip():1041data=data.encode()1042ifnotself.data:1043self.data=data1044else:1045self.data+=data
1048# Create an Expat parser1049parser=xml.parsers.expat.ParserCreate()1050# Set the Expat event handlers to our methods1051parser.StartElementHandler=self.StartElement1052parser.EndElementHandler=self.EndElement1053parser.CharacterDataHandler=self.CharacterData1054# Parse the XML1055parserStatus=parser.Parse(excerpt,1)1056returnself.data
1059'''1060 ViewClient is a I{ViewServer} client.10611062 ViewServer backend1063 ==================1064 If not running the ViewServer is started on the target device or emulator and then the port1065 mapping is created.10661067 UiAutomator backend1068 ===================1069 No service is started.1070 '''1071
1073'''1074 Constructor10751076 @type device: MonkeyDevice1077 @param device: The device running the C{View server} to which this client will connect1078 @type serialno: str1079 @param serialno: the serial number of the device or emulator to connect to1080 @type adb: str1081 @param adb: the path of the C{adb} executable or None and C{ViewClient} will try to find it1082 @type autodump: boolean1083 @param autodump: whether an automatic dump is performed at the end of this constructor1084 @type forceviewserveruse: boolean1085 @param forceviewserveruse: Force the use of C{ViewServer} even if the conditions to use1086 C{UiAutomator} are satisfied 1087 @type localport: int1088 @param localport: the local port used in the redirection1089 @type remoteport: int1090 @param remoteport: the remote port used to start the C{ViewServer} in the device or1091 emulator1092 @type startviewserver: boolean1093 @param startviewserver: Whether to start the B{global} ViewServer1094 @type ignoreuiautomatorkilled: boolean1095 @param ignoreuiautomatorkilled: Ignores received B{Killed} message from C{uiautomator}1096 '''10971098ifnotdevice:1099raiseException('Device is not connected')1100self.device=device1101''' The C{MonkeyDevice} device instance '''11021103ifnotserialno:1104raiseValueError("Serialno cannot be None")1105self.serialno=self.__mapSerialNo(serialno)1106''' The serial number of the device '''11071108ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: using device with serialno",self.serialno11091110ifadb:1111ifnotos.access(adb,os.X_OK):1112raiseException('adb="%s" is not executable'%adb)1113else:1114adb=ViewClient.__obtainAdbPath()11151116self.adb=adb1117''' The adb command '''1118self.root=None1119''' The root node '''1120self.viewsById={}1121''' The map containing all the L{View}s indexed by their L{View.getUniqueId()} '''1122self.display={}1123''' The map containing the device's display properties: width, height and density '''1124forpropin['width','height','density']:1125self.display[prop]=-11126ifUSE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES:1127try:1128self.display[prop]=int(device.getProperty('display.'+prop))1129except:1130ifWARNINGS:1131warnings.warn("Couldn't determine display %s"%prop)1132else:1133# these values are usually not defined as properties, so we stick to the -1 set1134# before1135pass11361137self.build={}1138''' The map containing the device's build properties: version.sdk, version.release '''1139forpropin[VERSION_SDK_PROPERTY,'version.release']:1140self.build[prop]=-11141try:1142ifUSE_MONKEYRUNNER_TO_GET_BUILD_PROPERTIES:1143self.build[prop]=device.getProperty('build.'+prop)1144else:1145self.build[prop]=device.shell('getprop ro.build.'+prop)[:-2]1146except:1147ifWARNINGS:1148warnings.warn("Couldn't determine build %s"%prop)11491150ifprop==VERSION_SDK_PROPERTY:1151# we expect it to be an int1152self.build[prop]=int(self.build[prop]ifself.build[prop]else-1)11531154self.ro={}1155''' The map containing the device's ro properties: secure, debuggable '''1156forpropin['secure','debuggable']:1157try:1158self.ro[prop]=device.shell('getprop ro.'+prop)[:-2]1159except:1160ifWARNINGS:1161warnings.warn("Couldn't determine ro %s"%prop)1162self.ro[prop]='UNKNOWN'11631164self.forceViewServerUse=forceviewserveruse1165''' Force the use of ViewServer even if the conditions to use UiAutomator are satisfied '''1166self.useUiAutomator=(self.build[VERSION_SDK_PROPERTY]>=16)andnotforceviewserveruse# jelly bean 4.1 & 4.21167''' If UIAutomator is supported by the device it will be used '''1168self.ignoreUiAutomatorKilled=ignoreuiautomatorkilled1169''' On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed just after generating1170 the dump file. In many cases the file is already complete so we can ask to ignore the 'Killed'1171 message by setting L{ignoreuiautomatorkilled} to C{True}.11721173 Changes in 2.3.21 that uses C{/dev/tty} instead of a file may have turned this variable1174 unnnecessary, however it has been kept for backward compatibility.1175 '''11761177ifself.useUiAutomator:1178self.textProperty=TEXT_PROPERTY_UI_AUTOMATOR1179else:1180ifself.build[VERSION_SDK_PROPERTY]<=10:1181self.textProperty=TEXT_PROPERTY_API_101182else:1183self.textProperty=TEXT_PROPERTY1184ifstartviewserver:1185ifnotself.serviceResponse(device.shell('service call window 3')):1186try:1187self.assertServiceResponse(device.shell('service call window 1 i32 %d'%1188remoteport))1189except:1190msg='Cannot start View server.\n' \ 1191'This only works on emulator and devices running developer versions.\n' \ 1192'Does hierarchyviewer work on your device?\n' \ 1193'See https://github.com/dtmilano/AndroidViewClient/wiki/Secure-mode\n\n' \ 1194'Device properties:\n' \ 1195' ro.secure=%s\n' \ 1196' ro.debuggable=%s\n'%(self.ro['secure'],self.ro['debuggable'])1197raiseException(msg)11981199self.localPort=localport1200self.remotePort=remoteport1201# FIXME: it seems there's no way of obtaining the serialno from the MonkeyDevice1202subprocess.check_call([self.adb,'-s',self.serialno,'forward','tcp:%d'%self.localPort,1203'tcp:%d'%self.remotePort])12041205self.windows=None1206''' The list of windows as obtained by L{ViewClient.list()} '''12071208ifautodump:1209self.dump()
1217'''1218 Obtains the ADB path attempting know locations for different OSs1219 '''12201221osName=java.lang.System.getProperty('os.name')1222isWindows=False1223ifosName.startswith('Windows'):1224adb='adb.exe'1225isWindows=True1226else:1227adb='adb'12281229ANDROID_HOME=os.environ['ANDROID_HOME']ifos.environ.has_key('ANDROID_HOME')else'/opt/android-sdk'1230HOME=os.environ['HOME']ifos.environ.has_key('HOME')else''12311232possibleChoices=[os.path.join(ANDROID_HOME,'platform-tools',adb),1233os.path.join(HOME,"android",'platform-tools',adb),1234os.path.join(HOME,"android-sdk",'platform-tools',adb),1235adb,1236]12371238ifosName.startswith('Windows'):1239possibleChoices.append(os.path.join("""C:\Program Files\Android\android-sdk\platform-tools""",adb))1240possibleChoices.append(os.path.join("""C:\Program Files (x86)\Android\android-sdk\platform-tools""",adb))1241elifosName.startswith('Linux'):1242possibleChoices.append(os.path.join("opt","android-sdk-linux",'platform-tools',adb))1243possibleChoices.append(os.path.join(HOME,"opt","android-sdk-linux",'platform-tools',adb))1244possibleChoices.append(os.path.join(HOME,"android-sdk-linux",'platform-tools',adb))1245elifosName.startswith('Mac'):1246possibleChoices.append(os.path.join("opt","android-sdk-mac_x86",'platform-tools',adb))1247possibleChoices.append(os.path.join(HOME,"opt","android-sdk-mac",'platform-tools',adb))1248possibleChoices.append(os.path.join(HOME,"android-sdk-mac",'platform-tools',adb))1249possibleChoices.append(os.path.join(HOME,"opt","android-sdk-mac_x86",'platform-tools',adb))1250possibleChoices.append(os.path.join(HOME,"android-sdk-mac_x86",'platform-tools',adb))1251else:1252# Unsupported OS1253pass12541255forexeFileinpossibleChoices:1256ifos.access(exeFile,os.X_OK):1257returnexeFile12581259forpathinos.environ["PATH"].split(os.pathsep):1260exeFile=os.path.join(path,adb)1261ifexeFile!=Noneandos.access(exeFile,os.X_OKifnotisWindowselseos.F_OK):1262returnexeFile12631264raiseException('adb="%s" is not executable. Did you forget to set ANDROID_HOME in the environment?'%adb)
1268serialno=serialno.strip()1269#ipRE = re.compile('^\d+\.\d+.\d+.\d+$')1270ifIP_RE.match(serialno):1271ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: adding default port to serialno",serialno,ADB_DEFAULT_PORT1272returnserialno+':%d'%ADB_DEFAULT_PORT12731274ipPortRE=re.compile('^\d+\.\d+.\d+.\d+:\d+$')1275ifipPortRE.match(serialno):1276# nothing to map1277returnserialno12781279ifre.search("[.*()+]",serialno):1280raiseValueError("Regular expression not supported as serialno in ViewClient")12811282returnserialno
1286ifDEBUG_DEVICE:print>>sys.stderr,"ViewClient: obtaining serial number for connected device"1287serialno=device.getProperty('ro.serialno')1288ifnotserialno:1289serialno=device.shell('getprop ro.serialno')1290ifserialno:1291serialno=serialno[:-2]1292ifnotserialno:1293qemu=device.shell('getprop ro.kernel.qemu')1294ifqemu:1295qemu=qemu[:-2]1296ifqemuandint(qemu)==1:1297# FIXME !!!!!1298# this must be calculated from somewhere, though using a fixed serialno for now1299warnings.warn("Running on emulator but no serial number was specified then 'emulator-5554' is used")1300serialno='emulator-5554'1301ifnotserialno:1302# If there's only one device connected get its serialno1303adb=ViewClient.__obtainAdbPath()1304ifDEBUG_DEVICE:print>>sys.stderr," using adb=%s"%adb1305s=subprocess.Popen([adb,'get-serialno'],stdout=subprocess.PIPE,stderr=subprocess.PIPE,env={}).communicate()[0][:-1]1306ifs!='unknown':1307serialno=s1308ifDEBUG_DEVICE:print>>sys.stderr," serialno=%s"%serialno1309ifnotserialno:1310warnings.warn("Couldn't obtain the serialno of the connected device")1311returnserialno
1315osName=java.lang.System.getProperty('os.name')1316ifosName.startswith('Windows'):# alarm is not implemented in Windows1317return1318signal.alarm(timeout)
1322'''1323 Connects to a device which serial number is obtained from the script arguments if available1324 or using the default regex C{.*}.13251326 If the connection is not successful the script exits.1327 L{MonkeyRunner.waitForConnection()} returns a L{MonkeyDevice} even if the connection failed.1328 Then, to detect this situation, C{device.wake()} is attempted and if it fails then it is1329 assumed the previous connection failed.13301331 @type timeout: int1332 @param timeout: timeout for the connection1333 @type verbose: bool1334 @param verbose: Verbose output1335 @type ignoresecuredevice: bool1336 @param ignoresecuredevice: Ignores the check for a secure device1337 @type serialno: str1338 @param serialno: The device or emulator serial number 13391340 @return: the device and serialno used for the connection1341 '''13421343progname=os.path.basename(sys.argv[0])1344ifserialnoisNone:1345# eat all the extra options the invoking script may have added1346args=sys.argv1347whilelen(args)>1andargs[1][0]=='-':1348args.pop(1)1349serialno=args[1]iflen(args)>1else \ 1350os.environ['ANDROID_SERIAL']ifos.environ.has_key('ANDROID_SERIAL') \ 1351else'.*'1352ifIP_RE.match(serialno):1353# If matches an IP address format and port was not specified add the default1354serialno+=':%d'%ADB_DEFAULT_PORT1355ifverbose:1356print>>sys.stderr,'Connecting to a device with serialno=%s with a timeout of %d secs...'% \ 1357(serialno,timeout)1358# Sometimes MonkeyRunner doesn't even timeout (i.e. two connections from same process), so let's1359# handle it here1360ViewClient.setAlarm(timeout+5)1361device=MonkeyRunner.waitForConnection(timeout,serialno)1362ViewClient.setAlarm(0)1363try:1364device.wake()1365exceptjava.lang.NullPointerException,e:1366print>>sys.stderr,"%s: ERROR: Couldn't connect to %s: %s"%(progname,serialno,e)1367sys.exit(3)1368ifverbose:1369print>>sys.stderr,'Connected to device with serialno=%s'%serialno1370secure=device.getSystemProperty('ro.secure')1371debuggable=device.getSystemProperty('ro.debuggable')1372versionProperty=device.getProperty('build.'+VERSION_SDK_PROPERTY)1373ifversionProperty:1374version=int(versionProperty)1375else:1376ifverbose:1377print"Couldn't obtain device SDK version"1378version=-113791380# we are going to use UiAutomator for versions >= 16 that's why we ignore if the device1381# is secure if this is true1382ifsecure=='1'anddebuggable=='0'andnotignoresecuredeviceandversion<16:1383print>>sys.stderr,"%s: ERROR: Device is secure, AndroidViewClient won't work."%progname1384ifverbose:1385print>>sys.stderr," secure=%s debuggable=%s version=%d ignoresecuredevice=%s"% \ 1386(secure,debuggable,version,ignoresecuredevice)1387sys.exit(2)1388ifre.search("[.*()+]",serialno)andnotre.search("(\d{1,3}\.){3}\d{1,3}",serialno):1389# if a regex was used we have to determine the serialno used1390serialno=ViewClient.__obtainDeviceSerialNumber(device)1391ifverbose:1392print>>sys.stderr,'Actual device serialno=%s'%serialno1393returndevice,serialno
1397'''1398 Shows the View class, id and text if available.1399 This function can be used as a transform function to L{ViewClient.traverse()}14001401 @type view: I{View}1402 @param view: the View1403 @type extraInfo: method1404 @param extraInfo: the View method to add extra info1405 @type noextrainfo: bool1406 @param noextrainfo: Don't add extra info14071408 @return: the string containing class, id, and text if available 1409 '''14101411try:1412eis=''1413ifextraInfo:1414eis=extraInfo(view).__str__()1415ifnoteisandnoextrainfo:1416eis=noextrainfo1417ifeis:1418eis=' '+eis1419return"%s %s %s%s"%(view.getClass(),view.getId(),view.getText(),eis)1420exceptException,e:1421return"Exception in view=%s: %s"%(view.__smallStr__(),e)
1425'''1426 Shows the View class, id, text if available and unique id.1427 This function can be used as a transform function to L{ViewClient.traverse()}14281429 @type view: I{View}1430 @param view: the View1431 @return: the string containing class, id, and text if available and unique Id1432 '''14331434returnViewClient.traverseShowClassIdAndText(view,View.getUniqueId)
1438'''1439 Shows the View class, id, text if available and unique id.1440 This function can be used as a transform function to L{ViewClient.traverse()}14411442 @type view: I{View}1443 @param view: the View1444 @return: the string containing class, id, and text if available and the content description1445 '''14461447returnViewClient.traverseShowClassIdAndText(view,View.getContentDescription,'NAF')
1451'''1452 Shows the View class, id and text if available.1453 This function can be used as a transform function to L{ViewClient.traverse()}14541455 @type view: I{View}1456 @param view: the View1457 @return: the string containing class, id, and text if available 1458 '''14591460returnViewClient.traverseShowClassIdAndText(view,View.getCenter)
1464'''1465 Shows the View class, id and text if available.1466 This function can be used as a transform function to L{ViewClient.traverse()}14671468 @type view: I{View}1469 @param view: the View1470 @return: the string containing class, id, and text if available 1471 '''14721473returnViewClient.traverseShowClassIdAndText(view,View.getPositionAndSize)
14741475# methods that can be used to transform ViewClient.traverse output1476TRAVERSE_CIT=traverseShowClassIdAndText1477''' An alias for L{traverseShowClassIdAndText(view)} '''1478TRAVERSE_CITUI=traverseShowClassIdTextAndUniqueId1479''' An alias for L{traverseShowClassIdTextAndUniqueId(view)} '''1480TRAVERSE_CITCD=traverseShowClassIdTextAndContentDescription1481''' An alias for L{traverseShowClassIdTextAndContentDescription(view)} '''1482TRAVERSE_CITC=traverseShowClassIdTextAndCenter1483''' An alias for L{traverseShowClassIdTextAndCenter(view)} '''1484TRAVERSE_CITPS=traverseShowClassIdTextPositionAndSize1485''' An alias for L{traverseShowClassIdTextPositionAndSize(view)} '''14861487@staticmethod
1498'''1499 Checks whether the response received from the server is correct or raises and Exception.15001501 @type response: str1502 @param response: Response received from the server15031504 @raise Exception: If the response received from the server is invalid1505 '''15061507ifnotself.serviceResponse(response):1508raiseException('Invalid response received from service.')
1511'''1512 Checks the response received from the I{ViewServer}.15131514 @return: C{True} if the response received matches L{PARCEL_TRUE}, C{False} otherwise1515 '''15161517PARCEL_TRUE="Result: Parcel(00000000 00000001 '........')\r\n"1518''' The TRUE response parcel '''1519ifDEBUG:1520print>>sys.stderr,"serviceResponse: comparing '%s' vs Parcel(%s)"%(response,PARCEL_TRUE)1521returnresponse==PARCEL_TRUE
1524'''1525 Sets L{self.views} to the received value splitting it into lines.15261527 @type received: str1528 @param received: the string received from the I{View Server}1529 '''15301531ifnotreceivedorreceived=="":1532raiseValueError("received is empty")1533self.views=[]1534''' 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()}. '''1535self.__parseTree(received.split("\n"))1536ifDEBUG:1537print>>sys.stderr,"there are %d views in this dump"%len(self.views)
1540'''1541 Sets L{self.views} to the received value parsing the received XML.15421543 @type received: str1544 @param received: the string received from the I{UI Automator}1545 '''15461547ifnotreceivedorreceived=="":1548raiseValueError("received is empty")1549self.views=[]1550''' 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()}. '''1551self.__parseTreeFromUiAutomatorDump(received)1552ifDEBUG:1553print>>sys.stderr,"there are %d views in this dump"%len(self.views)
1557'''1558 Splits the C{View} attributes in C{strArgs} and optionally adds the view id to the C{viewsById} list.15591560 Unique Ids1561 ==========1562 It is very common to find C{View}s having B{NO_ID} as the Id. This turns very difficult to 1563 use L{self.findViewById()}. To help in this situation this method assigns B{unique Ids}.15641565 The B{unique Ids} are generated using the pattern C{id/no_id/<number>} with C{<number>} starting1566 at 1.15671568 @type strArgs: str1569 @param strArgs: the string containing the raw list of attributes and values15701571 @return: Returns the attributes map.1572 '''15731574ifself.useUiAutomator:1575raiseRuntimeError("This method is not compatible with UIAutomator")1576# replace the spaces in text:mText to preserve them in later split1577# they are translated back after the attribute matches1578textRE=re.compile('%s=%s,'%(self.textProperty,__nd('len')))1579m=textRE.search(strArgs)1580ifm:1581__textStart=m.end()1582__textLen=int(m.group('len'))1583__textEnd=m.end()+__textLen1584s1=strArgs[__textStart:__textEnd]1585s2=s1.replace(' ',WS)1586strArgs=strArgs.replace(s1,s2,1)15871588idRE=re.compile("(?P<viewId>id/\S+)")1589attrRE=re.compile('%s(?P<parens>\(\))?=%s,(?P<val>[^ ]*)'%(__ns('attr'),__nd('len')),flags=re.DOTALL)1590hashRE=re.compile('%s@%s'%(__ns('class'),__nh('oid')))15911592attrs={}1593viewId=None1594m=idRE.search(strArgs)1595ifm:1596viewId=m.group('viewId')1597ifDEBUG:1598print>>sys.stderr,"found view with id=%s"%viewId15991600forattrinstrArgs.split():1601m=attrRE.match(attr)1602ifm:1603__attr=m.group('attr')1604__parens='()'ifm.group('parens')else''1605__len=int(m.group('len'))1606__val=m.group('val')1607ifWARNINGSand__len!=len(__val):1608warnings.warn("Invalid len: expected: %d found: %d s=%s e=%s"%(__len,len(__val),__val[:50],__val[-50:]))1609if__attr==self.textProperty:1610# restore spaces that have been replaced1611__val=__val.replace(WS,' ')1612attrs[__attr+__parens]=__val1613else:1614m=hashRE.match(attr)1615ifm:1616attrs['class']=m.group('class')1617attrs['oid']=m.group('oid')1618else:1619ifDEBUG:1620print>>sys.stderr,attr,"doesn't match"16211622ifTrue:# was assignViewById1623ifnotviewId:1624# If the view has NO_ID we are assigning a default id here (id/no_id) which is1625# immediately incremented if another view with no id was found before to generate1626# a unique id1627viewId="id/no_id/1"1628ifviewIdinself.viewsById:1629# sometimes the view ids are not unique, so let's generate a unique id here1630i=11631whileTrue:1632newId=re.sub('/\d+$','',viewId)+'/%d'%i1633ifnotnewIdinself.viewsById:1634break1635i+=11636viewId=newId1637ifDEBUG:1638print>>sys.stderr,"adding viewById %s"%viewId1639# We are assigning a new attribute to keep the original id preserved, which could have1640# been NO_ID repeated multiple times1641attrs['uniqueId']=viewId16421643returnattrs
1646'''1647 Parses the View tree contained in L{receivedLines}. The tree is created and the root node assigned to L{self.root}.1648 This method also assigns L{self.viewsById} values using L{View.getUniqueId} as the key.16491650 @type receivedLines: str1651 @param receivedLines: the string received from B{View Server}1652 '''16531654self.root=None1655self.viewsById={}1656self.views=[]1657parent=None1658parents=[]1659treeLevel=-11660newLevel=-11661lastView=None1662forvinreceivedLines:1663ifv==''orv=='DONE'orv=='DONE.':1664break1665attrs=self.__splitAttrs(v)1666ifnotself.root:1667ifv[0]==' ':1668raiseException("Unexpected root element starting with ' '.")1669self.root=View.factory(attrs,self.device,self.build[VERSION_SDK_PROPERTY],self.forceViewServerUse)1670ifDEBUG:self.root.raw=v1671treeLevel=01672newLevel=01673lastView=self.root1674parent=self.root1675parents.append(parent)1676else:1677newLevel=(len(v)-len(v.lstrip()))1678ifnewLevel==0:1679raiseException("newLevel==0 treeLevel=%d but tree can have only one root, v=%s"%(treeLevel,v))1680child=View.factory(attrs,self.device,self.build[VERSION_SDK_PROPERTY],self.forceViewServerUse)1681ifDEBUG:child.raw=v1682ifnewLevel==treeLevel:1683parent.add(child)1684lastView=child1685elifnewLevel>treeLevel:1686if(newLevel-treeLevel)!=1:1687raiseException("newLevel jumps %d levels, v=%s"%((newLevel-treeLevel),v))1688parent=lastView1689parents.append(parent)1690parent.add(child)1691lastView=child1692treeLevel=newLevel1693else:# newLevel < treeLevel1694foriinrange(treeLevel-newLevel):1695parents.pop()1696parent=parents.pop()1697parents.append(parent)1698parent.add(child)1699treeLevel=newLevel1700lastView=child1701self.views.append(lastView)1702self.viewsById[lastView.getUniqueId()]=lastView
1721'''1722 Traverses the C{View} tree and prints its nodes.17231724 The nodes are printed converting them to string but other transformations can be specified1725 by providing a method name as the C{transform} parameter.17261727 @type root: L{View}1728 @param root: the root node from where the traverse starts1729 @type indent: str1730 @param indent: the indentation string to use to print the nodes1731 @type transform: method1732 @param transform: a method to use to transform the node before is printed 1733 '''17341735iftype(root)==types.StringTypeandroot=="ROOT":1736root=self.root17371738returnViewClient.__traverse(root,indent,transform,stream)
1739# if not root:1740# return1741# 1742# s = transform(root)1743# if s:1744# print >>stream, "%s%s" % (indent, s)1745# 1746# for ch in root.children:1747# self.traverse(ch, indent=indent+" ", transform=transform, stream=stream)17481749@staticmethod
1764'''1765 Dumps the window content.17661767 Sleep is useful to wait some time before obtaining the new content when something in the1768 window has changed.17691770 @type window: int or str1771 @param window: the window id or name of the window to dump.1772 The B{name} is the package name or the window name (i.e. StatusBar) for1773 system windows.1774 The window id can be provided as C{int} or C{str}. The C{str} should represent1775 and C{int} in either base 10 or 16.1776 Use -1 to dump all windows.1777 This parameter only is used when the backend is B{ViewServer} and it's1778 ignored for B{UiAutomator}.1779 @type sleep: int1780 @param sleep: sleep in seconds before proceeding to dump the content17811782 @return: the list of Views as C{str} received from the server after being split into lines1783 '''17841785ifsleep>0:1786MonkeyRunner.sleep(sleep)17871788ifself.useUiAutomator:1789# NOTICE:1790# Using /dev/tty this works even on devices with no sdcard1791received=self.device.shell('uiautomator dump /dev/tty >/dev/null')1792ifnotreceived:1793raiseRuntimeError('ERROR: Empty UiAutomator dump was received')1794received=received.encode('utf-8','ignore')1795ifDEBUG:1796self.received=received1797ifDEBUG_RECEIVED:1798print>>sys.stderr,"received %d chars"%len(received)1799print>>sys.stderr1800print>>sys.stderr,repr(received)1801print>>sys.stderr1802onlyKilledRE=re.compile('[\n\S]*Killed[\n\r\S]*',re.MULTILINE)1803ifonlyKilledRE.search(received):1804raiseRuntimeError('''ERROR: UiAutomator output contains no valid information. UiAutomator was killed, no reason given.''')1805ifself.ignoreUiAutomatorKilled:1806ifDEBUG_RECEIVED:1807print>>sys.stderr,"ignoring UiAutomator Killed"1808killedRE=re.compile('</hierarchy>[\n\S]*Killed',re.MULTILINE)1809ifkilledRE.search(received):1810received=re.sub(killedRE,'</hierarchy>',received)1811elifDEBUG_RECEIVED:1812print"UiAutomator Killed: NOT FOUND!"1813# It seems that API18 uiautomator spits this message to stdout1814dumpedToDevTtyRE=re.compile('</hierarchy>[\n\S]*UI hierchary dumped to: /dev/tty.*',re.MULTILINE)1815ifdumpedToDevTtyRE.search(received):1816received=re.sub(dumpedToDevTtyRE,'</hierarchy>',received)1817ifDEBUG_RECEIVED:1818print>>sys.stderr,"received=",received1819ifre.search('\[: not found',received):1820raiseRuntimeError('''ERROR: Some emulator images (i.e. android 4.1.2 API 16 generic_x86) does not include the '[' command.1821While UiAutomator back-end might be supported 'uiautomator' command fails.1822You should force ViewServer back-end.''')1823self.setViewsFromUiAutomatorDump(received)1824else:1825ifisinstance(window,str):1826self.list(sleep=0)1827found=False1828forwIdinself.windows:1829try:1830ifwindow==self.windows[wId]:1831window=wId1832found=True1833break1834except:1835pass1836try:1837ifint(window)==wId:1838window=wId1839found=True1840break1841except:1842pass1843try:1844ifint(window,16)==wId:1845window=wId1846found=True1847break1848except:1849pass18501851ifnotfound:1852raiseRuntimeError("ERROR: Cannot find window '%s' in %s"%(window,self.windows))18531854s=socket.socket(socket.AF_INET,socket.SOCK_STREAM)1855try:1856s.connect((VIEW_SERVER_HOST,self.localPort))1857exceptsocket.error,ex:1858raiseRuntimeError("ERROR: Connecting to %s:%d: %s"%(VIEW_SERVER_HOST,self.localPort,ex))1859cmd='dump %x\r\n'%window1860ifDEBUG:1861print>>sys.stderr,"executing: '%s'"%cmd1862s.send(cmd)1863received=""1864doneRE=re.compile("DONE")1865ViewClient.setAlarm(120)1866whileTrue:1867ifDEBUG_RECEIVED:1868print>>sys.stderr," reading from socket..."1869received+=s.recv(1024)1870ifdoneRE.search(received[-7:]):1871break1872s.close()1873ViewClient.setAlarm(0)1874ifDEBUG:1875self.received=received1876ifDEBUG_RECEIVED:1877print>>sys.stderr,"received %d chars"%len(received)1878print>>sys.stderr1879print>>sys.stderr,received1880print>>sys.stderr1881self.setViews(received)18821883ifDEBUG_TREE:1884self.traverse(self.root)18851886returnself.views
1889'''1890 List the windows.18911892 Sleep is useful to wait some time before obtaining the new content when something in the1893 window has changed.1894 This also sets L{self.windows} as the list of windows.18951896 @type sleep: int1897 @param sleep: sleep in seconds before proceeding to dump the content18981899 @return: the list of windows1900 '''19011902ifsleep>0:1903MonkeyRunner.sleep(sleep)19041905ifself.useUiAutomator:1906raiseException("Not implemented yet: listing windows with UiAutomator")1907else:1908s=socket.socket(socket.AF_INET,socket.SOCK_STREAM)1909try:1910s.connect((VIEW_SERVER_HOST,self.localPort))1911exceptsocket.error,ex:1912raiseRuntimeError("ERROR: Connecting to %s:%d: %s"%(VIEW_SERVER_HOST,self.localPort,ex))1913s.send('list\r\n')1914received=""1915doneRE=re.compile("DONE")1916whileTrue:1917received+=s.recv(1024)1918ifdoneRE.search(received[-7:]):1919break1920s.close()1921ifDEBUG:1922self.received=received1923ifDEBUG_RECEIVED:1924print>>sys.stderr,"received %d chars"%len(received)1925print>>sys.stderr1926print>>sys.stderr,received1927print>>sys.stderr19281929self.windows={}1930forlineinreceived.split('\n'):1931ifnotline:1932break1933ifdoneRE.search(line):1934break1935(wid,package)=line.split()1936self.windows[int('0x'+wid,16)]=package1937returnself.windows
1941'''1942 Finds the View with the specified viewId.19431944 @type viewId: str1945 @param viewId: the ID of the view to find1946 @type root: str1947 @type root: View1948 @param root: the root node of the tree where the View will be searched1949 @type: viewFilter: function1950 @param viewFilter: a function that will be invoked providing the candidate View as a parameter1951 and depending on the return value (C{True} or C{False}) the View will be1952 selected and returned as the result of C{findViewById()} or ignored.1953 This can be C{None} and no extra filtering is applied.19541955 @return: the C{View} found or C{None}1956 '''19571958ifnotroot:1959returnNone19601961iftype(root)==types.StringTypeandroot=="ROOT":1962returnself.findViewById(viewId,self.root,viewFilter)19631964ifroot.getId()==viewId:1965ifviewFilter:1966ifviewFilter(root):1967returnroot1968else:1969returnroot19701971ifre.match('^id/no_id',viewId)orre.match('^id/.+/.+',viewId):1972ifroot.getUniqueId()==viewId:1973ifviewFilter:1974ifviewFilter(root):1975returnroot;1976else:1977returnroot197819791980forchinroot.children:1981foundView=self.findViewById(viewId,ch,viewFilter)1982iffoundView:1983ifviewFilter:1984ifviewFilter(foundView):1985returnfoundView1986else:1987returnfoundView
1990'''1991 Finds the View or raise a ViewNotFoundException.19921993 @type viewId: str1994 @param viewId: the ID of the view to find1995 @type root: str1996 @type root: View1997 @param root: the root node of the tree where the View will be searched1998 @type: viewFilter: function1999 @param viewFilter: a function that will be invoked providing the candidate View as a parameter2000 and depending on the return value (C{True} or C{False}) the View will be2001 selected and returned as the result of C{findViewById()} or ignored.2002 This can be C{None} and no extra filtering is applied.2003 @return: the View found2004 @raise ViewNotFoundException: raise the exception if View not found2005 '''20062007view=self.findViewById(viewId,root,viewFilter)2008ifview:2009returnview2010else:2011raiseViewNotFoundException("ID",viewId,root)
2021'''2022 Finds the View with the specified tag or raise a ViewNotFoundException2023 '''20242025view=self.findViewWithAttribute('getTag()',tag,root)2026ifview:2027returnview2028else:2029raiseViewNotFoundException("tag",tag,root)
2032ifnotself.root:2033print>>sys.stderr,"ERROR: no root, did you forget to call dump()?"2034returnNone20352036iftype(root)==types.StringTypeandroot=="ROOT":2037root=self.root20382039ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: type val=",type(val)2040ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: checking if root=%s has attr=%s == %s"%(root.__smallStr__(),attr,val)20412042ifisinstance(val,org.python.modules.sre.PatternObject):2043returnself.__findViewWithAttributeInTreeThatMatches(attr,val,root)2044else:2045ifrootandattrinroot.mapandroot.map[attr]==val:2046ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTree: FOUND: %s"%root.__smallStr__()2047returnroot2048else:2049forchinroot.children:2050v=self.__findViewWithAttributeInTree(attr,val,ch)2051ifv:2052returnv20532054returnNone
2064ifnotself.root:2065print>>sys.stderr,"ERROR: no root, did you forget to call dump()?"2066returnNone20672068iftype(root)==types.StringTypeandroot=="ROOT":2069root=self.root20702071ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTreeThatMatches: checking if root=%s attr=%s matches %s"%(root.__smallStr__(),attr,regex)20722073ifrootandattrinroot.mapandregex.match(root.map[attr]):2074ifDEBUG:print>>sys.stderr,"__findViewWithAttributeInTreeThatMatches: FOUND: %s"%root.__smallStr__()2075returnroot2076#print >>sys.stderr, "appending root=%s to rlist=%s" % (root.__smallStr__(), rlist)2077#return rlist.append(root)2078else:2079forchinroot.children:2080v=self.__findViewWithAttributeInTreeThatMatches(attr,regex,ch,rlist)2081ifv:2082returnv2083#print >>sys.stderr, "appending v=%s to rlist=%s" % (v.__smallStr__(), rlist)2084#return rlist.append(v)20852086returnNone
2097'''2098 Finds the View or raise a ViewNotFoundException.20992100 @return: the View found2101 @raise ViewNotFoundException: raise the exception if View not found2102 '''21032104view=self.findViewWithAttribute(attr,val,root)2105ifview:2106returnview2107else:2108raiseViewNotFoundException(attr,val,root)
2111'''2112 Finds the list of Views with the specified attribute matching2113 regex2114 '''21152116returnself.__findViewWithAttributeInTreeThatMatches(attr,regex,root)
2136'''2137 Finds the View or raise a ViewNotFoundException.21382139 @return: the View found2140 @raise ViewNotFoundException: raise the exception if View not found2141 '''21422143ifDEBUG:2144print>>sys.stderr,"findViewWithTextOrRaise(%s, %s)"%(text,root)2145view=self.findViewWithText(text,root)2146ifview:2147returnview2148else:2149raiseViewNotFoundException("text",text,root)
2152'''2153 Finds the View with the specified content description2154 '''21552156returnself.__findViewWithAttributeInTree('content-desc',contentdescription,root)
2159'''2160 Finds the View with the specified content description2161 '''21622163returnself.__findViewWithAttributeInTreeOrRaise('content-desc',contentdescription,root)
2166'''2167 Finds the list of Views that contain the point (x, y).2168 '''21692170ifnotfilter:2171filter=lambdav:True21722173return[vforvinself.viewsif(v.containsPoint((x,y))andfilter(v))]
2202'''2203 Whether the keyboard is displayed.2204 '''22052206dim=self.device.shell('dumpsys input_method')2207ifdim:2208# FIXME: API >= 15 ?2209return"mInputShown=true"indim2210returnFalse
2213'''2214 Write the View image to the specified filename in the specified format.22152216 @type filename: str2217 @param filename: Absolute path and optional filename receiving the image. If this points to2218 a directory, then the filename is determined by the serialno of the device and2219 format extension.2220 @type format: str2221 @param format: Image format (default format is PNG)2222 '''22232224ifnotos.path.isabs(filename):2225raiseValueError("writeImageToFile expects an absolute path")2226ifos.path.isdir(filename):2227filename=os.path.join(filename,self.serialno+'.'+format.lower())2228ifDEBUG:2229print>>sys.stderr,"writeImageToFile: saving image to '%s' in %s format"%(filename,format)2230self.device.takeSnapshot().writeToFile(filename,format)
2234'''2235 Makes the tree pickleable.2236 '''22372238defremoveDeviceReference(view):2239'''2240 Removes the reference to a L{MonkeyDevice}.2241 '''22422243view.device=None
22442245###########################################################################################2246# FIXME: Unfortunatelly deepcopy does not work with MonkeyDevice objects, which is2247# sadly the reason why we cannot pickle the tree and we need to remove the MonkeyDevice2248# references.2249# We wanted to copy the tree to preserve the original and make piclkleable the copy.2250#treeCopy = copy.deepcopy(tree)2251treeCopy=tree2252# IMPORTANT:2253# This assumes that the first element in the list is the tree root2254ViewClient.__traverse(treeCopy[0],transform=removeDeviceReference)2255###########################################################################################2256returntreeCopy
2259'''2260 Calculates the distance between this tree and the tree passed as argument.22612262 @type tree: list of Views2263 @param tree: Tree of Views2264 @return: the distance2265 '''2266################################################################2267#FIXME: this should copy the entire tree and then transform it #2268################################################################2269pickleableViews=ViewClient.__pickleable(self.views)2270pickleableTree=ViewClient.__pickleable(tree)2271s1=pickle.dumps(pickleableViews)2272s2=pickle.dumps(pickleableTree)22732274ifDEBUG_DISTANCE:2275print>>sys.stderr,"distance: calculating distance between",s1[:20],"and",s2[:20]22762277l1=len(s1)2278l2=len(s2)2279t=float(max(l1,l2))22802281ifl1==l2:2282ifDEBUG_DISTANCE:2283print>>sys.stderr,"distance: trees have same length, using Hamming distance"2284returnViewClient.__hammingDistance(s1,s2)/t2285else:2286ifDEBUG_DISTANCE:2287print>>sys.stderr,"distance: trees have different length, using Levenshtein distance"2288returnViewClient.__levenshteinDistance(s1,s2)/t
2292'''2293 Finds the Hamming distance between two strings.22942295 @param s1: string2296 @param s2: string2297 @return: the distance2298 @raise ValueError: if the lenght of the strings differ2299 '''23002301l1=len(s1)2302l2=len(s2)23032304ifl1!=l2:2305raiseValueError("Hamming distance requires strings of same size.")23062307returnsum(ch1!=ch2forch1,ch2inzip(s1,s2))
2310'''2311 Finds the Hamming distance between this tree and the one passed as argument.2312 '''23132314s1=' '.join(map(View.__str__,self.views))2315s2=' '.join(map(View.__str__,tree))23162317returnViewClient.__hammingDistance(s1,s2)
2321'''2322 Find the Levenshtein distance between two Strings.23232324 Python version of Levenshtein distance method implemented in Java at2325 U{http://www.java2s.com/Code/Java/Data-Type/FindtheLevenshteindistancebetweentwoStrings.htm}.23262327 This is the number of changes needed to change one String into2328 another, where each change is a single character modification (deletion,2329 insertion or substitution).23302331 The previous implementation of the Levenshtein distance algorithm2332 was from U{http://www.merriampark.com/ld.htm}23332334 Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError2335 which can occur when my Java implementation is used with very large strings.2336 This implementation of the Levenshtein distance algorithm2337 is from U{http://www.merriampark.com/ldjava.htm}::23382339 StringUtils.getLevenshteinDistance(null, *) = IllegalArgumentException2340 StringUtils.getLevenshteinDistance(*, null) = IllegalArgumentException2341 StringUtils.getLevenshteinDistance("","") = 02342 StringUtils.getLevenshteinDistance("","a") = 12343 StringUtils.getLevenshteinDistance("aaapppp", "") = 72344 StringUtils.getLevenshteinDistance("frog", "fog") = 12345 StringUtils.getLevenshteinDistance("fly", "ant") = 32346 StringUtils.getLevenshteinDistance("elephant", "hippo") = 72347 StringUtils.getLevenshteinDistance("hippo", "elephant") = 72348 StringUtils.getLevenshteinDistance("hippo", "zzzzzzzz") = 82349 StringUtils.getLevenshteinDistance("hello", "hallo") = 123502351 @param s: the first String, must not be null2352 @param t: the second String, must not be null2353 @return: result distance2354 @raise ValueError: if either String input C{null}2355 '''2356ifsisNoneortisNone:2357raiseValueError("Strings must not be null")23582359n=len(s)2360m=len(t)23612362ifn==0:2363returnm2364elifm==0:2365returnn23662367ifn>m:2368tmp=s2369s=t2370t=tmp2371n=m;2372m=len(t)23732374p=[None]*(n+1)2375d=[None]*(n+1)23762377foriinrange(0,n+1):2378p[i]=i23792380forjinrange(1,m+1):2381ifDEBUG_DISTANCE:2382ifj%100==0:2383print>>sys.stderr,"DEBUG:",int(j/(m+1.0)*100),"%\r",2384t_j=t[j-1]2385d[0]=j23862387foriinrange(1,n+1):2388cost=0ifs[i-1]==t_jelse12389# minimum of cell to the left+1, to the top+1, diagonally left and up +cost2390d[i]=min(min(d[i-1]+1,p[i]+1),p[i-1]+cost)23912392_d=p2393p=d2394d=_d23952396ifDEBUG_DISTANCE:2397print>>sys.stderr,"\n"2398returnp[n]
map (map) - the map containing the (attribute, value) pairs
device (MonkeyDevice) - the device containing this View
version (int) - the Android SDK version number of the platform where this View
belongs. If this is -1 then the Android SDK version
will be obtained in this constructor.
forceviewserveruse (boolean) - Force the use of ViewServer even if the conditions
were given to use UiAutomator.
Write the View image to the specified filename in the specified
format.
Parameters:
filename (str) - Absolute path and optional filename receiving the image. If this
points to a directory, then the filename is determined by this
View unique ID and format extension.
format (str) - Image format (default format is PNG)
connectToDeviceOrExit(timeout=60,
verbose=False,
ignoresecuredevice=False,
serialno=None)
Connects to a device which serial number is obtained from the script
arguments if available or using the default regex .*.
Connects to a device which serial number is obtained from the script
arguments if available or using the default regex .*.
If the connection is not successful the script exits. MonkeyRunner.waitForConnection() returns a
MonkeyDevice even if the connection failed. Then, to detect this
situation, device.wake() is attempted and if it fails then
it is assumed the previous connection failed.
Parameters:
timeout (int) - timeout for the connection
verbose (bool) - Verbose output
ignoresecuredevice (bool) - Ignores the check for a secure device
serialno (str) - The device or emulator serial number
Splits the View attributes in strArgs and
optionally adds the view id to the viewsById list.
Unique Ids
It is very common to find Views having NO_ID as
the Id. This turns very difficult to use self.findViewById(). To help in this situation this
method assigns unique Ids.
The unique Ids are generated using the pattern
id/no_id/<number> with <number>
starting at 1.
Parameters:
strArgs (str) - the string containing the raw list of attributes and values
Parses the View tree contained in receivedLines. The tree is created and the root node
assigned to self.root. This method also assigns self.viewsById values using View.getUniqueId as the key.
Parameters:
receivedLines (str) - the string received from View Server
Sleep is useful to wait some time before obtaining the new content
when something in the window has changed.
Parameters:
window (int or str) - the window id or name of the window to dump. The name is
the package name or the window name (i.e. StatusBar) for system
windows. The window id can be provided as int or
str. The str should represent and
int in either base 10 or 16. Use -1 to dump all
windows. This parameter only is used when the backend is
ViewServer and it's ignored for UiAutomator.
sleep (int) - sleep in seconds before proceeding to dump the content
Returns:
the list of Views as str received from the server
after being split into lines
Sleep is useful to wait some time before obtaining the new content
when something in the window has changed. This also sets self.windows as the list of windows.
Parameters:
sleep (int) - sleep in seconds before proceeding to dump the content
root (str) - the root node of the tree where the View will be searched
viewFilter - a function that will be invoked providing the candidate View as a
parameter and depending on the return value (True or
False) the View will be selected and returned as the
result of findViewById() or ignored. This can be
None and no extra filtering is applied.
root (str) - the root node of the tree where the View will be searched
viewFilter - a function that will be invoked providing the candidate View as a
parameter and depending on the return value (True or
False) the View will be selected and returned as the
result of findViewById() or ignored. This can be
None and no extra filtering is applied.
Write the View image to the specified filename in the specified
format.
Parameters:
filename (str) - Absolute path and optional filename receiving the image. If this
points to a directory, then the filename is determined by the
serialno of the device and format extension.
format (str) - Image format (default format is PNG)
This is the number of changes needed to change one String into
another, where each change is a single character modification (deletion,
insertion or substitution).
Chas Emerick has written an implementation in Java, which avoids an
OutOfMemoryError which can occur when my Java implementation is used with
very large strings. This implementation of the Levenshtein distance
algorithm is from http://www.merriampark.com/ldjava.htm:
On some devices (i.e. Nexus 7 running 4.2.2) uiautomator is killed
just after generating the dump file. In many cases the file is already
complete so we can ask to ignore the 'Killed' message by setting ignoreuiautomatorkilled to True.
Changes in 2.3.21 that uses /dev/tty instead of a file
may have turned this variable unnnecessary, however it has been kept for
backward compatibility.
views
The list of Views represented as str obtained after
splitting it into lines after being received from the server. Done by self.setViews().
Thanks to all who made it possible.
# Want to learn more?
Detailed information can be found in the [AndroidViewClient/culebra wiki](https://github.com/dtmilano/AndroidViewClient/wiki)
AndroidViewClient-20.4.4/avc-version 0000775 0000000 0000000 00000003370 14156000053 0017332 0 ustar 00root root 0000000 0000000 #! /bin/bash
usage()
{
echo "usage: $0 {get | set 
