uiautodev 0.3.6__tar.gz → 0.4.0__tar.gz

{uiautodev-0.3.6 → uiautodev-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiautodev
-Version: 0.3.6
+Version: 0.4.0
 Summary: Mobile UI Automation, include UI hierarchy inspector, script recorder
 Home-page: https://uiauto.dev
 License: MIT
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: appium
-Requires-Dist: adbutils (>=2.6.0,<3.0.0)
+Requires-Dist: adbutils (>=2.7.0,<3.0.0)
 Requires-Dist: appium-python-client (>=4.0.0,<5.0.0) ; extra == "appium"
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: construct
@@ -25,9 +25,11 @@ Requires-Dist: httpx
 Requires-Dist: lxml
 Requires-Dist: pillow
 Requires-Dist: poetry (>=1.8.2,<2.0.0)
+Requires-Dist: pydantic (>=2.6,<3.0)
 Requires-Dist: pygments (>=2)
 Requires-Dist: uiautomator2 (>=2)
 Requires-Dist: uvicorn[standard]
+Requires-Dist: wdapy (>=0.2.2,<0.3.0)
 Description-Content-Type: text/markdown
 
 # uiautodev

{uiautodev-0.3.6 → uiautodev-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiautodev"
-version = "0.3.6"
+version = "0.4.0"
 description = "Mobile UI Automation, include UI hierarchy inspector, script recorder"
 homepage = "https://uiauto.dev"
 authors = ["codeskyblue <codeskyblue@gmail.com>"]
@@ -10,7 +10,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.8"
 pillow = "*"
-adbutils = "^2.6.0"
+adbutils = "^2.7.0"
 construct = "*"
 lxml = "*"
 click = "^8.1.7"
@@ -22,6 +22,8 @@ httpx = "*"
 fastapi = "^0.111.0"
 uvicorn = {version = "*", extras = ["standard"]}
 poetry = "^1.8.2"
+pydantic = "^2.6"
+wdapy = "^0.2.2"
 
 [tool.poetry.extras]
 appium = ["appium-python-client", "httppretty"]

uiautodev-0.4.0/uiautodev/__init__.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""Created on Mon Mar 04 2024 14:28:53 by codeskyblue
+"""
+
+# version is auto managed by poetry
+__version__ = "0.4.0"

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/command_proxy.py

@@ -105,6 +105,31 @@ def home(driver: BaseDriver):
     driver.home()
 
 
+@register(Command.BACK)
+def back(driver: BaseDriver):
+    driver.back()
+
+
+@register(Command.APP_SWITCH)
+def app_switch(driver: BaseDriver):
+    driver.app_switch()
+
+
+@register(Command.VOLUME_UP)
+def volume_up(driver: BaseDriver):
+    driver.volume_up()
+
+
+@register(Command.VOLUME_DOWN)
+def volume_down(driver: BaseDriver):
+    driver.volume_down()
+
+
+@register(Command.VOLUME_MUTE)
+def volume_mute(driver: BaseDriver):
+    driver.volume_mute()
+
+
 @register(Command.DUMP)
 def dump(driver: BaseDriver) -> DumpResponse:
     source, _ = driver.dump_hierarchy()

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/command_types.py

@@ -32,6 +32,13 @@ class Command(str, enum.Enum):
 
     LIST = "list"
 
+    # 0.4.0
+    BACK = "back"
+    APP_SWITCH = "appSwitch"
+    VOLUME_UP = "volumeUp"
+    VOLUME_DOWN = "volumeDown"
+    VOLUME_MUTE = "volumeMute"
+
 
 class TapRequest(BaseModel):
     x: Union[int, float]

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/driver/android.py

@@ -9,7 +9,7 @@ import logging
 import re
 import time
 from functools import cached_property, partial
-from typing import List, Tuple
+from typing import List, Optional, Tuple
 from xml.etree import ElementTree
 
 import adbutils
@@ -20,7 +20,7 @@ from uiautodev.command_types import CurrentAppResponse
 from uiautodev.driver.base_driver import BaseDriver
 from uiautodev.driver.udt.udt import UDT, UDTError
 from uiautodev.exceptions import AndroidDriverException, RequestError
-from uiautodev.model import Node, ShellResponse, WindowSize
+from uiautodev.model import Node, Rect, ShellResponse, WindowSize
 from uiautodev.utils.common import fetch_through_socket
 
 logger = logging.getLogger(__name__)
@@ -31,8 +31,8 @@ class AndroidDriver(BaseDriver):
         self.adb_device = adbutils.device(serial)
         self._try_dump_list = [
             self._get_u2_hierarchy,
-            self._get_appium_hierarchy,
             self._get_udt_dump_hierarchy,
+            # self._get_appium_hierarchy,
         ]
     
     @cached_property
@@ -64,16 +64,16 @@ class AndroidDriver(BaseDriver):
         except Exception as e:
             return ShellResponse(output="", error=f"adb error: {str(e)}")
 
-    def dump_hierarchy(self) -> Tuple[str, Node]:
+    def dump_hierarchy(self, display_id: Optional[int] = 0) -> Tuple[str, Node]:
         """returns xml string and hierarchy object"""
-        wsize = self.adb_device.window_size()
-        logger.debug("window size: %s", wsize)
         start = time.time()
         xml_data = self._dump_hierarchy_raw()
         logger.debug("dump_hierarchy cost: %s", time.time() - start)
 
+        wsize = self.adb_device.window_size()
+        logger.debug("window size: %s", wsize)
         return xml_data, parse_xml(
-            xml_data, WindowSize(width=wsize[0], height=wsize[1])
+            xml_data, WindowSize(width=wsize[0], height=wsize[1]), display_id
         )
 
     def _dump_hierarchy_raw(self) -> str:
@@ -99,28 +99,6 @@ class AndroidDriver(BaseDriver):
     def _get_u2_hierarchy(self) -> str:
         d = u2.connect_usb(self.serial)
         return d.dump_hierarchy()
-        # c = self.device.create_connection(adbutils.Network.TCP, 9008)
-        # try:
-        #     compressed = False
-        #     payload = {
-        #         "jsonrpc": "2.0",
-        #         "method": "dumpWindowHierarchy",
-        #         "params": [compressed],
-        #         "id": 1,
-        #     }
-        #     content = fetch_through_socket(
-        #         c, "/jsonrpc/0", method="POST", json=payload, timeout=5
-        #     )
-        #     json_resp = json.loads(content)
-        #     if "error" in json_resp:
-        #         raise AndroidDriverException(json_resp["error"])
-        #     return json_resp["result"]
-        # except adbutils.AdbError as e:
-        #     raise AndroidDriverException(
-        #         f"Failed to get hierarchy from u2 server: {str(e)}"
-        #     )
-        # finally:
-        #     c.close()
 
     def _get_appium_hierarchy(self) -> str:
         c = self.adb_device.create_connection(adbutils.Network.TCP, 6790)
@@ -166,28 +144,51 @@ class AndroidDriver(BaseDriver):
     
     def wake_up(self):
         self.adb_device.keyevent("WAKEUP")
+    
+    def back(self):
+        self.adb_device.keyevent("BACK")
+    
+    def app_switch(self):
+        self.adb_device.keyevent("APP_SWITCH")
+    
+    def volume_up(self):
+        self.adb_device.keyevent("VOLUME_UP")
+    
+    def volume_down(self):
+        self.adb_device.keyevent("VOLUME_DOWN")
+    
+    def volume_mute(self):
+        self.adb_device.keyevent("VOLUME_MUTE")
 
 
-def parse_xml(xml_data: str, wsize: WindowSize) -> Node:
+def parse_xml(xml_data: str, wsize: WindowSize, display_id: Optional[int] = None) -> Node:
     root = ElementTree.fromstring(xml_data)
-    return parse_xml_element(root, wsize)
+    node = parse_xml_element(root, wsize, display_id)
+    if node is None:
+        raise AndroidDriverException("Failed to parse xml")
+    return node
 
 
-def parse_xml_element(
-    element, wsize: WindowSize, indexes: List[int] = [0]
-) -> Node:
+def parse_xml_element(element, wsize: WindowSize, display_id: Optional[int], indexes: List[int] = [0]) -> Optional[Node]:
     """
     Recursively parse an XML element into a dictionary format.
     """
     name = element.tag
     if name == "node":
         name = element.attrib.get("class", "node")
+    if display_id is not None:
+        elem_display_id = int(element.attrib.get("display-id", display_id))
+        if elem_display_id != display_id:
+            return
+
     bounds = None
+    rect = None
     # eg: bounds="[883,2222][1008,2265]"
     if "bounds" in element.attrib:
         bounds = element.attrib["bounds"]
         bounds = list(map(int, re.findall(r"\d+", bounds)))
         assert len(bounds) == 4
+        rect = Rect(x=bounds[0], y=bounds[1], width=bounds[2] - bounds[0], height=bounds[3] - bounds[1])
         bounds = (
             bounds[0] / wsize.width,
             bounds[1] / wsize.height,
@@ -195,16 +196,20 @@ def parse_xml_element(
             bounds[3] / wsize.height,
         )
         bounds = map(partial(round, ndigits=4), bounds)
+        
     elem = Node(
         key="-".join(map(str, indexes)),
         name=name,
         bounds=bounds,
+        rect=rect,
         properties={key: element.attrib[key] for key in element.attrib},
         children=[],
     )
 
     # Construct xpath for children
     for index, child in enumerate(element):
-        elem.children.append(parse_xml_element(child, wsize, indexes + [index]))
+        child_node = parse_xml_element(child, wsize, display_id, indexes + [index])
+        if child_node:
+            elem.children.append(child_node)
 
     return elem

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/driver/base_driver.py

@@ -70,6 +70,26 @@ class BaseDriver(abc.ABC):
     def home(self):
         """ press home button """
         raise NotImplementedError()
+    
+    def back(self):
+        """ press back button """
+        raise NotImplementedError()
+
+    def app_switch(self):
+        """ switch app """
+        raise NotImplementedError()
+    
+    def volume_up(self):
+        """ volume up """
+        raise NotImplementedError()
+    
+    def volume_down(self):
+        """ volume down """
+        raise NotImplementedError()
+    
+    def volume_mute(self):
+        """ volume mute """
+        raise NotImplementedError()
 
     def wake_up(self):
         """ wake up the device """

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/driver/ios.py

@@ -13,13 +13,14 @@ from functools import partial
 from typing import List, Optional, Tuple
 from xml.etree import ElementTree
 
+import wdapy
 from PIL import Image
 
 from uiautodev.command_types import CurrentAppResponse
 from uiautodev.driver.base_driver import BaseDriver
 from uiautodev.exceptions import IOSDriverException
 from uiautodev.model import Node, WindowSize
-from uiautodev.utils.usbmux import MuxDevice, select_device
+from uiautodev.utils.usbmux import select_device
 
 
 class IOSDriver(BaseDriver):
@@ -27,6 +28,7 @@ class IOSDriver(BaseDriver):
         """ serial is the udid of the ios device """
         super().__init__(serial)
         self.device = select_device(serial)
+        self.wda = wdapy.AppiumUSBClient(self.device.serial)
     
     def _request(self, method: str, path: str, payload: Optional[dict] = None) -> bytes:
         conn = self.device.make_http_connection(port=8100)
@@ -56,29 +58,36 @@ class IOSDriver(BaseDriver):
         return self._request_json("GET", "/status")
     
     def screenshot(self, id: int = 0) -> Image.Image:
-        png_base64 = self._request_json_value("GET", "/screenshot")
-        png_data = base64.b64decode(png_base64)
-        return Image.open(io.BytesIO(png_data))
+        return self.wda.screenshot()
     
     def window_size(self):
-        return self._request_json_value("GET", "/window/size")
+        return self.wda.window_size()
     
     def dump_hierarchy(self) -> Tuple[str, Node]:
         """returns xml string and hierarchy object"""
-        xml_data = self._request_json_value("GET", "/source")
+        t = self.wda.sourcetree()
+        xml_data = t.value
         root = ElementTree.fromstring(xml_data)
         return xml_data, parse_xml_element(root, WindowSize(width=1, height=1))
     
     def tap(self, x: int, y: int):
-        self._request("POST", f"/wda/tap/0", {"x": x, "y": y})
+        self.wda.tap(x, y)
     
     def app_current(self) -> CurrentAppResponse:
-        # {'processArguments': {'env': {}, 'args': []}, 'name': '', 'pid': 32, 'bundleId': 'com.apple.springboard'}
-        value = self._request_json_value("GET", "/wda/activeAppInfo")
-        return CurrentAppResponse(package=value["bundleId"], pid=value["pid"])
+        info = self.wda.app_current()
+        return CurrentAppResponse(package=info.bundle_id, pid=info.pid)
 
     def home(self):
-        self._request("POST", "/wda/homescreen")
+        self.wda.homescreen()
+    
+    def app_switch(self):
+        raise NotImplementedError()
+
+    def volume_up(self):
+        self.wda.volume_up()
+    
+    def volume_down(self):
+        self.wda.volume_down()
         
 
 def parse_xml_element(element, wsize: WindowSize, indexes: List[int]=[0]) -> Node:

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/model.py

@@ -24,10 +24,18 @@ class ShellResponse(BaseModel):
     error: Optional[str] = ""
 
 
+class Rect(BaseModel):
+    x: int
+    y: int
+    width: int
+    height: int
+
+
 class Node(BaseModel):
     key: str
     name: str
     bounds: Optional[Tuple[float, float, float, float]] = None
+    rect: Optional[Rect] = None
     properties: Dict[str, Union[str, bool]] = []
     children: List[Node] = []
 

{uiautodev-0.3.6 → uiautodev-0.4.0}/uiautodev/router/device.py

@@ -16,7 +16,6 @@ from uiautodev.command_types import Command, CurrentAppResponse, InstallAppReque
 from uiautodev.model import DeviceInfo, Node, ShellResponse
 from uiautodev.provider import BaseProvider
 
-
 logger = logging.getLogger(__name__)
 
 class AndroidShellPayload(BaseModel):
@@ -58,7 +57,7 @@ def make_router(provider: BaseProvider) -> APIRouter:
         """Take a screenshot of device"""
         try:
             driver = provider.get_device_driver(serial)
-            pil_img = driver.screenshot(id)
+            pil_img = driver.screenshot(id).convert("RGB")
             buf = io.BytesIO()
             pil_img.save(buf, format="JPEG")
             image_bytes = buf.getvalue()
@@ -68,12 +67,17 @@ def make_router(provider: BaseProvider) -> APIRouter:
             return Response(content=str(e), media_type="text/plain", status_code=500)
 
     @router.get("/{serial}/hierarchy")
-    def dump_hierarchy(serial: str) -> Node:
+    def dump_hierarchy(serial: str, format: str = "json") -> Node:
         """Dump the view hierarchy of an Android device"""
         try:
             driver = provider.get_device_driver(serial)
             xml_data, hierarchy = driver.dump_hierarchy()
-            return hierarchy
+            if format == "xml":
+                return Response(content=xml_data, media_type="text/xml")
+            elif format == "json":
+                return hierarchy
+            else:
+                return Response(content=f"Invalid format: {format}", media_type="text/plain", status_code=400)
         except Exception as e:
             logger.exception("dump_hierarchy failed")
             return Response(content=str(e), media_type="text/plain", status_code=500)

uiautodev-0.3.6/uiautodev/__init__.py

@@ -1,12 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""Created on Mon Mar 04 2024 14:28:53 by codeskyblue
-"""
-
-from importlib.metadata import PackageNotFoundError, version
-
-try:
-    __version__ = version("uiautodev")
-except PackageNotFoundError:
-    __version__ = "0.0.0"