Appium-Python-Client 5.0.0__tar.gz → 5.1.1__tar.gz

{appium_python_client-5.0.0 → appium_python_client-5.1.1}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 5.0.0
+Version: 5.1.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -71,8 +71,9 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`4.5.0`+|`4.26.0`+ | 3.9+ |
-|`4.3.0` -  `4.4.0`|`4.26.0`+ | 3.8+ |
+|`5.1.1`+|`4.26.0`+ | 3.9+ |
+|`4.5.0` - `5.1.0`|`4.26.0` - `4.31.0` | 3.9+ |
+|`4.3.0` -  `4.4.0`|`4.26.0` - `4.31.0` | 3.8+ |
 |`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
@@ -456,10 +457,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.0.0 → appium_python_client-5.1.1}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -307,6 +307,7 @@ appium/webdriver/extensions/images_comparison.py
 appium/webdriver/extensions/keyboard.py
 appium/webdriver/extensions/location.py
 appium/webdriver/extensions/log_event.py
+appium/webdriver/extensions/logs.py
 appium/webdriver/extensions/remote_fs.py
 appium/webdriver/extensions/screen_record.py
 appium/webdriver/extensions/session.py

{appium_python_client-5.0.0 → appium_python_client-5.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 5.0.0
+Version: 5.1.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -71,8 +71,9 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`4.5.0`+|`4.26.0`+ | 3.9+ |
-|`4.3.0` -  `4.4.0`|`4.26.0`+ | 3.8+ |
+|`5.1.1`+|`4.26.0`+ | 3.9+ |
+|`4.5.0` - `5.1.0`|`4.26.0` - `4.31.0` | 3.9+ |
+|`4.3.0` -  `4.4.0`|`4.26.0` - `4.31.0` | 3.8+ |
 |`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
@@ -456,10 +457,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.0.0 → appium_python_client-5.1.1}/README.md

@@ -41,8 +41,9 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`4.5.0`+|`4.26.0`+ | 3.9+ |
-|`4.3.0` -  `4.4.0`|`4.26.0`+ | 3.8+ |
+|`5.1.1`+|`4.26.0`+ | 3.9+ |
+|`4.5.0` - `5.1.0`|`4.26.0` - `4.31.0` | 3.9+ |
+|`4.3.0` -  `4.4.0`|`4.26.0` - `4.31.0` | 3.8+ |
 |`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
@@ -426,10 +427,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.1/appium/version.py

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

{appium_python_client-5.0.0 → appium_python_client-5.1.1}/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-5.1.1/appium/webdriver/extensions/logs.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+
+# 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 typing import Any, Dict, List
+
+from appium.protocols.webdriver.can_execute_commands import CanExecuteCommands
+
+from ..mobilecommand import MobileCommand as Command
+
+
+class Logs(CanExecuteCommands):
+    @property
+    def log_types(self) -> List[str]:
+        """Gets a list of the available log types. This only works with w3c
+        compliant browsers.
+
+        Example:
+        --------
+        >>> driver.log_types
+        """
+        return self.execute(Command.GET_AVAILABLE_LOG_TYPES)['value']
+
+    def get_log(self, log_type: str) -> List[Dict[str, Any]]:
+        """Gets the log for a given log type.
+
+        Parameters:
+        ----------
+        log_type : str
+            - Type of log that which will be returned
+
+        Example:
+        --------
+        >>> driver.get_log('browser')
+        >>> driver.get_log('driver')
+        >>> driver.get_log('client')
+        >>> driver.get_log('server')
+        """
+        return self.execute(Command.GET_LOG, {'type': log_type})['value']
+
+    def _add_commands(self) -> None:
+        self.command_executor.add_command(Command.GET_LOG, 'POST', '/session/$sessionId/se/log')
+        self.command_executor.add_command(Command.GET_AVAILABLE_LOG_TYPES, 'GET', '/session/$sessionId/se/log/types')

{appium_python_client-5.0.0 → appium_python_client-5.1.1}/appium/webdriver/webdriver.py

@@ -54,6 +54,7 @@ from .extensions.images_comparison import ImagesComparison
 from .extensions.keyboard import Keyboard
 from .extensions.location import Location
 from .extensions.log_event import LogEvent
+from .extensions.logs import Logs
 from .extensions.remote_fs import RemoteFS
 from .extensions.screen_record import ScreenRecord
 from .extensions.session import Session
@@ -213,6 +214,7 @@ class WebDriver(
     Keyboard,
     Location,
     LogEvent,
+    Logs,
     Network,
     Performance,
     Power,
@@ -467,9 +469,3 @@ class WebDriver(
 
         self.command_executor.add_command(Command.GET_SCREEN_ORIENTATION, 'GET', '/session/$sessionId/orientation')
         self.command_executor.add_command(Command.SET_SCREEN_ORIENTATION, 'POST', '/session/$sessionId/orientation')
-
-        # override for Appium 1.x
-        # Appium 2.0 and Appium 1.22 work with `/se/log` and `/se/log/types`
-        # FIXME: remove after a while
-        self.command_executor.add_command(Command.GET_LOG, 'POST', '/session/$sessionId/log')
-        self.command_executor.add_command(Command.GET_AVAILABLE_LOG_TYPES, 'GET', '/session/$sessionId/log/types')

appium_python_client-5.0.0/appium/version.py

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