uiautodev 0.3.7__tar.gz → 0.5.0__tar.gz

{uiautodev-0.3.7 → uiautodev-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiautodev
-Version: 0.3.7
+Version: 0.5.0
 Summary: Mobile UI Automation, include UI hierarchy inspector, script recorder
 Home-page: https://uiauto.dev
 License: MIT
@@ -14,13 +14,10 @@ Classifier: Programming Language :: Python :: 3.9
 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: appium-python-client (>=4.0.0,<5.0.0) ; extra == "appium"
+Requires-Dist: adbutils (>=2.7.0,<3.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: construct
 Requires-Dist: fastapi (>=0.111.0,<0.112.0)
-Requires-Dist: httpretty (>=1.1.4,<2.0.0)
 Requires-Dist: httpx
 Requires-Dist: lxml
 Requires-Dist: pillow
@@ -29,6 +26,7 @@ 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
@@ -37,6 +35,8 @@ Description-Content-Type: text/markdown
 
 https://uiauto.dev
 
+> backup site: https://uiauto.devsleep.com
+
 UI Inspector for Android and iOS, help inspector element properties, and auto generate XPath, script.
 
 # Install

{uiautodev-0.3.7 → uiautodev-0.5.0}/README.md

@@ -4,6 +4,8 @@
 
 https://uiauto.dev
 
+> backup site: https://uiauto.devsleep.com
+
 UI Inspector for Android and iOS, help inspector element properties, and auto generate XPath, script.
 
 # Install

{uiautodev-0.3.7 → uiautodev-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiautodev"
-version = "0.3.7"
+version = "0.5.0"
 description = "Mobile UI Automation, include UI hierarchy inspector, script recorder"
 homepage = "https://uiauto.dev"
 authors = ["codeskyblue <codeskyblue@gmail.com>"]
@@ -10,22 +10,21 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.8"
 pillow = "*"
-adbutils = "^2.6.0"
+adbutils = "^2.7.0"
 construct = "*"
 lxml = "*"
 click = "^8.1.7"
 pygments = ">=2"
-httpretty = {version = "^1.1.4", optional = true}
-appium-python-client = {version = "^4.0.0", optional = true}
 uiautomator2 = ">=2"
 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"]
+#[tool.poetry.extras]
+#appium = ["appium-python-client", "httppretty"]
 
 [tool.poetry.scripts]
 "uiauto.dev" = "uiautodev.__main__:main"

uiautodev-0.5.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.5.0"

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/cli.py

@@ -140,7 +140,7 @@ def self_update():
 @click.option("-f", "--force", is_flag=True, default=False, help="shutdown alrealy runningserver")
 @click.option("-s", "--no-browser", is_flag=True, default=False, help="silent mode, do not open browser")
 def server(port: int, host: str, reload: bool, force: bool, no_browser: bool):
-    logger.info("version: %s", __version__)
+    print("uiautodev version:", __version__)
     if force:
         try:
             httpx.get(f"http://{host}:{port}/shutdown", timeout=3)

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/command_proxy.py

@@ -8,7 +8,7 @@ from __future__ import annotations
 
 import time
 import typing
-from typing import Callable, Dict, Optional
+from typing import Callable, Dict, List, Optional, Union
 
 from pydantic import BaseModel
 
@@ -17,7 +17,7 @@ from uiautodev.command_types import AppLaunchRequest, AppTerminateRequest, By, C
     WindowSizeResponse
 from uiautodev.driver.base_driver import BaseDriver
 from uiautodev.exceptions import ElementNotFoundError
-from uiautodev.model import Node
+from uiautodev.model import Node, AppInfo
 from uiautodev.utils.common import node_travel
 
 COMMANDS: Dict[Command, Callable] = {}
@@ -39,17 +39,21 @@ def get_command_params_type(command: Command) -> Optional[BaseModel]:
     return type_hints.get("params")
 
 
-def send_command(driver: BaseDriver, command: Command, params=None):
+def send_command(driver: BaseDriver, command: Union[str, Command], params=None):
     if command not in COMMANDS:
         raise NotImplementedError(f"command {command} not implemented")
     func = COMMANDS[command]
-    type_hints = typing.get_type_hints(func)
-    if type_hints.get("params"):
+    params_model = get_command_params_type(command)
+    if params_model:
         if params is None:
             raise ValueError(f"params is required for {command}")
-        if not isinstance(params, type_hints["params"]):
-            raise TypeError(f"params should be {type_hints['params']}")
-    if params is None:
+        if isinstance(params, dict):
+            params = params_model.model_validate(params)
+        elif isinstance(params, params_model):
+            pass
+        else:
+            raise TypeError(f"params should be {params_model}", params)
+    if not params:
         return func(driver)
     return func(driver, params)
 
@@ -105,6 +109,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()
@@ -152,3 +181,10 @@ def click_element(driver: BaseDriver, params: FindElementRequest):
     center_x = (node.bounds[0] + node.bounds[2]) / 2
     center_y = (node.bounds[1] + node.bounds[3]) / 2
     tap(driver, TapRequest(x=center_x, y=center_y, isPercent=True))
+
+
+@register(Command.APP_LIST)
+def app_list(driver: BaseDriver) -> List[AppInfo]:
+    # added in v0.5.0
+    return driver.app_list()
+

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/command_types.py

@@ -22,6 +22,7 @@ class Command(str, enum.Enum):
     APP_CURRENT = "currentApp"
     APP_LAUNCH = "appLaunch"
     APP_TERMINATE = "appTerminate"
+    APP_LIST = "appList"
 
     GET_WINDOW_SIZE = "getWindowSize"
     HOME = "home"
@@ -32,6 +33,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.7 → uiautodev-0.5.0}/uiautodev/driver/android.py

@@ -4,12 +4,11 @@
 """Created on Fri Mar 01 2024 14:19:29 by codeskyblue
 """
 
-import json
 import logging
 import re
 import time
 from functools import cached_property, partial
-from typing import List, Optional, Tuple
+from typing import Iterator, List, Optional, Tuple
 from xml.etree import ElementTree
 
 import adbutils
@@ -18,9 +17,8 @@ from PIL import Image
 
 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, Rect, ShellResponse, WindowSize
+from uiautodev.model import Node, AppInfo, Rect, ShellResponse, WindowSize
 from uiautodev.utils.common import fetch_through_socket
 
 logger = logging.getLogger(__name__)
@@ -29,28 +27,15 @@ class AndroidDriver(BaseDriver):
     def __init__(self, serial: str):
         super().__init__(serial)
         self.adb_device = adbutils.device(serial)
-        self._try_dump_list = [
-            self._get_u2_hierarchy,
-            self._get_udt_dump_hierarchy,
-            # self._get_appium_hierarchy,
-        ]
-    
-    @cached_property
-    def udt(self) -> UDT:    
-        return UDT(self.adb_device)
 
     @cached_property
     def ud(self) -> u2.Device:
         return u2.connect_usb(self.serial)
     
     def screenshot(self, id: int) -> Image.Image:
-        try:
-            return self.adb_device.screenshot() # display_id is not OK now
-        except adbutils.AdbError as e:
-            logger.warning("screenshot error: %s", str(e))
-            if id > 0:
-                raise AndroidDriverException("multi-display is not supported yet for uiautomator2")
-            return self.ud.screenshot()
+        if id > 0:
+            raise AndroidDriverException("multi-display is not supported yet for uiautomator2")
+        return self.ud.screenshot()
 
     def shell(self, command: str) -> ShellResponse:
         try:
@@ -82,38 +67,12 @@ class AndroidDriver(BaseDriver):
 
         uiautomator dump errors:
         - ERROR: could not get idle state.
-
         """
-        for dump_func in self._try_dump_list[:]:
-            try:
-                logger.debug(f"try to dump with %s", dump_func.__name__)
-                result = dump_func()
-                logger.debug("dump success")
-                self._try_dump_list.remove(dump_func)
-                self._try_dump_list.insert(0, dump_func)
-                return result
-            except Exception as e:
-                logger.exception("unexpected dump error: %s", e)
-        raise AndroidDriverException("Failed to dump hierarchy")
-    
-    def _get_u2_hierarchy(self) -> str:
-        d = u2.connect_usb(self.serial)
-        return d.dump_hierarchy()
-
-    def _get_appium_hierarchy(self) -> str:
-        c = self.adb_device.create_connection(adbutils.Network.TCP, 6790)
         try:
-            content = fetch_through_socket(c, "/wd/hub/session/0/source", timeout=10)
-            return json.loads(content)["value"]
-        except (adbutils.AdbError, RequestError) as e:
-            raise AndroidDriverException(
-                f"Failed to get hierarchy from appium server: {str(e)}"
-            )
-        finally:
-            c.close()
-
-    def _get_udt_dump_hierarchy(self) -> str:
-        return self.udt.dump_hierarchy()
+            return self.ud.dump_hierarchy()
+        except Exception as e:
+            logger.exception("unexpected dump error: %s", e)
+            raise AndroidDriverException("Failed to dump hierarchy")
     
     def tap(self, x: int, y: int):
         self.adb_device.click(x, y)
@@ -144,6 +103,37 @@ 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 app_list(self) -> List[AppInfo]:
+        results = []
+        output = self.adb_device.shell(["pm", "list", "packages", '-3'])
+        for m in re.finditer(r"^package:([^\s]+)\r?$", output, re.M):
+            packageName = m.group(1)
+            results.append(AppInfo(packageName=packageName))
+        return results
+
+    def open_app_file(self, package: str) -> Iterator[bytes]:
+        line = self.adb_device.shell(f"pm path {package}")
+        if not line.startswith("package:"):
+            raise AndroidDriverException(f"Failed to get package path: {line}")
+        remote_path = line.split(':', 1)[1]
+        yield from self.adb_device.sync.iter_content(remote_path)
+
 
 
 def parse_xml(xml_data: str, wsize: WindowSize, display_id: Optional[int] = None) -> Node:

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/driver/base_driver.py

@@ -4,14 +4,14 @@
 """Created on Fri Mar 01 2024 14:18:30 by codeskyblue
 """
 import abc
-import enum
-from typing import Tuple
+from io import FileIO
+from typing import Iterator, List, Tuple
 
 from PIL import Image
 from pydantic import BaseModel
 
 from uiautodev.command_types import CurrentAppResponse
-from uiautodev.model import Node, ShellResponse, WindowSize
+from uiautodev.model import Node, AppInfo, ShellResponse, WindowSize
 
 
 class BaseDriver(abc.ABC):
@@ -70,7 +70,36 @@ 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 """
-        raise NotImplementedError()
+        raise NotImplementedError()
+    
+    def app_list(self) -> List[AppInfo]:
+        """ list installed packages """
+        raise NotImplementedError()
+    
+    def open_app_file(self, package: str) -> Iterator[bytes]:
+        """ open app file """
+        raise NotImplementedError()
+        

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/driver/ios.py

@@ -5,21 +5,19 @@
 """
 
 
-import base64
-import io
 import json
-import re
 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 +25,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 +55,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.7 → uiautodev-0.5.0}/uiautodev/model.py

@@ -42,4 +42,8 @@ class Node(BaseModel):
 
 class WindowSize(typing.NamedTuple):
     width: int
-    height: int
+    height: int
+
+
+class AppInfo(BaseModel):
+    packageName: str

{uiautodev-0.3.7 → uiautodev-0.5.0}/uiautodev/router/device.py

@@ -6,9 +6,10 @@
 
 import io
 import logging
-from typing import Any, List
+from typing import Any, Dict, List
 
 from fastapi import APIRouter, Response
+from fastapi.responses import StreamingResponse
 from pydantic import BaseModel
 
 from uiautodev import command_proxy
@@ -102,14 +103,25 @@ def make_router(provider: BaseProvider) -> APIRouter:
         return command_proxy.app_current(driver)
 
     @router.post('/{serial}/command/{command}')
-    def _command_proxy_other(serial: str, command: Command, params: Any = None):
+    def _command_proxy_other(serial: str, command: Command, params: Dict[str, Any] = None):
         """Run a command on the device"""
         driver = provider.get_device_driver(serial)
-        func = command_proxy.COMMANDS[command]
-        if params is None:
-            response = func(driver)
-        else:
-            response = func(driver, params)
+        response = command_proxy.send_command(driver, command, params)
         return response
+    
+    @router.get('/{serial}/backupApp')
+    def _backup_app(serial: str, packageName: str):
+        """Backup app
+        
+        Added in 0.5.0
+        """
+        driver = provider.get_device_driver(serial)
+        file_name = f"{packageName}.apk"
+        headers = {
+            'Content-Disposition': f'attachment; filename="{file_name}"'
+        }
+        return StreamingResponse(driver.open_app_file(packageName), headers=headers)
+        
+
 
     return router

uiautodev-0.3.7/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"