Appium-Python-Client 4.5.1__tar.gz → 5.1.0__tar.gz

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.5.1
+Version: 5.1.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -89,6 +89,37 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v4 to v5
+- This change affects only for users who specify `keep_alive`, `direct_connection` and `strict_ssl` arguments for `webdriver.Remote`:
+    - Please use `AppiumClientConfig` as `client_config` argument similar to how it is specified below:
+        ```python
+        SERVER_URL_BASE = 'http://127.0.0.1:4723'
+        # before
+        driver = webdriver.Remote(
+            SERVER_URL_BASE,
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            direct_connection=True,
+            keep_alive=False,
+            strict_ssl=False
+        )
+
+        # after
+        from appium.webdriver.client_config import AppiumClientConfig
+        client_config = AppiumClientConfig(
+            remote_server_addr=SERVER_URL_BASE,
+            direct_connection=True,
+            keep_alive=False,
+            ignore_certificates=True,
+        )
+        driver = webdriver.Remote(
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            client_config=client_config
+        )
+        ```
+        - Note that you can keep using `webdriver.Remote(url, options=options, client_config=client_config)` format as well.
+        In such case the `remote_server_addr` argument of `AppiumClientConfig` constructor would have priority over the `url` argument of `webdriver.Remote` constructor.
+- Use `http://127.0.0.1:4723` as the default server url instead of `http://127.0.0.1:4444/wd/hub`
+
 ### Quick migration guide from v3 to v4
 - Removal
     - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
@@ -304,6 +335,7 @@ from appium import webdriver
 # If you use an older client then switch to desired_capabilities
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
+from appium.webdriver.client_config import AppiumClientConfig
 
 # load_capabilities API could be used to
 # load options mapping stored in a dictionary
@@ -313,11 +345,16 @@ options = XCUITestOptions().load_capabilities({
     'app': '/full/path/to/app/UICatalog.app.zip',
 })
 
+client_config = AppiumClientConfig(
+    remote_server_addr='http://127.0.0.1:4723',
+    direct_connection=True
+)
+
 driver = webdriver.Remote(
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     'http://127.0.0.1:4723',
     options=options,
-    direct_connection=True
+    client_config=client_config
 )
 ```
 
@@ -419,10 +456,11 @@ Appium Python Client has `120` seconds read timeout on each HTTP request since t
 the corresponding selenium binding version.
 You have two methods to extend the read timeout.
 
-1. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
-2. Configure timeout via `selenium.webdriver.remote.client_config.ClientConfig`
+1. **Recommend** Configure timeout via `appium.webdriver.client_config.AppiumClientConfig` or `selenium.webdriver.remote.client_config.ClientConfig`
     - `timeout` argument, or
     - `init_args_for_pool_manager` argument for `urllib3.PoolManager`
+2. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
+    - This env var will be removed from the selenium binding ([issue](https://github.com/SeleniumHQ/selenium/issues/15604))
 
 ## Documentation
 

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -282,6 +282,7 @@ appium/webdriver/__init__.py
 appium/webdriver/appium_connection.py
 appium/webdriver/appium_service.py
 appium/webdriver/applicationstate.py
+appium/webdriver/client_config.py
 appium/webdriver/clipboard_content_type.py
 appium/webdriver/command_method.py
 appium/webdriver/connectiontype.py

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.5.1
+Version: 5.1.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -89,6 +89,37 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v4 to v5
+- This change affects only for users who specify `keep_alive`, `direct_connection` and `strict_ssl` arguments for `webdriver.Remote`:
+    - Please use `AppiumClientConfig` as `client_config` argument similar to how it is specified below:
+        ```python
+        SERVER_URL_BASE = 'http://127.0.0.1:4723'
+        # before
+        driver = webdriver.Remote(
+            SERVER_URL_BASE,
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            direct_connection=True,
+            keep_alive=False,
+            strict_ssl=False
+        )
+
+        # after
+        from appium.webdriver.client_config import AppiumClientConfig
+        client_config = AppiumClientConfig(
+            remote_server_addr=SERVER_URL_BASE,
+            direct_connection=True,
+            keep_alive=False,
+            ignore_certificates=True,
+        )
+        driver = webdriver.Remote(
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            client_config=client_config
+        )
+        ```
+        - Note that you can keep using `webdriver.Remote(url, options=options, client_config=client_config)` format as well.
+        In such case the `remote_server_addr` argument of `AppiumClientConfig` constructor would have priority over the `url` argument of `webdriver.Remote` constructor.
+- Use `http://127.0.0.1:4723` as the default server url instead of `http://127.0.0.1:4444/wd/hub`
+
 ### Quick migration guide from v3 to v4
 - Removal
     - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
