pymobiledevice3 5.0.0__py3-none-any.whl → 5.0.2__py3-none-any.whl

pymobiledevice3/cli/webinspector.py

@@ -24,8 +24,13 @@ from pygments.styles import get_style_by_name
 
 from pymobiledevice3.cli.cli_common import Command
 from pymobiledevice3.common import get_home_folder
-from pymobiledevice3.exceptions import InspectorEvaluateError, LaunchingApplicationError, \
-    RemoteAutomationNotEnabledError, WebInspectorNotEnabledError, WirError
+from pymobiledevice3.exceptions import (
+    InspectorEvaluateError,
+    LaunchingApplicationError,
+    RemoteAutomationNotEnabledError,
+    WebInspectorNotEnabledError,
+    WirError,
+)
 from pymobiledevice3.lockdown import LockdownClient, create_using_usbmux
 from pymobiledevice3.lockdown_service_provider import LockdownServiceProvider
 from pymobiledevice3.osu.os_utils import get_os_utils
@@ -34,7 +39,7 @@ from pymobiledevice3.services.web_protocol.driver import By, Cookie, WebDriver
 from pymobiledevice3.services.web_protocol.inspector_session import InspectorSession
 from pymobiledevice3.services.webinspector import SAFARI, ApplicationPage, WebinspectorService
 
-SCRIPT = '''
+SCRIPT = """
 function inspectedPage_evalResult_getCompletions(primitiveType) {{
     var resultSet={{}};
     var object = primitiveType;
@@ -52,15 +57,74 @@ function inspectedPage_evalResult_getCompletions(primitiveType) {{
 try {{
     inspectedPage_evalResult_getCompletions({object})
 }} catch (e) {{}}
-'''
-
-JS_RESERVED_WORDS = ['abstract', 'arguments', 'await', 'boolean', 'break', 'byte', 'case', 'catch', 'char', 'class',
-                     'const', 'continue', 'debugger', 'default', 'delete', 'do', 'double', 'else', 'enum', 'eval',
-                     'export', 'extends', 'false', 'final', 'finally', 'float', 'for', 'function', 'goto', 'if',
-                     'implements', 'import', 'in', 'instanceof', 'int', 'interface', 'let', 'long', 'native', 'new',
-                     'null', 'package', 'private', 'protected', 'public', 'return', 'short', 'static', 'super',
-                     'switch', 'synchronized', 'this', 'throw', 'throws', 'transient', 'true', 'try', 'typeof', 'var',
-                     'void', 'volatile', 'while', 'with', 'yield', ]
+"""
+
+JS_RESERVED_WORDS = [
+    "abstract",
+    "arguments",
+    "await",
+    "boolean",
+    "break",
+    "byte",
+    "case",
+    "catch",
+    "char",
+    "class",
+    "const",
+    "continue",
+    "debugger",
+    "default",
+    "delete",
+    "do",
+    "double",
+    "else",
+    "enum",
+    "eval",
+    "export",
+    "extends",
+    "false",
+    "final",
+    "finally",
+    "float",
+    "for",
+    "function",
+    "goto",
+    "if",
+    "implements",
+    "import",
+    "in",
+    "instanceof",
+    "int",
+    "interface",
+    "let",
+    "long",
+    "native",
+    "new",
+    "null",
+    "package",
+    "private",
+    "protected",
+    "public",
+    "return",
+    "short",
+    "static",
+    "super",
+    "switch",
+    "synchronized",
+    "this",
+    "throw",
+    "throws",
+    "transient",
+    "true",
+    "try",
+    "typeof",
+    "var",
+    "void",
+    "volatile",
+    "while",
+    "with",
+    "yield",
+]
 
 OSUTILS = get_os_utils()
 logger = logging.getLogger(__name__)
@@ -73,7 +137,7 @@ def cli() -> None:
 
 @cli.group()
 def webinspector() -> None:
-    """ Access webinspector services """
+    """Access webinspector services"""
     pass
 
 
@@ -82,11 +146,11 @@ def catch_errors(func):
         try:
             return func(*args, **kwargs)
         except LaunchingApplicationError:
-            logger.error('Unable to launch application (try to unlock device)')
+            logger.exception("Unable to launch application (try to unlock device)")
         except WebInspectorNotEnabledError:
-            logger.error('Web inspector is not enable')
+            logger.exception("Web inspector is not enable")
         except RemoteAutomationNotEnabledError:
-            logger.error('Remote automation is not enable')
+            logger.exception("Remote automation is not enable")
 
     return update_wrapper(catch_function, func)
 
@@ -105,7 +169,7 @@ def create_webinspector_and_launch_app(lockdown: LockdownClient, timeout: float,
 
 
 @webinspector.command(cls=Command)
-@click.option('-t', '--timeout', default=3, show_default=True, type=float)
+@click.option("-t", "--timeout", default=3, show_default=True, type=float)
 @catch_errors
 def opened_tabs(service_provider: LockdownClient, timeout):
     """
