uiautodev 0.3.3__tar.gz → 0.3.5__tar.gz

{uiautodev-0.3.3 → uiautodev-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiautodev
-Version: 0.3.3
+Version: 0.3.5
 Summary: Mobile UI Automation, include UI hierarchy inspector, script recorder
 Home-page: https://uiauto.dev
 License: MIT
@@ -19,13 +19,15 @@ Requires-Dist: adbutils (>=2.6.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
-Requires-Dist: fastapi[all] (>=0.109.2,<0.110.0)
+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
+Requires-Dist: poetry (>=1.8.2,<2.0.0)
 Requires-Dist: pygments (>=2)
-Requires-Dist: uiautomator2 (>=3.0.11,<4.0.0)
-Requires-Dist: uvicorn[standard] (>=0.27.1,<0.28.0)
+Requires-Dist: uiautomator2 (>=2)
+Requires-Dist: uvicorn[standard]
 Description-Content-Type: text/markdown
 
 # uiautodev
@@ -36,6 +38,32 @@ https://uiauto.dev
 
 UI Inspector for Android and iOS, help inspector element properties, and auto generate XPath, script.
 
+# Install
+```bash
+pip install uiautodev
+```
+
+# Usage
+```bash
+Usage: uiauto.dev [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -v, --verbose  verbose mode
+  -h, --help     Show this message and exit.
+
+Commands:
+  android      COMMAND: tap, tapElement, installApp, currentApp,...
+  appium       COMMAND: tap, tapElement, installApp, currentApp,...
+  ios          COMMAND: tap, tapElement, installApp, currentApp,...
+  self-update  Update uiautodev to latest version
+  server       start uiauto.dev local server [Default]
+  version      Print version
+```
+
+```bash
+# run local server and open browser
+uiauto.dev
+```
 
 # DEVELOP
 ```bash

uiautodev-0.3.5/README.md

@@ -0,0 +1,52 @@
+# uiautodev
+[![codecov](https://codecov.io/gh/codeskyblue/appinspector/graph/badge.svg?token=aLTg4VOyQH)](https://codecov.io/gh/codeskyblue/appinspector)
+[![PyPI version](https://badge.fury.io/py/uiautodev.svg)](https://badge.fury.io/py/uiautodev)
+
+https://uiauto.dev
+
+UI Inspector for Android and iOS, help inspector element properties, and auto generate XPath, script.
+
+# Install
+```bash
+pip install uiautodev
+```
+
+# Usage
+```bash
+Usage: uiauto.dev [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  -v, --verbose  verbose mode
+  -h, --help     Show this message and exit.
+
+Commands:
+  android      COMMAND: tap, tapElement, installApp, currentApp,...
+  appium       COMMAND: tap, tapElement, installApp, currentApp,...
+  ios          COMMAND: tap, tapElement, installApp, currentApp,...
+  self-update  Update uiautodev to latest version
+  server       start uiauto.dev local server [Default]
+  version      Print version
+```
+
+```bash
+# run local server and open browser
+uiauto.dev
+```
+
+# DEVELOP
+```bash
+# install poetry (python package manager)
+pip install poetry # pipx install poetry
+
+# install deps
+poetry install
+
+# format import
+make format
+
+# run server
+make dev
+```
+
+# LICENSE
+[MIT](LICENSE)

{uiautodev-0.3.3 → uiautodev-0.3.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "uiautodev"
-version = "0.3.3"
+version = "0.3.5"
 description = "Mobile UI Automation, include UI hierarchy inspector, script recorder"
 homepage = "https://uiauto.dev"
 authors = ["codeskyblue <codeskyblue@gmail.com>"]
@@ -9,8 +9,6 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-fastapi = {extras = ["all"], version = "^0.109.2"}
-uvicorn = {extras = ["standard"], version = "^0.27.1"}
 pillow = "*"
 adbutils = "^2.6.0"
 construct = "*"
@@ -19,7 +17,11 @@ click = "^8.1.7"
 pygments = ">=2"
 httpretty = {version = "^1.1.4", optional = true}
 appium-python-client = {version = "^4.0.0", optional = true}
-uiautomator2 = "^3.0.11"
+uiautomator2 = ">=2"
+httpx = "*"
+fastapi = "^0.111.0"
+uvicorn = {version = "*", extras = ["standard"]}
+poetry = "^1.8.2"
 
 [tool.poetry.extras]
 appium = ["appium-python-client", "httppretty"]

{uiautodev-0.3.3 → uiautodev-0.3.5}/uiautodev/app.py

@@ -17,6 +17,7 @@ from fastapi.responses import FileResponse, RedirectResponse
 from pydantic import BaseModel
 
 from uiautodev import __version__
+from uiautodev.common import get_webpage_url
 from uiautodev.provider import AndroidProvider, IOSProvider, MockProvider
 from uiautodev.router.device import make_router
 from uiautodev.router.xml import router as xml_router
@@ -89,4 +90,6 @@ def demo() -> str:
 @app.get("/")
 def index_redirect():
     """ redirect to official homepage """
-    return RedirectResponse("https://uiauto.dev")
+    url = get_webpage_url()
+    logger.debug("redirect to %s", url)
+    return RedirectResponse(url)

{uiautodev-0.3.3 → uiautodev-0.3.5}/uiautodev/cli.py

@@ -8,6 +8,7 @@ from __future__ import annotations
 
 import logging
 import platform
+import subprocess
 import sys
 import threading
 import time
@@ -20,16 +21,22 @@ import uvicorn
 
 from uiautodev import __version__, command_proxy
 from uiautodev.command_types import Command
+from uiautodev.common import get_webpage_url
 from uiautodev.provider import AndroidProvider, BaseProvider, IOSProvider
 from uiautodev.utils.common import convert_params_to_model, print_json
 
 logger = logging.getLogger(__name__)
 
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
-@click.group()
+@click.group(context_settings=CONTEXT_SETTINGS)
 @click.option("--verbose", "-v", is_flag=True, default=False, help="verbose mode")
 def cli(verbose: bool):
     if verbose:
+        # try to enable logger is not very easy
+        # you have to setup logHandler(logFormatter) for the root logger
+        # and set all children logger to DEBUG
+        # that's why it is not easy to use it with logging
         root_logger = logging.getLogger(__name__.split(".")[0])
         root_logger.setLevel(logging.DEBUG)
 
@@ -40,6 +47,12 @@ def cli(verbose: bool):
         console_handler.setFormatter(formatter)
 
         root_logger.addHandler(console_handler)
+
+        # set all children logger to DEBUG
+        for k in root_logger.manager.loggerDict.keys():
+            if k.startswith(root_logger.name+"."):
+                logging.getLogger(k).setLevel(logging.DEBUG)
+        
         logger.debug("Verbose mode enabled")
 
 
@@ -110,15 +123,22 @@ def appium(command: Command, params: list[str] = None):
 
 @cli.command('version')
 def print_version():
+    """ Print version """
     print(__version__)
 
 
-@cli.command(help="start uiauto.dev local server [default]")
+@cli.command('self-update')
+def self_update():
+    """ Update uiautodev to latest version """
+    subprocess.run([sys.executable, '-m', "pip", "install", "--upgrade", "uiautodev"])
+
+
+@cli.command(help="start uiauto.dev local server [Default]")
 @click.option("--port", default=20242, help="port number", show_default=True)
 @click.option("--host", default="127.0.0.1", help="host", show_default=True)
 @click.option("--reload", is_flag=True, default=False, help="auto reload, dev only")
 @click.option("-f", "--force", is_flag=True, default=False, help="shutdown alrealy runningserver")
-@click.option("--no-browser", is_flag=True, default=False, help="do not open browser")
+@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__)
     if force:
@@ -147,7 +167,7 @@ def open_browser_when_server_start(server_url: str):
         except Exception as e:
             time.sleep(0.5)
     import webbrowser
-    web_url = "https://uiauto.dev"
+    web_url = get_webpage_url()
     logger.info("open browser: %s", web_url)
     webbrowser.open(web_url)
 

uiautodev-0.3.5/uiautodev/common.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""Created on Thu May 09 2024 11:33:17 by codeskyblue
+"""
+
+
+import locale
+
+
+def is_chinese_language() -> bool:
+    language_code, _ = locale.getdefaultlocale()
+    
+    # Check if the language code starts with 'zh' (Chinese)
+    if language_code and language_code.startswith('zh'):
+        return True
+    else:
+        return False
+    
+    
+def get_webpage_url() -> str:
+    web_url = "https://uiauto.dev"
+    if is_chinese_language():
+        web_url = "https://uiauto.devsleep.com"
+    return web_url

{uiautodev-0.3.3 → uiautodev-0.3.5}/uiautodev/driver/android.py

@@ -7,7 +7,6 @@
 import json
 import logging
 import re
-import socket
 import time
 from functools import cached_property, partial
 from typing import List, Tuple
@@ -15,6 +14,7 @@ from xml.etree import ElementTree
 
 import adbutils
 import requests
+import uiautomator2 as u2
 from PIL import Image
 
 from uiautodev.command_types import CurrentAppResponse
@@ -34,24 +34,25 @@ class AndroidDriver(BaseDriver):
             self._get_u2_hierarchy,
             self._get_appium_hierarchy,
             self._get_udt_dump_hierarchy,
-            self.device.dump_hierarchy,
-            self._get_u2_lib_hierarchy,
         ]
     
     @cached_property
     def udt(self) -> UDT:    
         return UDT(self.device)
+
+    @cached_property
+    def ud(self) -> u2.Device:
+        return u2.connect_usb(self.serial)
     
     def screenshot(self, id: int) -> Image.Image:
-        # TODO: support multi-display
-        if id > 0:
-            raise ValueError("multi-display is not supported yet")
         try:
-            img = self.device.screenshot()
+            img = self.device.screenshot(display_id=id)
             return img.convert("RGB")
         except adbutils.AdbError as e:
             logger.warning("screenshot error: %s", str(e))
-            return self.udt.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:
@@ -93,20 +94,11 @@ class AndroidDriver(BaseDriver):
                 self._try_dump_list.remove(dump_func)
                 self._try_dump_list.insert(0, dump_func)
                 return result
-            except (
-                requests.RequestException,
-                AndroidDriverException,
-                UDTError,
-                adbutils.AdbError,
-                socket.timeout,
-            ) as e:
-                logger.warning("dump error: %s", e)
             except Exception as e:
                 logger.exception("unexpected dump error: %s", e)
         raise AndroidDriverException("Failed to dump hierarchy")
     
     def _get_u2_hierarchy(self) -> str:
-        import uiautomator2 as u2
         d = u2.connect_usb(self.serial)
         return d.dump_hierarchy()
         # c = self.device.create_connection(adbutils.Network.TCP, 9008)
@@ -146,14 +138,6 @@ class AndroidDriver(BaseDriver):
 
     def _get_udt_dump_hierarchy(self) -> str:
         return self.udt.dump_hierarchy()
-
-    def _get_u2_lib_hierarchy(self) -> str:
-        try:
-            import uiautomator2 as u2
-            d = u2.connect_usb(self.serial)
-            return d.dump_hierarchy()
-        except ModuleNotFoundError:
-            raise AndroidDriverException("uiautomator2 lib not installed")
     
     def tap(self, x: int, y: int):
         self.device.click(x, y)

{uiautodev-0.3.3 → uiautodev-0.3.5}/uiautodev/router/device.py

@@ -5,6 +5,7 @@
 """
 
 import io
+import logging
 from typing import Any, List
 
 from fastapi import APIRouter, Response
@@ -16,6 +17,8 @@ from uiautodev.model import DeviceInfo, Node, ShellResponse
 from uiautodev.provider import BaseProvider
 
 
+logger = logging.getLogger(__name__)
+
 class AndroidShellPayload(BaseModel):
     command: str
 
@@ -31,6 +34,7 @@ def make_router(provider: BaseProvider) -> APIRouter:
         except NotImplementedError as e:
             return Response(content="list_devices not implemented", media_type="text/plain", status_code=501)
         except Exception as e:
+            logger.exception("list_devices failed")
             return Response(content=str(e), media_type="text/plain", status_code=500)
 
     @router.post("/{serial}/shell")
@@ -42,6 +46,7 @@ def make_router(provider: BaseProvider) -> APIRouter:
         except NotImplementedError as e:
             return Response(content="shell not implemented", media_type="text/plain", status_code=501)
         except Exception as e:
+            logger.exception("shell failed")
             return ShellResponse(output="", error=str(e))
 
     @router.get(
@@ -59,6 +64,7 @@ def make_router(provider: BaseProvider) -> APIRouter:
             image_bytes = buf.getvalue()
             return Response(content=image_bytes, media_type="image/jpeg")
         except Exception as e:
+            logger.exception("screenshot failed")
             return Response(content=str(e), media_type="text/plain", status_code=500)
 
     @router.get("/{serial}/hierarchy")
@@ -69,6 +75,7 @@ def make_router(provider: BaseProvider) -> APIRouter:
             xml_data, hierarchy = driver.dump_hierarchy()
             return hierarchy
         except Exception as e:
+            logger.exception("dump_hierarchy failed")
             return Response(content=str(e), media_type="text/plain", status_code=500)
     
     @router.post('/{serial}/command/tap')

uiautodev-0.3.3/README.md

@@ -1,26 +0,0 @@
-# uiautodev
-[![codecov](https://codecov.io/gh/codeskyblue/appinspector/graph/badge.svg?token=aLTg4VOyQH)](https://codecov.io/gh/codeskyblue/appinspector)
-[![PyPI version](https://badge.fury.io/py/uiautodev.svg)](https://badge.fury.io/py/uiautodev)
-
-https://uiauto.dev
-
-UI Inspector for Android and iOS, help inspector element properties, and auto generate XPath, script.
-
-
-# DEVELOP
-```bash
-# install poetry (python package manager)
-pip install poetry # pipx install poetry
-
-# install deps
-poetry install
-
-# format import
-make format
-
-# run server
-make dev
-```
-
-# LICENSE
-[MIT](LICENSE)

{uiautodev-0.3.3 → uiautodev-0.3.5}/uiautodev/driver/udt/udt.py

@@ -6,20 +6,20 @@
 
 
 import atexit
-from base64 import b64decode
 import enum
 import io
 import json
 import logging
-from pprint import pprint
 import threading
 import time
+from base64 import b64decode
 from pathlib import Path
+from pprint import pprint
 from typing import Any, Optional
 
-from PIL import Image
 import adbutils
 import requests
+from PIL import Image
 from pydantic import BaseModel
 
 """