@@ -304,6 +335,7 @@ from appium import webdriver
 # If you use an older client then switch to desired_capabilities
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
+from appium.webdriver.client_config import AppiumClientConfig
 
 # load_capabilities API could be used to
 # load options mapping stored in a dictionary
@@ -313,11 +345,16 @@ options = XCUITestOptions().load_capabilities({
     'app': '/full/path/to/app/UICatalog.app.zip',
 })
 
+client_config = AppiumClientConfig(
+    remote_server_addr='http://127.0.0.1:4723',
+    direct_connection=True
+)
+
 driver = webdriver.Remote(
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     'http://127.0.0.1:4723',
     options=options,
-    direct_connection=True
+    client_config=client_config
 )
 ```
 
@@ -419,10 +456,11 @@ Appium Python Client has `120` seconds read timeout on each HTTP request since t
 the corresponding selenium binding version.
 You have two methods to extend the read timeout.
 
-1. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
-2. Configure timeout via `selenium.webdriver.remote.client_config.ClientConfig`
+1. **Recommend** Configure timeout via `appium.webdriver.client_config.AppiumClientConfig` or `selenium.webdriver.remote.client_config.ClientConfig`
     - `timeout` argument, or
     - `init_args_for_pool_manager` argument for `urllib3.PoolManager`
+2. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
+    - This env var will be removed from the selenium binding ([issue](https://github.com/SeleniumHQ/selenium/issues/15604))
 
 ## Documentation
 

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/README.md

@@ -59,6 +59,37 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v4 to v5
+- This change affects only for users who specify `keep_alive`, `direct_connection` and `strict_ssl` arguments for `webdriver.Remote`:
+    - Please use `AppiumClientConfig` as `client_config` argument similar to how it is specified below:
+        ```python
+        SERVER_URL_BASE = 'http://127.0.0.1:4723'
+        # before
+        driver = webdriver.Remote(
+            SERVER_URL_BASE,
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            direct_connection=True,
+            keep_alive=False,
+            strict_ssl=False
+        )
+
+        # after
+        from appium.webdriver.client_config import AppiumClientConfig
+        client_config = AppiumClientConfig(
+            remote_server_addr=SERVER_URL_BASE,
+            direct_connection=True,
+            keep_alive=False,
+            ignore_certificates=True,
+        )
+        driver = webdriver.Remote(
+            options=UiAutomator2Options().load_capabilities(desired_caps),
+            client_config=client_config
+        )
+        ```
+        - Note that you can keep using `webdriver.Remote(url, options=options, client_config=client_config)` format as well.
+        In such case the `remote_server_addr` argument of `AppiumClientConfig` constructor would have priority over the `url` argument of `webdriver.Remote` constructor.
+- Use `http://127.0.0.1:4723` as the default server url instead of `http://127.0.0.1:4444/wd/hub`
+
 ### Quick migration guide from v3 to v4
 - Removal
     - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
@@ -274,6 +305,7 @@ from appium import webdriver
 # If you use an older client then switch to desired_capabilities
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
+from appium.webdriver.client_config import AppiumClientConfig
 
 # load_capabilities API could be used to
 # load options mapping stored in a dictionary
@@ -283,11 +315,16 @@ options = XCUITestOptions().load_capabilities({
     'app': '/full/path/to/app/UICatalog.app.zip',
 })
 
