-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
xpath.py
931 lines (768 loc) · 28.2 KB
/
xpath.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# coding: utf-8
#
from __future__ import absolute_import
import abc
import functools
import io
import json
import logging
import re
import threading
import time
from collections import defaultdict
from types import ModuleType
from typing import Callable, Optional, Union
import adbutils
from deprecated import deprecated
from logzero import logger, setup_logger
from PIL import Image
import uiautomator2
from ._proto import Direction
from .abcd import BasicUIMeta
from .exceptions import XPathElementNotFoundError
from .utils import U, inject_call, swipe_in_bounds
try:
from lxml import etree
except ImportError:
logger.warning("lxml was not installed, xpath will not supported")
def safe_xmlstr(s):
return s.replace("$", "-")
def init():
uiautomator2.plugin_register("xpath", XPath)
def string_quote(s):
""" quick way to quote string """
return "{!r}".format(s)
def str2bytes(v) -> bytes:
if isinstance(v, bytes):
return v
return v.encode('utf-8')
def strict_xpath(xpath: str, logger=logger) -> str:
""" make xpath to be computer recognized xpath """
orig_xpath = xpath
if xpath.startswith('/'):
pass
elif xpath.startswith('@'):
xpath = '//*[@resource-id={!r}]'.format(xpath[1:])
elif xpath.startswith('^'):
xpath = '//*[re:match(@text, {0}) or re:match(@content-desc, {0}) or re:match(@resource-id, {0})]'.format(
string_quote(xpath))
# elif xpath.startswith("$"): # special for objects
# key = xpath[1:]
# return self(self.__alias_get(key), source)
elif xpath.startswith('%') and xpath.endswith("%"):
xpath = '//*[contains(@text, {0}) or contains(@content-desc, {0})]'.format(string_quote(xpath[1:-1]))
elif xpath.startswith('%'): # ends-with
text = xpath[1:]
xpath = '//*[{0} = substring(@text, string-length(@text) - {1} + 1) or {0} = substring(@content-desc, string-length(@text) - {1} + 1)]'.format(
string_quote(text), len(text))
elif xpath.endswith('%'): # starts-with
text = xpath[:-1]
xpath = "//*[starts-with(@text, {0}) or starts-with(@content-desc, {0})]".format(string_quote(text))
else:
xpath = '//*[@text={0} or @content-desc={0} or @resource-id={0}]'.format(
string_quote(xpath))
logger.debug("xpath %s -> %s", orig_xpath, xpath)
return xpath
class TimeoutException(Exception):
pass
class XPathError(Exception):
""" basic error for xpath plugin """
class UIMeta(metaclass=abc.ABCMeta):
@abc.abstractmethod
def click(self, x: int, y: int):
pass
@abc.abstractmethod
def swipe(self, fx: int, fy: int, tx: int, ty: int, duration: float):
""" duration is float type, indicate seconds """
@abc.abstractmethod
def window_size(self) -> tuple:
""" return (width, height) """
@abc.abstractmethod
def dump_hierarchy(self) -> str:
""" return xml content """
@abc.abstractmethod
def screenshot(self):
""" return PIL.Image.Image """
class XPath(object):
def __init__(self, d: "uiautomator2.Device"):
"""
Args:
d (uiautomator2 instance)
"""
self._d = d
assert hasattr(d, "click")
assert hasattr(d, "swipe")
assert hasattr(d, "window_size")
assert hasattr(d, "dump_hierarchy")
assert hasattr(d, "screenshot")
assert hasattr(d, 'wait_timeout')
self._click_before_delay = 0.0 # pre delay
self._click_after_delay = None # post delay
self._last_source = None
self._event_callbacks = defaultdict(list)
# used for click("#back") and back is the key
self._alias = {}
self._alias_strict = False
self._dump_lock = threading.Lock()
# 这里setup_logger不可以通过level参数传入logging.INFO
# 不然其StreamHandler都要重新setLevel,没看懂也没关系,反正就是不要这么干. 特此备注
self._logger = setup_logger()
self._logger.setLevel(logging.INFO)
def global_set(self, key, value):
valid_keys = {
"timeout", "alias", "alias_strict", "click_after_delay",
"click_before_delay"
}
if key not in valid_keys:
raise ValueError("invalid key", key)
if key == "timeout":
self.implicitly_wait(value)
else:
setattr(self, "_" + key, value)
def implicitly_wait(self, timeout):
""" set default timeout when click """
self._d.wait_timeout = timeout
@property
def logger(self):
expect_level = logging.DEBUG if self._d.settings['xpath_debug'] else logging.INFO # yapf: disable
if expect_level != self._logger.level:
self._logger.setLevel(expect_level)
return self._logger
@property
def wait_timeout(self):
return self._d.wait_timeout
@property
def _watcher(self):
return self._d.watcher
def dump_hierarchy(self):
with self._dump_lock:
self._last_source = self._d.dump_hierarchy()
return self._last_source
def get_last_hierarchy(self):
return self._last_source
def add_event_listener(self, event_name, callback):
self._event_callbacks[event_name] += [callback]
# def register_callback(action: str, callback):
# pass
def send_click(self, x, y):
if self._click_before_delay:
self.logger.debug("click before delay %.1f seconds",
self._click_after_delay)
time.sleep(self._click_before_delay)
# TODO(ssx): should use a better way
# event callbacks for report generate
for callback_func in self._event_callbacks['send_click']:
callback_func(x, y)
self._d.click(x, y)
if self._click_after_delay:
self.logger.debug("click after delay %.1f seconds",
self._click_after_delay)
time.sleep(self._click_after_delay)
def send_longclick(self, x, y):
self._d.long_click(x, y)
def send_swipe(self, sx, sy, tx, ty):
self._d.swipe(sx, sy, tx, ty)
def send_text(self, text: str = None):
self._d.set_fastinput_ime()
self._d.clear_text()
if text:
self._d.send_keys(text)
def take_screenshot(self) -> Image.Image:
return self._d.screenshot()
def match(self, xpath, source=None):
return len(self(xpath, source).all()) > 0
@deprecated(version="3.0.0", reason="use d.watcher.when(..) instead")
def when(self, xquery: str):
return self._watcher.when(xquery)
@deprecated(version="3.0.0", reason="deprecated")
def apply_watch_from_yaml(self, data):
"""
Examples of argument data
---
- when: "@com.example.app/popup"
then: >
def callback(d):
d.click(0.5, 0.5)
- when: 继续
then: click
"""
try:
import yaml
except ImportError:
self.logger.warning("missing lib pyyaml")
data = yaml.load(data, Loader=yaml.SafeLoader)
for item in data:
when, then = item['when'], item['then']
trigger = lambda: None
self.logger.info("%s, %s", when, then)
if then == 'click':
trigger = lambda selector: selector.get_last_match().click()
trigger.__doc__ = "click"
elif then.lstrip().startswith("def callback"):
mod = ModuleType("_inner_module")
exec(then, mod.__dict__)
trigger = mod.callback
trigger.__doc__ = then
else:
self.logger.warning("Unknown then: %r", then)
self.logger.debug("When: %r, Trigger: %r", when, trigger.__doc__)
self.when(when).call(trigger)
@deprecated(version="3.0.0", reason="use d.watcher.run() instead")
def run_watchers(self, source=None):
self._watcher.run()
@deprecated(version="3.0.0", reason="use d.watcher.start(..) instead")
def watch_background(self, interval: float = 4.0):
return self._watcher.start(interval)
@deprecated(version="3.0.0", reason="use d.watcher.stop() instead")
def watch_stop(self):
""" stop watch background """
self._watcher.stop()
@deprecated(version="3.0.0", reason="use d.watcher.remove() instead")
def watch_clear(self):
self._watcher.stop()
@deprecated(version="3.0.0", reason="removed")
def sleep_watch(self, seconds):
""" run watchers when sleep """
deadline = time.time() + seconds
while time.time() < deadline:
self.run_watchers()
left_time = max(0, deadline - time.time())
time.sleep(min(0.5, left_time))
def _get_after_watch(self, xpath: Union[str, list], timeout=None):
if timeout == 0:
timeout = .01
timeout = timeout or self.wait_timeout
self.logger.info("XPath(timeout %.1f) %s", timeout, xpath)
deadline = time.time() + timeout
while True:
source = self.dump_hierarchy()
selector = self(xpath, source)
if selector.exists:
return selector.get_last_match()
if time.time() > deadline:
break
time.sleep(.5)
raise TimeoutException("timeout %.1f, xpath: %s" % (timeout, xpath))
def click(self,
xpath: Union[str, list],
timeout=None,
pre_delay: float = None):
"""
Find element and perform click
Args:
xpath (str): xpath string
timeout (float): pass
pre_delay (float): pre delay wait time before click
Raises:
TimeoutException
"""
el = self._get_after_watch(xpath, timeout)
el.click() # 100ms
def scroll_to(self,
xpath: str,
direction: Union[Direction, str] = Direction.FORWARD,
max_swipes=10) -> Union["XMLElement", None]:
"""
Need more tests
scroll up the whole screen until target element founded
Returns:
bool (found or not)
"""
if direction == Direction.FORWARD:
direction = Direction.UP
elif direction == Direction.BACKWARD:
direction = Direction.DOWN
elif direction == Direction.HORIZ_FORWARD: # Horizontal
direction = Direction.LEFT
elif direction == Direction.HBACKWORD:
direction = Direction.RIGHT
# FIXME(ssx): 还差一个检测是否到底的功能
assert max_swipes > 0
target = self(xpath)
for i in range(max_swipes):
if target.exists:
self._d.swipe_ext(direction, 0.1) # 防止元素停留在边缘
return target.get_last_match()
self._d.swipe_ext(direction, 0.5)
return False
def __alias_get(self, key, default=None):
"""
when alias_strict set, if key not in _alias, XPathError will be raised
"""
value = self._alias.get(key, default)
if value is None:
if self._alias_strict:
raise XPathError("alias have not found key", key)
value = key
return value
def __call__(self, xpath: str, source=None):
# print("XPATH:", xpath)
return XPathSelector(self, xpath, source)
class XPathSelector(object):
def __init__(self, parent: XPath, xpath: Union[list, str], source=None):
self.logger = parent.logger
self._parent = parent
self._d = parent._d
#strict_xpath(xpath, self.logger)] if isinstance(
# xpath, str) else xpath
self._source = source
self._last_source = None
self._position = None
self._fallback = None
self._xpath_list = []
self.xpath(xpath)
def __str__(self):
return f"XPathSelector({'|'.join(self._xpath_list)}"
def xpath(self, _xpath: Union[list, tuple, str]):
if isinstance(_xpath, str):
_xpath = strict_xpath(_xpath, self.logger)
self._xpath_list.append(_xpath)
elif isinstance(_xpath, (list, tuple)):
for xp in _xpath:
self._xpath_list.append(strict_xpath(xp, self.logger))
else:
raise TypeError("Unknown type for value {}".format(_xpath))
return self
def child(self, _xpath: str):
if not _xpath.startswith("/"):
_xpath = "/" + _xpath
self._xpath_list[-1] = self._xpath_list[-1] + _xpath
return self
def position(self, x: float, y: float):
""" set possible position """
assert 0 < x < 1
assert 0 < y < 1
self._position = (x, y)
return self
def fallback(self,
func: Optional[Callable[..., bool]] = None,
*args,
**kwargs):
"""
callback on failure
"""
if isinstance(func, str):
if func == "click":
if len(args) == 0:
args = self._position
func = lambda d: d.click(*args)
else:
raise ValueError(
"func should be \"click\" or callable function")
assert callable(func)
self._fallback = func
return self
@property
def _global_timeout(self):
return self._parent.wait_timeout
def all(self, source=None):
"""
Returns:
list of XMLElement
"""
xml_content = source or self._source or self._parent.dump_hierarchy()
self._last_source = xml_content
# run-watchers
hierarchy = source or self._source
if not hierarchy:
trigger_count = 0
for _ in range(5): # trigger for most 5 times
triggered = self._parent._watcher.run(xml_content)
if not triggered:
break
trigger_count += 1
xml_content = self._parent.dump_hierarchy()
if trigger_count:
self.logger.debug("watcher triggered %d times", trigger_count)
if hierarchy is None:
root = etree.fromstring(str2bytes(xml_content))
elif isinstance(hierarchy, (str, bytes)):
root = etree.fromstring(str2bytes(hierarchy))
elif isinstance(hierarchy, etree._Element):
root = hierarchy
else:
raise TypeError("Unknown type", type(hierarchy))
for node in root.xpath("//node"):
node.tag = safe_xmlstr(node.attrib.pop("class", "")) or "node"
match_sets = []
for xpath in self._xpath_list:
matches = root.xpath(
xpath,
namespaces={"re": "http://exslt.org/regular-expressions"})
match_sets.append(matches)
# find out nodes which match all xpaths
match_nodes = functools.reduce(lambda x, y: set(x).intersection(y),
match_sets)
els = [XMLElement(node, self._parent) for node in match_nodes]
if not self._position:
return els
# 中心点应控制在控件内
inside_els = []
px, py = self._position
wsize = self._d.window_size()
for e in els:
lpx, lpy, rpx, rpy = e.percent_bounds(wsize=wsize)
# 中心点偏移百分比不应大于控件宽高的50%
scale = 1.5
if abs(px - (lpx + rpx) / 2) > (rpx - lpx) * .5 * scale:
continue
if abs(py - (lpy + rpy) / 2) > (rpy - lpy) * .5 * scale:
continue
inside_els.append(e)
return inside_els
@property
def exists(self):
return len(self.all()) > 0
def get(self, timeout=None):
"""
Get first matched element
Args:
timeout (float): max seconds to wait
Returns:
XMLElement
Raises:
XPathElementNotFoundError
"""
if not self.wait(timeout or self._global_timeout):
raise XPathElementNotFoundError(self._xpath_list)
return self.get_last_match()
def get_last_match(self):
return self.all(self._last_source)[0]
def get_text(self):
"""
get element text
Returns:
string of node text
Raises:
XPathElementNotFoundError
"""
return self.get().attrib.get("text", "")
def set_text(self, text: str = ""):
el = self.get()
self._d.set_fastinput_ime() # switch ime
el.click() # focus input-area
self._parent.send_text(text)
def wait(self, timeout=None) -> Optional["XMLElement"]:
"""
Args:
timeout (float): seconds
Returns:
None or XMLElement
"""
deadline = time.time() + (timeout or self._global_timeout)
while time.time() < deadline:
# self.logger.debug("wait %s left %.1fs", self, deadline-time.time())
if self.exists:
return self.get_last_match()
time.sleep(.2)
return None
def match(self) -> Optional["XMLElement"]:
"""
Returns:
None or matched XMLElement
"""
if self.exists:
return self.get_last_match()
def wait_gone(self, timeout=None) -> bool:
"""
Args:
timeout (float): seconds
Returns:
True if gone else False
"""
deadline = time.time() + (timeout or self._global_timeout)
while time.time() < deadline:
if not self.exists:
return True
time.sleep(.2)
return False
def click_nowait(self):
x, y = self.all()[0].center()
self.logger.info("click %d, %d", x, y)
self._parent.send_click(x, y)
def click(self, timeout=None):
""" find element and perform click """
try:
el = self.get(timeout=timeout)
el.click()
except XPathElementNotFoundError:
if not self._fallback:
raise
self.logger.info("element not found, run fallback")
return inject_call(self._fallback, d=self._d)
def click_exists(self, timeout=None) -> bool:
el = self.wait(timeout=timeout)
if el:
el.click()
return True
return False
def long_click(self):
""" find element and perform long click """
self.get().long_click()
def screenshot(self) -> Image.Image:
""" take element screenshot """
el = self.get()
return el.screenshot()
def __getattr__(self, key: str):
"""
In IPython console, attr:_ipython_canary_method_should_not_exist_ will be called
So here ignore all attr startswith _
"""
if key.startswith("_"):
raise AttributeError("Invalid attr", key)
el = self.get()
return getattr(el, key)
class XMLElement(object):
def __init__(self, elem, parent: XPath):
"""
Args:
elem: lxml node
d: uiautomator2 instance
"""
self.elem = elem
self._parent = parent
self._d = parent._d
def __hash__(self):
compared_attrs = ("text", "resource-id", "package", "content-desc")
values = [self.attrib.get(name) for name in compared_attrs]
root = self.elem.getroottree()
fullpath = root.getpath(self.elem)
fullpath = re.sub(r'\[\d+\]', '', fullpath) # remove indexes
values.append(fullpath)
return hash(tuple(values))
def __eq__(self, value):
return self.__hash__() == hash(value)
def __repr__(self):
x, y = self.center()
return "<xpath.XMLElement [{tag!r} center:({x}, {y})]>".format(tag=self.elem.tag, x=x, y=y)
def get_xpath(self, strip_index: bool = False):
""" get element full xpath """
root = self.elem.getroottree()
path = root.getpath(self.elem)
if strip_index:
path = re.sub(r'\[\d+\]', '', path) # remove indexes
return path
# 模糊对比方法,后来发现直接对比XPath似乎更好一些
# def fuzzy_equal(self, xml_element) -> bool:
# root = self.elem.getroottree()
# fullpath = root.getpath(self.elem)
# fullpath = re.sub(r'\[\d+\]', '', fullpath) # remove indexes
# compared_attrs = ("text", "resource-id", "package", "content-desc")
# for name in compared_attrs:
# if self.elem.attrib[name] != xml_element.attrib[name]:
# return False
# def _elem2fullpath(el):
# root = el.getroottree()
# fullpath = root.getpath(el)
# return re.sub(r'\[\d+\]', '', fullpath) # remove indexes
# return _elem2fullpath(self.elem) == _elem2fullpath(xml_element.elem)
def center(self):
"""
Returns:
(x, y)
"""
return self.offset(0.5, 0.5)
def offset(self, px: float = 0.0, py: float = 0.0):
"""
Offset from left_top
Args:
px (float): percent of width
py (float): percent of height
Example:
offset(0.5, 0.5) means center
"""
x, y, width, height = self.rect
return x + int(width * px), y + int(height * py)
def click(self):
"""
click element, 100ms between down and up
"""
x, y = self.center()
self._parent.send_click(x, y)
def long_click(self):
"""
Sometime long click is needed, 400ms between down and up
"""
x, y = self.center()
self._parent.send_longclick(x, y)
def screenshot(self):
"""
Take screenshot of element
"""
im = self._parent.take_screenshot()
return im.crop(self.bounds)
def swipe(self, direction: Union[Direction, str], scale: float = 0.6):
"""
Args:
direction: one of ["left", "right", "up", "down"]
scale: percent of swipe, range (0, 1.0)
Raises:
AssertionError, ValueError
"""
return swipe_in_bounds(self._parent._d, self.bounds, direction, scale)
def scroll(self,
direction: Union[Direction, str] = Direction.FORWARD) -> bool:
"""
Args:
direction: Direction eg: Direction.FORWARD
Returns:
bool: if can be scroll again
"""
if direction == "forward":
direction = Direction.FORWARD
elif direction == "backward":
direction = Direction.BACKWARD
els = set(self._parent("//*").all())
self.swipe(direction, scale=.6)
# check if there is more element
new_elements = set(self._parent("//*").all()) - els
ppath = self.get_xpath() + "/" # limit to child nodes
els = [el for el in new_elements if el.get_xpath().startswith(ppath)]
return len(els) > 0
def scroll_to(self,
xpath: str,
direction: Direction = Direction.FORWARD,
max_swipes: int = 10) -> Union["XMLElement", None]:
assert max_swipes > 0
target = self._parent(xpath)
for i in range(max_swipes):
if target.exists:
return target.get_last_match()
if not self.scroll(direction):
break
return None
def parent(self, xpath: Optional[str] = None) -> Union["XMLElement", None]:
"""
Returns parent element
"""
if xpath is None:
return XMLElement(self.elem.getparent(), self._parent)
root = self.elem.getroottree()
e = self.elem
els = []
while e is not None and e != root:
els.append(e)
e = e.getparent()
xpath = strict_xpath(xpath)
matches = root.xpath(xpath,
namespaces={"re": "http://exslt.org/regular-expressions"})
all_paths = [root.getpath(m) for m in matches]
for e in reversed(els):
if root.getpath(e) in all_paths:
return XMLElement(e, self._parent)
# if e in matches:
# return XMLElement(e, self._parent)
def percent_size(self):
""" Returns:
(float, float): eg, (0.5, 0.5) means 50%, 50%
"""
ww, wh = self._d.window_size()
_, _, w, h = self.rect
return (w / ww, h / wh)
@property
def bounds(self):
"""
Returns:
tuple of (left, top, right, bottom)
"""
bounds = self.elem.attrib.get("bounds")
lx, ly, rx, ry = map(int, re.findall(r"\d+", bounds))
return (lx, ly, rx, ry)
def percent_bounds(self, wsize: Optional[tuple] = None):
"""
Args:
wsize (tuple(int, int)): window size
Returns:
list of 4 float, eg: 0.1, 0.2, 0.5, 0.8
"""
lx, ly, rx, ry = self.bounds
ww, wh = wsize or self._d.window_size()
return (lx / ww, ly / wh, rx / ww, ry / wh)
@property
def rect(self):
"""
Returns:
(left_top_x, left_top_y, width, height)
"""
lx, ly, rx, ry = self.bounds
return lx, ly, rx - lx, ry - ly
@property
def text(self):
return self.elem.attrib.get("text")
@property
def attrib(self):
return self.elem.attrib
@property
def info(self):
ret = {}
for key in ("text", "focusable", "enabled", "focused", "scrollable",
"selected"):
ret[key] = self.attrib.get(key)
ret["className"] = self.elem.tag
lx, ly, rx, ry = self.bounds
ret["bounds"] = {'left': lx, 'top': ly, 'right': rx, 'bottom': ry}
ret["contentDescription"] = self.attrib.get("content-desc")
ret["longClickable"] = self.attrib.get("long-clickable")
ret["packageName"] = self.attrib.get("package")
ret["resourceName"] = self.attrib.get("resource-id")
ret["resourceId"] = self.attrib.get("resource-id") # this is better than resourceName
ret["childCount"] = len(self.elem.getchildren())
return ret
class AdbUI(BasicUIMeta):
"""
Use adb command to run ui test
"""
def __init__(self, d: adbutils.AdbDevice):
self._d = d
def click(self, x, y):
self._d.click(x, y)
def swipe(self, sx, sy, ex, ey, duration):
self._d.swipe(sx, sy, ex, ey, duration)
def window_size(self):
w, h = self._d.window_size()
return w, h
def dump_hierarchy(self):
return self._d.dump_hierarchy()
def screenshot(self):
d = self._d
json_output = d.shell([
"LD_LIBRARY_PATH=/data/local/tmp", "/data/local/tmp/minicap", "-i",
"2&>/dev/null"
]).strip()
data = json.loads(json_output)
w, h, r = data["width"], data["height"], data["rotation"]
remote_image_path = "/sdcard/minicap.jpg"
d.shell(["rm", remote_image_path])
d.shell([
"LD_LIBRARY_PATH=/data/local/tmp",
"/data/local/tmp/minicap",
"-P", "{0}x{1}@{0}x{1}/{2}".format(w, h, r),
"-s", ">" + remote_image_path]) # yapf: disable
if d.sync.stat(remote_image_path).size == 0:
raise RuntimeError("screenshot using minicap error")
buf = io.BytesIO()
for data in d.sync.iter_content(remote_image_path):
buf.write(data)
return Image.open(buf)
if __name__ == "__main__":
d = AdbUI(adbutils.adb.device())
xpath = XPath(d)
# print(d.screenshot())
# print(d.dump_hierarchy()[:20])
xpath("App").click()
xpath("Alarm").click()
# init()
# import uiautomator2.ext.htmlreport as htmlreport
# d = uiautomator2.connect()
# hrp = htmlreport.HTMLReport(d)
# # take screenshot before each click
# hrp.patch_click()
# d.app_start("com.netease.cloudmusic", stop=True)
# # watchers
# d.ext_xpath.when("跳过").click()
# # d.ext_xpath.when("知道了").click()
# # steps
# d.ext_xpath("//*[@text='私人FM']/../android.widget.ImageView").click()
# d.ext_xpath("下一首").click()
# d.ext_xpath.sleep_watch(2)
# d.ext_xpath("转到上一层级").click()