@@ -126,8 +190,8 @@ def opened_tabs(service_provider: LockdownClient, timeout):
 
 
 @webinspector.command(cls=Command)
-@click.argument('url')
-@click.option('-t', '--timeout', default=3, show_default=True, type=float)
+@click.argument("url")
+@click.option("-t", "--timeout", default=3, show_default=True, type=float)
 @catch_errors
 def launch(service_provider: LockdownClient, url, timeout):
     """
@@ -146,16 +210,16 @@ def launch(service_provider: LockdownClient, url, timeout):
     inspector, safari = create_webinspector_and_launch_app(service_provider, timeout, SAFARI)
     session = inspector.automation_session(safari)
     driver = WebDriver(session)
-    print('Starting session')
+    print("Starting session")
     driver.start_session()
-    print('Getting URL')
+    print("Getting URL")
     driver.get(url)
     OSUTILS.wait_return()
     session.stop_session()
     inspector.close()
 
 
-SHELL_USAGE = '''
+SHELL_USAGE = """
 # This shell allows you to control the web with selenium like API.
 # The first thing you should do is creating a session:
 driver.start_session()
@@ -173,11 +237,11 @@ driver.add_cookie(
 )
 
 # See selenium api for more features.
-'''
+"""
 
 
 @webinspector.command(cls=Command)
-@click.option('-t', '--timeout', default=3, show_default=True, type=float)
+@click.option("-t", "--timeout", default=3, show_default=True, type=float)
 @catch_errors
 def shell(service_provider: LockdownClient, timeout):
     """
@@ -197,25 +261,27 @@ def shell(service_provider: LockdownClient, timeout):
     driver = WebDriver(session)
     try:
         IPython.embed(
-            header=highlight(SHELL_USAGE, lexers.PythonLexer(), formatters.Terminal256Formatter(style='native')),
+            header=highlight(SHELL_USAGE, lexers.PythonLexer(), formatters.Terminal256Formatter(style="native")),
             user_ns={
-                'driver': driver,
-                'Cookie': Cookie,
-                'By': By,
-            })
+                "driver": driver,
+                "Cookie": Cookie,
+                "By": By,
+            },
+        )
     finally:
         session.stop_session()
         inspector.close()
 
 
 @webinspector.command(cls=Command)
-@click.option('-t', '--timeout', default=3, show_default=True, type=float)
-@click.option('--automation', is_flag=True, help='Use remote automation')
-@click.option('--no-open-safari', is_flag=True, help='Avoid opening the Safari app')
-@click.argument('url', required=False, default='')
+@click.option("-t", "--timeout", default=3, show_default=True, type=float)
+@click.option("--automation", is_flag=True, help="Use remote automation")
+@click.option("--no-open-safari", is_flag=True, help="Avoid opening the Safari app")
+@click.argument("url", required=False, default="")
 @catch_errors
-def js_shell(service_provider: LockdownServiceProvider, timeout: float, automation: bool, no_open_safari: bool,
-             url: str) -> None:
+def js_shell(
+    service_provider: LockdownServiceProvider, timeout: float, automation: bool, no_open_safari: bool, url: str
+) -> None:
     """
     Create a javascript shell. This interpreter runs on your local machine,
     but evaluates each expression on the remote
@@ -234,7 +300,7 @@ def js_shell(service_provider: LockdownServiceProvider, timeout: float, automati
     asyncio.run(run_js_shell(js_shell_class, service_provider, timeout, url, not no_open_safari))
 
 
-udid = ''
+udid = ""
 
 
 def create_app():
@@ -244,8 +310,8 @@ def create_app():
 
 
 @webinspector.command(cls=Command)
-@click.option('--host', default='127.0.0.1')
-@click.option('--port', type=click.INT, default=9222)
+@click.option("--host", default="127.0.0.1")
+@click.option("--port", type=click.INT, default=9222)
 def cdp(service_provider: LockdownClient, host, port):
     """
     Start a CDP server for debugging WebViews.
@@ -256,18 +322,26 @@ def cdp(service_provider: LockdownClient, host, port):
     """
     global udid
     udid = service_provider.udid
-    uvicorn.run('pymobiledevice3.cli.webinspector:create_app', host=host, port=port, factory=True,
-                ws_ping_timeout=None, ws='wsproto', loop='asyncio')
-
-
-def get_js_completions(jsshell: 'JsShell', obj: str, prefix: str) -> list[Completion]:
+    uvicorn.run(
+        "pymobiledevice3.cli.webinspector:create_app",
+        host=host,
+        port=port,
+        factory=True,
+        ws_ping_timeout=None,
+        ws="wsproto",
+        loop="asyncio",
+    )
+
+
+def get_js_completions(jsshell: "JsShell", obj: str, prefix: str) -> list[Completion]:
     if obj in JS_RESERVED_WORDS:
         return []
 
     completions = []
     try:
         for key in asyncio.get_running_loop().run_until_complete(
-                jsshell.evaluate_expression(SCRIPT.format(object=obj), return_by_value=True)):
+            jsshell.evaluate_expression(SCRIPT.format(object=obj), return_by_value=True)
+        ):
             if not key.startswith(prefix):
                 continue
             completions.append(Completion(key.removeprefix(prefix), display=key))
@@ -278,22 +352,20 @@ def get_js_completions(jsshell: 'JsShell', obj: str, prefix: str) -> list[Comple
 
 
 class JsShellCompleter(Completer):
-    def __init__(self, jsshell: 'JsShell'):
+    def __init__(self, jsshell: "JsShell"):
         self.jsshell = jsshell
 
-    def get_completions(
-            self, document: Document, complete_event: CompleteEvent
-    ) -> Iterable[Completion]:
-        text = f'globalThis.{document.text_before_cursor}'
-        text = re.findall('[a-zA-Z_][a-zA-Z_0-9.]+', text)
+    def get_completions(self, document: Document, complete_event: CompleteEvent) -> Iterable[Completion]:
+        text = f"globalThis.{document.text_before_cursor}"
+        text = re.findall("[a-zA-Z_][a-zA-Z_0-9.]+", text)
         if len(text) == 0:
             return []
         text = text[-1]
-        if '.' in text:
-            js_obj, prefix = text.rsplit('.', 1)
+        if "." in text:
+            js_obj, prefix = text.rsplit(".", 1)
         else:
             js_obj = text
-            prefix = ''
+            prefix = ""
 
         return get_js_completions(self.jsshell, js_obj, prefix)
 
@@ -301,11 +373,13 @@ class JsShellCompleter(Completer):
 class JsShell(ABC):
     def __init__(self) -> None:
         super().__init__()
-        self.prompt_session = PromptSession(lexer=PygmentsLexer(lexers.JavascriptLexer),
-                                            auto_suggest=AutoSuggestFromHistory(),
-                                            style=style_from_pygments_cls(get_style_by_name('stata-dark')),
-                                            history=FileHistory(self.webinspector_history_path()),
-                                            completer=JsShellCompleter(self))
+        self.prompt_session = PromptSession(
+            lexer=PygmentsLexer(lexers.JavascriptLexer),
+            auto_suggest=AutoSuggestFromHistory(),
+            style=style_from_pygments_cls(get_style_by_name("stata-dark")),
+            history=FileHistory(self.webinspector_history_path()),
+            completer=JsShellCompleter(self),
+        )
 
     @classmethod
     @abstractmethod
@@ -328,20 +402,19 @@ class JsShell(ABC):
             return
 
         result = await self.evaluate_expression(exp)
-        colorful_result = highlight(f'{result}', lexers.JavascriptLexer(),
-                                    formatters.Terminal256Formatter(style='stata-dark'))
-        print(colorful_result, end='')
+        colorful_result = highlight(
+            f"{result}", lexers.JavascriptLexer(), formatters.Terminal256Formatter(style="stata-dark")
+        )
+        print(colorful_result, end="")
 
-    async def start(self, url: str = ''):
+    async def start(self, url: str = ""):
         if url:
             await self.navigate(url)
         while True:
             try:
                 await self.js_iter()
-            except WirError as e:
-                logger.error(e)
-            except InspectorEvaluateError as e:
-                logger.error(e)
+            except (WirError, InspectorEvaluateError):
+                logger.exception("Failed in js_iter")
             except KeyboardInterrupt:  # KeyboardInterrupt Control-C
                 pass
             except EOFError:  # Control-D
@@ -349,7 +422,7 @@ class JsShell(ABC):
 
     @staticmethod
     def webinspector_history_path() -> str:
-        return str(get_home_folder() / 'webinspector_history')
+        return str(get_home_folder() / "webinspector_history")
 
 
 class AutomationJsShell(JsShell):
@@ -359,7 +432,7 @@ class AutomationJsShell(JsShell):
 
     @classmethod
     @asynccontextmanager
-    async def create(cls, lockdown: LockdownClient, timeout: float, open_safari: bool) -> 'AutomationJsShell':
+    async def create(cls, lockdown: LockdownClient, timeout: float, open_safari: bool) -> "AutomationJsShell":
         inspector, application = create_webinspector_and_launch_app(lockdown, timeout, SAFARI)
         automation_session = inspector.automation_session(application)
         driver = WebDriver(automation_session)
@@ -371,7 +444,7 @@ class AutomationJsShell(JsShell):
             inspector.close()
 
     async def evaluate_expression(self, exp: str, return_by_value: bool = False):
-        return self.driver.execute_script(f'return {exp}')
+        return self.driver.execute_script(f"return {exp}")
 
     async def navigate(self, url: str):
         self.driver.get(url)
@@ -384,7 +457,7 @@ class InspectorJsShell(JsShell):
 
     @classmethod
     @asynccontextmanager
-    async def create(cls, lockdown: LockdownClient, timeout: float, open_safari: bool) -> 'InspectorJsShell':
+    async def create(cls, lockdown: LockdownClient, timeout: float, open_safari: bool) -> "InspectorJsShell":
         inspector = WebinspectorService(lockdown=lockdown)
         inspector.connect(timeout)
         if open_safari:
@@ -409,22 +482,27 @@ class InspectorJsShell(JsShell):
         await self.inspector_session.navigate_to_url(url)
 
     @staticmethod
-    def query_page(inspector: WebinspectorService, bundle_identifier: Optional[str] = None) \
-            -> Optional[ApplicationPage]:
+    def query_page(
+        inspector: WebinspectorService, bundle_identifier: Optional[str] = None
+    ) -> Optional[ApplicationPage]:
         available_pages = inspector.get_open_application_pages(timeout=1)
         if bundle_identifier is not None:
-            available_pages = [application_page for application_page in available_pages if
-                               application_page.application.bundle == bundle_identifier]
+            available_pages = [
+                application_page
+                for application_page in available_pages
+                if application_page.application.bundle == bundle_identifier
+            ]
         if not available_pages:
-            logger.error('Unable to find available pages (try to unlock device)')
+            logger.error("Unable to find available pages (try to unlock device)")
             return None
 
-        page_query = [inquirer3.List('page', message='choose page', choices=available_pages, carousel=True)]
-        page = inquirer3.prompt(page_query, theme=GreenPassion(), raise_keyboard_interrupt=True)['page']
+        page_query = [inquirer3.List("page", message="choose page", choices=available_pages, carousel=True)]
+        page = inquirer3.prompt(page_query, theme=GreenPassion(), raise_keyboard_interrupt=True)["page"]
         return page
 
 
-async def run_js_shell(js_shell_class: type[JsShell], lockdown: LockdownServiceProvider,
-                       timeout: float, url: str, open_safari: bool) -> None:
+async def run_js_shell(
+    js_shell_class: type[JsShell], lockdown: LockdownServiceProvider, timeout: float, url: str, open_safari: bool
+) -> None:
     async with js_shell_class.create(lockdown, timeout, open_safari) as js_shell_instance:
         await js_shell_instance.start(url)

pymobiledevice3/common.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from pymobiledevice3.osu.os_utils import get_os_utils
 
 _OS_UTILS = get_os_utils()
-_HOMEFOLDER = _OS_UTILS.get_homedir() / '.pymobiledevice3'
+_HOMEFOLDER = _OS_UTILS.get_homedir() / ".pymobiledevice3"
 
 
 def get_home_folder() -> Path: