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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 5.1.1
+Version: 5.1.3
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -336,6 +336,93 @@ docs/make.bat
 docs/requirements.txt
 docs/webdriver.common.rst
 docs/webdriver.extensions.android.rst
+docs/webdriver.extensions.flutter_integration.rst
 docs/webdriver.extensions.rst
-docs/webdriver.extensions.search_context.rst
-docs/webdriver.rst
+docs/webdriver.rst
+docs/_build/doctrees/environment.pickle
+docs/_build/doctrees/index.doctree
+docs/_build/doctrees/webdriver.common.doctree
+docs/_build/doctrees/webdriver.doctree
+docs/_build/doctrees/webdriver.extensions.android.doctree
+docs/_build/doctrees/webdriver.extensions.doctree
+docs/_build/doctrees/webdriver.extensions.flutter_integration.doctree
+docs/_build/html/.DS_Store
+docs/_build/html/.buildinfo
+docs/_build/html/.nojekyll
+docs/_build/html/genindex.html
+docs/_build/html/index.html
+docs/_build/html/objects.inv
+docs/_build/html/py-modindex.html
+docs/_build/html/search.html
+docs/_build/html/searchindex.js
+docs/_build/html/webdriver.common.html
+docs/_build/html/webdriver.extensions.android.html
+docs/_build/html/webdriver.extensions.flutter_integration.html
+docs/_build/html/webdriver.extensions.html
+docs/_build/html/webdriver.html
+docs/_build/html/_sources/index.rst.txt
+docs/_build/html/_sources/webdriver.common.rst.txt
+docs/_build/html/_sources/webdriver.extensions.android.rst.txt
+docs/_build/html/_sources/webdriver.extensions.flutter_integration.rst.txt
+docs/_build/html/_sources/webdriver.extensions.rst.txt
+docs/_build/html/_sources/webdriver.rst.txt
+docs/_build/html/_static/.DS_Store
+docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js
+docs/_build/html/_static/basic.css
+docs/_build/html/_static/doctools.js
+docs/_build/html/_static/documentation_options.js
+docs/_build/html/_static/file.png
+docs/_build/html/_static/jquery.js
+docs/_build/html/_static/language_data.js
+docs/_build/html/_static/minus.png
+docs/_build/html/_static/plus.png
+docs/_build/html/_static/pygments.css
+docs/_build/html/_static/searchtools.js
+docs/_build/html/_static/sphinx_highlight.js
+docs/_build/html/_static/css/badge_only.css
+docs/_build/html/_static/css/theme.css
+docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff
+docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2
+docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff
+docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2
+docs/_build/html/_static/css/fonts/fontawesome-webfont.eot
+docs/_build/html/_static/css/fonts/fontawesome-webfont.svg
+docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf
+docs/_build/html/_static/css/fonts/fontawesome-webfont.woff
+docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2
+docs/_build/html/_static/css/fonts/lato-bold-italic.woff
+docs/_build/html/_static/css/fonts/lato-bold-italic.woff2
+docs/_build/html/_static/css/fonts/lato-bold.woff
+docs/_build/html/_static/css/fonts/lato-bold.woff2
+docs/_build/html/_static/css/fonts/lato-normal-italic.woff
+docs/_build/html/_static/css/fonts/lato-normal-italic.woff2
+docs/_build/html/_static/css/fonts/lato-normal.woff
+docs/_build/html/_static/css/fonts/lato-normal.woff2
+docs/_build/html/_static/fonts/.DS_Store
+docs/_build/html/_static/fonts/Lato/lato-bold.eot
+docs/_build/html/_static/fonts/Lato/lato-bold.ttf
+docs/_build/html/_static/fonts/Lato/lato-bold.woff
+docs/_build/html/_static/fonts/Lato/lato-bold.woff2
+docs/_build/html/_static/fonts/Lato/lato-bolditalic.eot
+docs/_build/html/_static/fonts/Lato/lato-bolditalic.ttf
+docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff
+docs/_build/html/_static/fonts/Lato/lato-bolditalic.woff2
+docs/_build/html/_static/fonts/Lato/lato-italic.eot
+docs/_build/html/_static/fonts/Lato/lato-italic.ttf
+docs/_build/html/_static/fonts/Lato/lato-italic.woff
+docs/_build/html/_static/fonts/Lato/lato-italic.woff2
+docs/_build/html/_static/fonts/Lato/lato-regular.eot
+docs/_build/html/_static/fonts/Lato/lato-regular.ttf
+docs/_build/html/_static/fonts/Lato/lato-regular.woff
+docs/_build/html/_static/fonts/Lato/lato-regular.woff2
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff
+docs/_build/html/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2
+docs/_build/html/_static/js/badge_only.js
+docs/_build/html/_static/js/theme.js
+docs/_build/html/_static/js/versions.js

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 5.1.1
+Version: 5.1.3
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/options/android/common/adb/logcat_filter_specs_option.py

