Appium-Python-Client 6.0.11__tar.gz → 6.1.0__tar.gz

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 <!-- version list -->
 
+## v6.1.0 (2026-10-31)
+
+### Features
+
+- Mark ActionHelpers interaction shortcuts as deprecated
+  ([#1333](https://github.com/appium/python-client/pull/1333),
+  [`cd224d9`](https://github.com/appium/python-client/commit/cd224d96597c2134776029b6697f43adce0c49c9))
+
+
+## v6.0.12 (2026-10-31)
+
+### Bug Fixes
+
+- Isolate Appium session idempotency keys
+  ([#1338](https://github.com/appium/python-client/pull/1338),
+  [`07b2360`](https://github.com/appium/python-client/commit/07b23604872c12b45de5630014b1459da6f0388c))
+
+### Documentation
+
+- Clean up Sphinx API doc generation and ExecuteDriver.Result typing
+  ([#1334](https://github.com/appium/python-client/pull/1334),
+  [`50dd05b`](https://github.com/appium/python-client/commit/50dd05befd6538cb46c8cec14d6d2f1b06598e01))
+
+
 ## v6.0.11 (2026-10-31)
 
 ### Bug Fixes

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: Appium-Python-Client
-Version: 6.0.11
+Version: 6.1.0
 Summary: Python client for Appium
 Project-URL: Homepage, https://appium.io/
 Project-URL: Repository, https://github.com/appium/python-client
@@ -152,10 +152,12 @@ For example, some changes in the Selenium binding could break the Appium client.
     - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions or `mobile:` extensions
     - `launch_app`, `close_app`, and `reset` are deprecated. Please read [issues#15807](https://github.com/appium/appium/issues/15807) for more details
 
-#### MultiAction/TouchAction to W3C actions
+#### MultiAction/TouchAction and ActionHelpers Shortcuts to W3C Actions
+
+The interaction shortcut methods on `ActionHelpers` (`scroll`, `drag_and_drop`, `tap`, `swipe`, and `flick`) are deprecated because gesture behavior varies across drivers and pointer types (for example, Android UiAutomator2 handles `POINTER_TOUCH` and `POINTER_MOUSE` inputs differently in the underlying UIAutomator framework). Build W3C WebDriver actions directly with `ActionChains` / `ActionBuilder` instead.
 
 Some elements can be handled with `touch` pointer action instead of the default `mouse` pointer action in the Selenium Python client.
-For example, the below action builder is to replace the default one with the `touch` pointer action.
+For example, the below action builder is to replace the default one with the `touch` pointer action:
 
 ```python
 from selenium.webdriver import ActionChains
@@ -164,7 +166,7 @@ from selenium.webdriver.common.actions.action_builder import ActionBuilder
 from selenium.webdriver.common.actions.pointer_input import PointerInput
 
 actions = ActionChains(driver)
-# override as 'touch' pointer action
+# override as 'touch' pointer action (or use interaction.POINTER_MOUSE for mouse input)
 actions.w3c_actions = ActionBuilder(driver, mouse=PointerInput(interaction.POINTER_TOUCH, 'touch'))
 actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
 actions.w3c_actions.pointer_action.pointer_down()

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/README.md

@@ -124,10 +124,12 @@ For example, some changes in the Selenium binding could break the Appium client.
     - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions or `mobile:` extensions
     - `launch_app`, `close_app`, and `reset` are deprecated. Please read [issues#15807](https://github.com/appium/appium/issues/15807) for more details
 
-#### MultiAction/TouchAction to W3C actions
+#### MultiAction/TouchAction and ActionHelpers Shortcuts to W3C Actions
+
+The interaction shortcut methods on `ActionHelpers` (`scroll`, `drag_and_drop`, `tap`, `swipe`, and `flick`) are deprecated because gesture behavior varies across drivers and pointer types (for example, Android UiAutomator2 handles `POINTER_TOUCH` and `POINTER_MOUSE` inputs differently in the underlying UIAutomator framework). Build W3C WebDriver actions directly with `ActionChains` / `ActionBuilder` instead.
 
 Some elements can be handled with `touch` pointer action instead of the default `mouse` pointer action in the Selenium Python client.
-For example, the below action builder is to replace the default one with the `touch` pointer action.
+For example, the below action builder is to replace the default one with the `touch` pointer action:
 
 ```python
 from selenium.webdriver import ActionChains
@@ -136,7 +138,7 @@ from selenium.webdriver.common.actions.action_builder import ActionBuilder
 from selenium.webdriver.common.actions.pointer_input import PointerInput
 
 actions = ActionChains(driver)
-# override as 'touch' pointer action
+# override as 'touch' pointer action (or use interaction.POINTER_MOUSE for mouse input)
 actions.w3c_actions = ActionBuilder(driver, mouse=PointerInput(interaction.POINTER_TOUCH, 'touch'))
 actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
 actions.w3c_actions.pointer_action.pointer_down()

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/appium/webdriver/appium_connection.py

@@ -56,10 +56,13 @@ class AppiumConnection(RemoteConnection):
         This method will be used in sending a request method in this class.
         """
 
+        extra_headers = cls.extra_headers.copy()
         if parsed_url.path.endswith('/session'):
             # https://github.com/appium/appium-base-driver/pull/400
-            cls.extra_headers[HEADER_IDEMOTENCY_KEY] = str(uuid.uuid4())
+            # Keep the per-request idempotency key local: sessions may be created concurrently.
+            extra_headers[HEADER_IDEMOTENCY_KEY] = str(uuid.uuid4())
         else:
-            cls.extra_headers = _get_new_headers(HEADER_IDEMOTENCY_KEY, cls.extra_headers)
+            extra_headers = _get_new_headers(HEADER_IDEMOTENCY_KEY, extra_headers)
+            cls.extra_headers = extra_headers
 
-        return {**super().get_remote_connection_headers(parsed_url, keep_alive=keep_alive), **cls.extra_headers}
+        return {**super().get_remote_connection_headers(parsed_url, keep_alive=keep_alive), **extra_headers}

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/appium/webdriver/extensions/action_helpers.py

@@ -19,7 +19,7 @@ from selenium.webdriver.common.actions import interaction
 from selenium.webdriver.common.actions.action_builder import ActionBuilder
 from selenium.webdriver.common.actions.mouse_button import MouseButton
 from selenium.webdriver.common.actions.pointer_input import PointerInput
-from typing_extensions import Self
+from typing_extensions import Self, deprecated
 
 from appium.webdriver.webelement import WebElement
 
@@ -29,9 +29,14 @@ if TYPE_CHECKING:
 
 
 class ActionHelpers:
+    @deprecated('Please use W3C actions (ActionChains/ActionBuilder) or mobile: gesture extensions instead.')
     def scroll(self, origin_el: WebElement, destination_el: WebElement, duration: int | None = None) -> Self:
         """Scrolls from one element to another
 
+        .. deprecated::
+            Please use W3C actions (`ActionChains` / `ActionBuilder`) or driver-specific
+            `mobile:` gesture extensions instead.
+
         Args:
             origin_el: the element from which to begin scrolling (center of element)
             destination_el: the element to scroll to (center of element)
@@ -63,9 +68,14 @@ class ActionHelpers:
         actions.perform()
         return self
 
+    @deprecated('Please use W3C actions (ActionChains/ActionBuilder) or mobile: gesture extensions instead.')
     def drag_and_drop(self, origin_el: WebElement, destination_el: WebElement, pause: float | None = None) -> Self:
         """Drag the origin element to the destination element
 
+        .. deprecated::
+            Please use W3C actions (`ActionChains` / `ActionBuilder`) or driver-specific
+            `mobile:` gesture extensions instead.
+
         Args:
             origin_el: the element to drag
             destination_el: the element to drag to
@@ -84,10 +94,15 @@ class ActionHelpers:
         actions.perform()
         return self
 
+    @deprecated('Please use W3C actions (ActionChains/ActionBuilder) or mobile: gesture extensions instead.')
     def tap(self, positions: list[tuple[int, int]], duration: int | None = None) -> Self:
         """Taps on an particular place with up to five fingers, holding for a
         certain time
 
+        .. deprecated::
+            Please use W3C actions (`ActionChains` / `ActionBuilder`) or driver-specific
+            `mobile:` gesture extensions instead.
+
         Args:
             positions: an array of tuples representing the x/y coordinates of
                 the fingers to tap. Length can be up to five.
@@ -132,9 +147,14 @@ class ActionHelpers:
             actions.perform()
         return self
 
+    @deprecated('Please use W3C actions (ActionChains/ActionBuilder) or mobile: gesture extensions instead.')
     def swipe(self, start_x: int, start_y: int, end_x: int, end_y: int, duration: int = 0) -> Self:
         """Swipe from one point to another point, for an optional duration.
 
+        .. deprecated::
+            Please use W3C actions (`ActionChains` / `ActionBuilder`) or driver-specific
+            `mobile:` gesture extensions instead.
+
         Args:
             start_x: x-coordinate at which to start
             start_y: y-coordinate at which to start
@@ -161,9 +181,14 @@ class ActionHelpers:
         actions.perform()
         return self
 
+    @deprecated('Please use W3C actions (ActionChains/ActionBuilder) or mobile: gesture extensions instead.')
     def flick(self, start_x: int, start_y: int, end_x: int, end_y: int) -> Self:
         """Flick from one point to another point.
 
+        .. deprecated::
+            Please use W3C actions (`ActionChains` / `ActionBuilder`) or driver-specific
+            `mobile:` gesture extensions instead.
+
         Args:
             start_x: x-coordinate at which to start
             start_y: y-coordinate at which to start

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/appium/webdriver/extensions/execute_driver.py

@@ -20,8 +20,19 @@ from ..mobilecommand import MobileCommand as Command
 
 
 class ExecuteDriver(CanExecuteCommands):
-    # TODO Inner class case
-    def execute_driver(self, script: str, script_type: str = 'webdriverio', timeout_ms: int | None = None) -> Any:
+    class Result:
+        """The result of ``execute_driver``, containing ``result`` and ``logs``."""
+
+        result: Any
+        logs: dict[str, list[Any]]
+
+        def __init__(self, res: dict[str, Any]) -> None:
+            self.result = res['result']
+            self.logs = res['logs']
+
+    def execute_driver(
+        self, script: str, script_type: str = 'webdriverio', timeout_ms: int | None = None
+    ) -> 'ExecuteDriver.Result':
         """Run a set of script against the current session, allowing execution of many commands in one Appium request.
         Please read http://appium.io/docs/en/commands/session/execute-driver for more details about the acceptable
         scripts and the output format.
@@ -43,18 +54,12 @@ class ExecuteDriver(CanExecuteCommands):
         Raises:
             WebDriverException: If something error happens in the script. The message has the original error message.
         """
-
-        class Result:
-            def __init__(self, res: dict):
-                self.result = res['result']
-                self.logs = res['logs']
-
         option: dict[str, str | int] = {'script': script, 'type': script_type}
         if timeout_ms is not None:
             option['timeout'] = timeout_ms
 
         response = self.execute(Command.EXECUTE_DRIVER, option)['value']
-        return Result(response)
+        return ExecuteDriver.Result(response)
 
     def _add_commands(self) -> None:
         self.command_executor.add_command(Command.EXECUTE_DRIVER, 'POST', '/session/$sessionId/appium/execute_driver')

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/appium/webdriver/extensions/screen_record.py

@@ -188,10 +188,12 @@ class ScreenRecord(CanExecuteCommands):
             headers (dict): [multipart/form-data requests] Headers mapping (Since Appium 1.18.0)
 
         Usage:
-            payload = driver.stop_recording_screen()
-            with open('media.mp4', "wb") as fd:
-                import base64
-                fd.write(base64.b64decode(payload))
+            .. code-block:: python
+
+                payload = driver.stop_recording_screen()
+                with open('media.mp4', "wb") as fd:
+                    import base64
+                    fd.write(base64.b64decode(payload))
 
         Returns:
             bytes: Base-64 encoded content of the recorded media file or an empty string

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/docs/conf.py

@@ -50,9 +50,8 @@ exclude_patterns = []
 #
 html_theme = 'sphinx_rtd_theme'
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
 add_module_names = False
+
+autodoc_default_options = {
+    'exclude-members': 'T',
+}

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/docs/generate.sh

@@ -1,4 +1,4 @@
 #!/bin/sh
 rm -rf *rst _build
-uv run sphinx-apidoc -F -H 'Appium python client' -o . ../appium/webdriver
+uv run sphinx-apidoc -F -H 'Appium python client' -o . ../appium/webdriver ../appium/webdriver/mobilecommand.py
 make html

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/docs/index.rst

@@ -6,9 +6,7 @@
 Appium python client documentation
 ==================================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
+API reference documentation for `Appium-Python-Client <https://github.com/appium/python-client>`_.
 
 
 .. toctree::

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/docs/webdriver.rst

@@ -85,14 +85,6 @@ webdriver.locator\_converter module
    :show-inheritance:
    :undoc-members:
 
-webdriver.mobilecommand module
-------------------------------
-
-.. automodule:: webdriver.mobilecommand
-   :members:
-   :show-inheritance:
-   :undoc-members:
-
 webdriver.switch\_to module
 ---------------------------
 
@@ -124,3 +116,4 @@ Module contents
    :members:
    :show-inheritance:
    :undoc-members:
+   :no-index:

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "Appium-Python-Client"
 description = "Python client for Appium"
-version = "6.0.11"
+version = "6.1.0"
 readme = "README.md"
 license = "Apache-2.0"
 license-files = ["LICENSE"]

{appium_python_client-6.0.11 → appium_python_client-6.1.0}/uv.lock

@@ -27,7 +27,7 @@ wheels = [
 
 [[package]]
 name = "appium-python-client"
-version = "6.0.11"
+version = "6.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "selenium" },