+client_config = AppiumClientConfig(
+    remote_server_addr='http://127.0.0.1:4723',
+    direct_connection=True
+)
+
 driver = webdriver.Remote(
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     'http://127.0.0.1:4723',
     options=options,
-    direct_connection=True
+    client_config=client_config
 )
 ```
 
@@ -389,10 +426,11 @@ Appium Python Client has `120` seconds read timeout on each HTTP request since t
 the corresponding selenium binding version.
 You have two methods to extend the read timeout.
 
-1. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
-2. Configure timeout via `selenium.webdriver.remote.client_config.ClientConfig`
+1. **Recommend** Configure timeout via `appium.webdriver.client_config.AppiumClientConfig` or `selenium.webdriver.remote.client_config.ClientConfig`
     - `timeout` argument, or
     - `init_args_for_pool_manager` argument for `urllib3.PoolManager`
+2. Set `GLOBAL_DEFAULT_TIMEOUT` environment variable
+    - This env var will be removed from the selenium binding ([issue](https://github.com/SeleniumHQ/selenium/issues/15604))
 
 ## Documentation
 

appium_python_client-5.1.0/appium/version.py

@@ -0,0 +1 @@
+version = '5.1.0'

appium_python_client-5.1.0/appium/webdriver/client_config.py

@@ -0,0 +1,38 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from selenium.webdriver.remote.client_config import ClientConfig
+
+
+class AppiumClientConfig(ClientConfig):
+    """ClientConfig class for Appium Python client.
+    This class inherits selenium.webdriver.remote.client_config.ClientConfig.
+    """
+
+    def __init__(self, remote_server_addr: str, *args, **kwargs):
+        """
+        Please refer to selenium.webdriver.remote.client_config.ClientConfig documentation
+        about available arguments. Only 'direct_connection' below is AppiumClientConfig
+        specific argument.
+
+        Args:
+            direct_connection: If enables [directConnect](https://github.com/appium/python-client?tab=readme-ov-file#direct-connect-urls)
+            feature.
+        """
+        self._direct_connection = kwargs.pop('direct_connection', False)
+        super().__init__(remote_server_addr, *args, **kwargs)
+
+    @property
+    def direct_connection(self) -> bool:
+        """Return if [directConnect](https://github.com/appium/python-client?tab=readme-ov-file#direct-connect-urls)
+        is enabled."""
+        return self._direct_connection

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/appium/webdriver/extensions/flutter_integration/flutter_commands.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 import os
-from typing import Any, Dict, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 from appium.common.helper import encode_file_to_base64
 from appium.webdriver.extensions.flutter_integration.flutter_finder import FlutterFinder
@@ -172,6 +172,104 @@ class FlutterCommand:
         """
         self.execute_flutter_command('activateInjectedImage', {'imageId': image_id})
 
+    def get_render_tree(
+        self,
+        widget_type: Optional[str] = None,
+        key: Optional[str] = None,
+        text: Optional[str] = None,
+    ) -> List[Optional[Dict]]:
+        """
+        Returns the render tree of the root widget.
+
+        Args:
+            widget_type (Optional[str]): The type of the widget to primary filter by.
+            key (Optional[str]): The key of the widget to filter by.
+            text (Optional[str]): The text of the widget to filter by.
+
+        Returns:
+            List[Optional[Dict]]: A list of dictionaries or None values representing the render tree.
+
+            The result is a nested list of dictionaries representing each widget and its properties,
+            such as type, key, size, attribute, state, visual information, and hierarchy.
+
+            The example widget includes the following code, which is rendered as part of the widget tree:
+            ```dart
+            Semantics(
+              key: const Key('add_activity_semantics'),
+              label: 'add_activity_button',
+              button: true,
+              child: FloatingActionButton.small(
+                key: const Key('add_activity_button'),
+                tooltip: 'add_activity_button',
+                heroTag: 'add',
+                backgroundColor: const Color(0xFF2E2E3A),
+                onPressed: null,
+                child: Icon(
+                  Icons.add,
+                  size: 16,
+                  color: Colors.amber.shade200.withOpacity(0.5),
+                  semanticLabel: 'Add icon',
+                ),
+              ),
+            ),
+            ```
+            Example execute command:
+            >>> flutter_command = FlutterCommand(driver)  # noqa
+            >>> flutter_command.get_render_tree(widget_type='Semantics', key='add_activity_semantics')
+            output >> [
+                        {
+                            "type": "Semantics",
+                            "elementType": "SingleChildRenderObjectElement",
+                            "description": "Semantics-[<'add_activity_semantics'>]",
+                            "depth": 0,
+                            "key": "[<'add_activity_semantics'>]",
+                            "attributes": {
+                                "semanticsLabel": "add_activity_button"
+                            },
+                            "visual": {},
+                            "state": {},
+                            "rect": {
+                                "x": 0,
+                                "y": 0,
+                                "width": 48,
+                                "height": 48
+                            },
+                            "children": [
+                                {
+                                    "type": "FloatingActionButton",
+                                    "elementType": "StatelessElement",
+                                    "description": "FloatingActionButton-[<'add_activity_button'>]",
+                                    "depth": 1,
+                                    "key": "[<'add_activity_button'>]",
+                                    "attributes": {},
+                                    "visual": {},
+                                    "state": {},
+                                    "rect": {
+                                        "x": 0,
+                                        "y": 0,
+                                        "width": 48,
+                                        "height": 48
+                                    },
+                                    "children": [
+                                        {...},
+                                            "children": [...]
+                                        }
+                                    ]
+                                }
+                            ]
+                        }
+                    ]
+        """
+        opts = {}
+        if widget_type is not None:
+            opts['widgetType'] = widget_type
+        if key is not None:
+            opts['key'] = key
+        if text is not None:
+            opts['text'] = text
+
+        return self.execute_flutter_command('renderTree', opts)
+
     def execute_flutter_command(self, scriptName: str, params: dict) -> Any:
         """
         Executes a Flutter command by sending a script and parameters to the flutter integration driver.

{appium_python_client-4.5.1 → appium_python_client-5.1.0}/appium/webdriver/webdriver.py

@@ -22,7 +22,6 @@ from selenium.common.exceptions import (
     WebDriverException,
 )
 from selenium.webdriver.common.by import By
-from selenium.webdriver.remote.client_config import ClientConfig
 from selenium.webdriver.remote.command import Command as RemoteCommand
 from selenium.webdriver.remote.remote_connection import RemoteConnection
 from typing_extensions import Self
@@ -32,6 +31,7 @@ from appium.options.common.base import AppiumOptions
 from appium.webdriver.common.appiumby import AppiumBy
 
 from .appium_connection import AppiumConnection
+from .client_config import AppiumClientConfig
 from .errorhandler import MobileErrorHandler
 from .extensions.action_helpers import ActionHelpers
 from .extensions.android.activities import Activities
@@ -174,6 +174,27 @@ class ExtensionBase:
         raise NotImplementedError()
 
 
+def _get_remote_connection_and_client_config(
+    command_executor: Union[str, AppiumConnection], client_config: Optional[AppiumClientConfig] = None
+) -> tuple[AppiumConnection, Optional[AppiumClientConfig]]:
+    """Return the pair of command executor and client config.
+    If the given command executor is a custom one, returned client config will
+    be None since the custom command executor has its own client config already.
+    The custom command executor's one will be prior than the given client config.
+    """
+    if not isinstance(command_executor, str):
+        # client config already defined in the custom command executor
+        # will be prior than the given one.
+        return (command_executor, None)
+
+    # command_executor is str
+
+    # Do not keep None to avoid warnings in Selenium
+    # which can prevent with ClientConfig instance usage.
+    new_client_config = AppiumClientConfig(remote_server_addr=command_executor) if client_config is None else client_config
+    return (AppiumConnection(client_config=new_client_config), new_client_config)
+
+
 class WebDriver(
     webdriver.Remote,
     ActionHelpers,
@@ -202,28 +223,16 @@ class WebDriver(
     Sms,
     SystemBars,
 ):
-    def __init__(  # noqa: PLR0913
+    def __init__(
         self,
-        command_executor: Union[str, AppiumConnection] = 'http://127.0.0.1:4444/wd/hub',
-        keep_alive: bool = True,
-        direct_connection: bool = True,
+        command_executor: Union[str, AppiumConnection] = 'http://127.0.0.1:4723',
         extensions: Optional[List['WebDriver']] = None,
-        strict_ssl: bool = True,
         options: Union[AppiumOptions, List[AppiumOptions], None] = None,
-        client_config: Optional[ClientConfig] = None,
+        client_config: Optional[AppiumClientConfig] = None,
     ):
-        if isinstance(command_executor, str):
-            client_config = client_config or ClientConfig(
-                remote_server_addr=command_executor, keep_alive=keep_alive, ignore_certificates=not strict_ssl
-            )
-            client_config.remote_server_addr = command_executor
-            command_executor = AppiumConnection(client_config=client_config)
-        elif isinstance(command_executor, AppiumConnection) and strict_ssl is False:
-            logger.warning(
-                "Please set 'ignore_certificates' in the given 'appium.webdriver.appium_connection.AppiumConnection' or "
-                "'selenium.webdriver.remote.client_config.ClientConfig' instead. Ignoring."
-            )
-
+        command_executor, client_config = _get_remote_connection_and_client_config(
+            command_executor=command_executor, client_config=client_config
+        )
         super().__init__(
             command_executor=command_executor,
             options=options,
@@ -232,13 +241,12 @@ class WebDriver(
             client_config=client_config,
         )
 
-        if hasattr(self, 'command_executor'):
-            self._add_commands()
+        self._add_commands()
 
         self.error_handler = MobileErrorHandler()
 
-        if direct_connection:
-            self._update_command_executor(keep_alive=keep_alive)
+        if client_config and client_config.direct_connection:
+            self._update_command_executor(keep_alive=client_config.keep_alive)
 
         # add new method to the `find_by_*` pantheon
         By.IOS_PREDICATE = AppiumBy.IOS_PREDICATE

appium_python_client-4.5.1/appium/version.py

@@ -1 +0,0 @@
-version = '4.5.1'