@@ -35,7 +35,7 @@ class LogcatFilterSpecsOption(SupportsCapabilities):
         """
         Series of tag[:priority] where tag is a log component tag (or * for all)
         and priority is: V Verbose, D Debug, I Info, W Warn, E Error, F Fatal,
-        S Silent (supress all output). '' means ':d' and tag by itself means tag:v.
+        S Silent (suppress all output). '' means ':d' and tag by itself means tag:v.
         If not specified on the commandline, filterspec is set from ANDROID_LOG_TAGS.
         If no filterspec is found, filter defaults to '*:I'.
         """

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/options/common/base.py

@@ -69,7 +69,7 @@ class AppiumOptions(
         # FIXME: https://github.com/SeleniumHQ/selenium/issues/10755
         self._ignore_local_proxy = False
 
-    def set_capability(self: T, name: str, value: Any) -> T:
+    def set_capability(self: T, name: str, value: Any) -> T:  # type: ignore[override]
         w3c_name = name if name in self.W3C_CAPABILITY_NAMES or ':' in name else f'{APPIUM_PREFIX}{name}'
         if value is None:
             if w3c_name in self._caps:
@@ -93,8 +93,11 @@ class AppiumOptions(
         """
         Formats given capabilities to a valid W3C session request object
 
-        :param capabilities: Capabilities mapping
-        :return: W3C session request object
+        Args:
+            capabilities: Capabilities mapping
+
+        Returns:
+            W3C session request object
         """
 
         def process_key(k: str) -> str:

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/protocols/webdriver/can_find_elements.py

@@ -12,13 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, Dict, List, Protocol, Union
+from typing import TYPE_CHECKING, Dict, List, Protocol, Union, runtime_checkable
 
 if TYPE_CHECKING:
     from appium.webdriver.webelement import WebElement
 
 
+@runtime_checkable
 class CanFindElements(Protocol):
+    """Protocol for objects that can find web elements.
+
+    Any class implementing this protocol must provide:
+    - find_element(by, value): Find a single element
+    - find_elements(by, value): Find multiple elements
+    """
+
     def find_element(self, by: str, value: Union[str, Dict, None] = None) -> 'WebElement': ...
 
     def find_elements(self, by: str, value: Union[str, Dict, None] = None) -> List['WebElement']: ...

appium_python_client-5.1.3/appium/version.py

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

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/appium_connection.py

@@ -39,11 +39,12 @@ class AppiumConnection(RemoteConnection):
     """
     A subclass of selenium.webdriver.remote.remote_connection.Remoteconnection.
 
-    The changes are:
-        - The default user agent
-        - Adds 'X-Idempotency-Key' header in a new session request to avoid proceeding
-          the same request multiple times in the Appium server side.
-            - https://github.com/appium/appium-base-driver/pull/400
+    The changes are
+
+    * The default user agent
+    * Adds 'X-Idempotency-Key' header in a new session request to avoid proceeding
+        the same request multiple times in the Appium server side.
+        * https://github.com/appium/appium-base-driver/pull/400
     """
 
     user_agent = f'{PREFIX_HEADER}{library_version()} ({RemoteConnection.user_agent})'

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/appium_service.py

@@ -54,7 +54,7 @@ class AppiumService:
 
         The service will be forcefully restarted if it is already running.
 
-        Keyword Args:
+        Args:
             env (dict): Environment variables mapping. The default system environment,
                 which is inherited from the parent process, is assigned by default.
             node (str): The full path to the main NodeJS executable. The service will try
@@ -75,9 +75,10 @@ class AppiumService:
                 https://appium.io/docs/en/writing-running-appium/server-args/ for more details
                 about possible arguments and their values.
 
-        :return: You can use Popen.communicate interface or stderr/stdout properties
+        Returns: You can use Popen.communicate interface or stderr/stdout properties
             of the instance (stdout/stderr must not be set to None in such case) in order to retrieve the actual process
             output.
+
         """
         self.stop()
 
@@ -134,9 +135,11 @@ class AppiumService:
         The call will be ignored if the service is not running
         or has been already stopped.
 
-        :param timeout: The maximum time in float seconds to wait
-        for the server process to terminate
-        :return: `True` if the service was running before being stopped
+        Args:
+            timeout: The maximum time in float seconds to wait for the server process to terminate
+
+        Returns:
+            `True` if the service was running before being stopped
         """
         was_running = False
         if self.is_running:
@@ -170,7 +173,8 @@ class AppiumService:
         The default host/port/base path values can be customized by providing
         --address/--port/--base-path command line arguments while starting the service.
 
-        :return: `True` if the service is running and listening on the given/default host/port
+        Returns:
+            `True` if the service is running and listening on the given/default host/port
         """
         if not self.is_running:
             return False
@@ -194,10 +198,13 @@ def is_service_listening(url: str, timeout: float = 5, custom_validator: Optiona
     """
     Check if the service is running
 
-    :param url: Full server url
-    :param timeout: Timeout in float seconds
-    :param custom_validator: Custom callable method to be executed upon each validation loop before the timeout happens
-    :return: True if Appium server is running before the timeout
+    Args:
+        url: Full server url
+        timeout: Timeout in float seconds
+        custom_validator: Custom callable method to be executed upon each validation loop before the timeout happens
+
+    Returns:
+        True if Appium server is running before the timeout
     """
     time_started_sec = time.perf_counter()
     conn = urllib3.PoolManager(timeout=1.0)

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/common/appiumby.py

@@ -49,5 +49,6 @@ ByType = Literal[
     '-flutter semantics label',
     '-flutter type',
     '-flutter key',
+    '-flutter text',
     '-flutter text containing',
 ]

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/android/activities.py

@@ -50,7 +50,9 @@ class Activities(CanExecuteCommands, CanExecuteScripts, CanRememberExtensionPres
             `True` if the target activity is shown
         """
         try:
-            WebDriverWait(self, timeout, interval).until(lambda d: d.current_activity == activity)
+            WebDriverWait(self, timeout, interval).until(  # type: ignore[type-var]
+                lambda d: d.current_activity == activity
+            )
             return True
         except TimeoutException:
             return False

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/android/nativekey.py

@@ -867,7 +867,7 @@ class AndroidKey:
     TV_SATELLITE_SERVICE = 240
 
     # Key code constant: Toggle Network key.
-    # Toggles selecting broacast services.
+    # Toggles selecting broadcast services.
     TV_NETWORK = 241
 
     # Key code constant: Antenna/Cable key.

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/execute_driver.py

@@ -41,7 +41,7 @@ class ExecuteDriver(CanExecuteCommands):
             ExecuteDriver.Result: The result of the script. It has 'result' and 'logs' keys.
 
         Raises:
-            WebDriverException: If something error happenes in the script. The message has the original error message.
+            WebDriverException: If something error happens in the script. The message has the original error message.
         """
 
         class Result:

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/flutter_integration/flutter_commands.py

@@ -41,7 +41,7 @@ class FlutterCommand:
             timeout (Optional[float]): Maximum wait time in seconds. Defaults to a predefined timeout if not specified.
 
         Returns:
-            None:
+            None
         """
         opts: Dict[str, Any] = self.__get_locator_options(locator)
         if timeout is not None:
@@ -193,72 +193,77 @@ class FlutterCommand:
             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": [...]
-                                        }
-                                    ]
-                                }
-                            ]
-                        }
-                    ]
+
+            .. code-block:: 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:
+
+            .. code-block:: python
+
+                >>> 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:
@@ -285,7 +290,7 @@ class FlutterCommand:
         """
         return self.driver.execute_script(f'flutter: {scriptName}', params)
 
-    def __get_locator_options(self, locator: Union[WebElement, 'FlutterFinder']) -> Dict[str, dict]:
+    def __get_locator_options(self, locator: Union[WebElement, 'FlutterFinder']) -> Dict[str, Union[dict, WebElement]]:
         if isinstance(locator, WebElement):
             return {'element': locator}
         return {'locator': locator.to_dict()}

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/flutter_integration/flutter_finder.py

@@ -15,7 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 
-from typing import Tuple, Union
+from typing import Tuple, Union, cast
 
 from selenium.webdriver.common.by import ByType as SeleniumByType
 
@@ -30,23 +30,23 @@ class FlutterFinder:
 
     @staticmethod
     def by_key(value: str) -> 'FlutterFinder':
-        return FlutterFinder(AppiumBy.FLUTTER_INTEGRATION_KEY, value)
+        return FlutterFinder(cast(AppiumByType, AppiumBy.FLUTTER_INTEGRATION_KEY), value)
 
     @staticmethod
     def by_text(value: str) -> 'FlutterFinder':
-        return FlutterFinder(AppiumBy.FLUTTER_INTEGRATION_TEXT, value)
+        return FlutterFinder(cast(AppiumByType, AppiumBy.FLUTTER_INTEGRATION_TEXT), value)
 
     @staticmethod
     def by_semantics_label(value: str) -> 'FlutterFinder':
-        return FlutterFinder(AppiumBy.FLUTTER_INTEGRATION_SEMANTICS_LABEL, value)
+        return FlutterFinder(cast(AppiumByType, AppiumBy.FLUTTER_INTEGRATION_SEMANTICS_LABEL), value)
 
     @staticmethod
     def by_type(value: str) -> 'FlutterFinder':
-        return FlutterFinder(AppiumBy.FLUTTER_INTEGRATION_TYPE, value)
+        return FlutterFinder(cast(AppiumByType, AppiumBy.FLUTTER_INTEGRATION_TYPE), value)
 
     @staticmethod
     def by_text_containing(value: str) -> 'FlutterFinder':
-        return FlutterFinder(AppiumBy.FLUTTER_INTEGRATION_TEXT_CONTAINING, value)
+        return FlutterFinder(cast(AppiumByType, AppiumBy.FLUTTER_INTEGRATION_TEXT_CONTAINING), value)
 
     def to_dict(self) -> dict:
         return {'using': self.using, 'value': self.value}

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/extensions/logs.py

@@ -26,25 +26,25 @@ class Logs(CanExecuteCommands):
         compliant browsers.
 
         Example:
-        --------
-        >>> driver.log_types
+            .. code-block:: python
+
+                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
+        Args:
+            log_type: 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')
+            .. code-block:: python
+
+                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']
 

{appium_python_client-5.1.1 → appium_python_client-5.1.3}/appium/webdriver/mobilecommand.py

@@ -30,9 +30,6 @@ class MobileCommand:
     GET_CURRENT_CONTEXT = 'getCurrentContext'
     SWITCH_TO_CONTEXT = 'switchToContext'
 
-    TOUCH_ACTION = 'touchAction'
-    MULTI_ACTION = 'multiAction'
-
     BACKGROUND = 'background'
     GET_APP_STRINGS = 'getAppStrings'