Appium-Python-Client 6.0.11__py3-none-any.whl → 6.1.0__py3-none-any.whl

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/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/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/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.dist-info → appium_python_client-6.1.0.dist-info}/METADATA

@@ -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.dist-info → appium_python_client-6.1.0.dist-info}/RECORD

@@ -271,7 +271,7 @@ appium/protocols/webdriver/can_execute_commands.py,sha256=l6Wq-yL-hzCek9djetnrfp
 appium/protocols/webdriver/can_execute_scripts.py,sha256=dMRDjreiyV3IJp7-NRUx1TjouOu34mLUa9N6qZPq3b0,962
 appium/protocols/webdriver/can_find_elements.py,sha256=glM-Qpe-_KyLhZmojl6aa82B3xhEzRpJPyVQHhtOP8Q,1492
 appium/webdriver/__init__.py,sha256=oT-lIYWpqD562rbXy36HlS03pKfW48BIxqZsqt1XEm0,730
-appium/webdriver/appium_connection.py,sha256=S-CodDwQWjT-lNwyHSsGtdb4GFHxTM9BXGoOyWdMI94,2405
+appium/webdriver/appium_connection.py,sha256=qh6LowDI9_6gwPxy50LGD96YTqKwa0ODGM1RUGOSpks,2580
 appium/webdriver/appium_service.py,sha256=lMfbkiHQIccpqy0_kG7qtO1BbTljIJq8aYTcOQ0ErPY,12172
 appium/webdriver/applicationstate.py,sha256=zUPaMt4o4mdAtWP6FapYLJju_tqO6FmMcYFpbFz83dM,735
 appium/webdriver/client_config.py,sha256=iuVcGsBF9eGNsF_gzs8b6vZWS0iI1u7actaBGBwNrqY,1631
@@ -287,12 +287,12 @@ appium/webdriver/webelement.py,sha256=ewBkxaZiJtmhRoKjQk317WjewansQ6tpm3JePSv1pQ
 appium/webdriver/common/__init__.py,sha256=4MapoJ3p5LiP0AsHMgL2xoPTIFno4dcH1GSoxaZzv4w,623
 appium/webdriver/common/appiumby.py,sha256=1sFzgJht8v9pO0fG-uK1jgbb8zMJwfBy3LJH15OPqq8,1785
 appium/webdriver/extensions/__init__.py,sha256=wSUl6yC2TJNla7xbHXkCfn9J1LpQs9UIx8oOs6V8kZA,567
-appium/webdriver/extensions/action_helpers.py,sha256=LPpEia81XoMMt6ENdP8hvY1WOoy7ST5tzN1NuzQQv-g,8006
+appium/webdriver/extensions/action_helpers.py,sha256=yK_SDJCl-PeepC3C-zXJnfCLkcFwRz3NB_SH4JicFTw,9388
 appium/webdriver/extensions/applications.py,sha256=KnRD9-JilgYtBuy8dik2iGI5GeS2RPQws2BSdKL9HDo,6575
 appium/webdriver/extensions/clipboard.py,sha256=G0qvK5I5DP87IR8A5ICMC-_mtEPktSCOPKif-RZwX2M,3470
 appium/webdriver/extensions/context.py,sha256=Ldhyld4n_JRu9YhgnIOtF-qZQYsXlYrjdYHStcIV2jA,1994
 appium/webdriver/extensions/device_time.py,sha256=CRponsom_3wAEFuxVa6_zUa7BoFkmGCSIeWzCrPTV1g,2009
-appium/webdriver/extensions/execute_driver.py,sha256=vyd8TuLQ2FNKRuSkDnKdGAsjPL4iticaSVFCt3Qg-hI,2583
+appium/webdriver/extensions/execute_driver.py,sha256=UDI3ppN3oEHWgKIRzEhnUMjcjiMo6xWZCaf4MeNPSZw,2744
 appium/webdriver/extensions/execute_mobile_command.py,sha256=a0zxwCTLnrP7ozitzFh0dvXBl2CX3PqLmXRXsLNuWY0,2358
 appium/webdriver/extensions/hw_actions.py,sha256=BCcYzbEW7PbEhf5IPD7Tvr-44sfHfElk_ffi4EhsYF0,4192
 appium/webdriver/extensions/images_comparison.py,sha256=cNdJHn2NFyp9dkFslNLrT4ZRkkKwpELtfrZ0QKXynlU,7674
@@ -301,7 +301,7 @@ appium/webdriver/extensions/location.py,sha256=id6qK3ufhrpsvcFPLNQU0Mx0yXl7Wvth3
 appium/webdriver/extensions/log_event.py,sha256=zF5XoNHSaqFjbGd1bw7gTm-bNOiafTYMgzDJMH2kDj4,2423
 appium/webdriver/extensions/logs.py,sha256=Wlc-aG3arxnVKvjsTAoxU_lHiiPeqe8rdJP3QUEt2mY,1828
 appium/webdriver/extensions/remote_fs.py,sha256=KVYzLpgx7ZIjhRnVmBRPxz4jgSgUqqGrhfx9XBaL31k,3402
-appium/webdriver/extensions/screen_record.py,sha256=ufNpyKJrtvgE9DEbNUMbAlaE9ejF0yECsTK3dw1Doqk,13245
+appium/webdriver/extensions/screen_record.py,sha256=YfdlEtOC_FHtT1B0vXN-MpJQGm2xFvqNlxk2SzKi4HM,13297
 appium/webdriver/extensions/session.py,sha256=P3NSXeIgWHeKK9GDEzkGERIqnIseZDcWUTyAucRpqOg,1414
 appium/webdriver/extensions/settings.py,sha256=WaGFYJ91YK_t9cQJeotxHzp5yYQR7HKoC0DH5Z0VQVs,1921
 appium/webdriver/extensions/android/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -319,7 +319,7 @@ appium/webdriver/extensions/flutter_integration/__init__.py,sha256=wSUl6yC2TJNla
 appium/webdriver/extensions/flutter_integration/flutter_commands.py,sha256=FwNqIykRyMAU8-344GTlceBOxLbS-bA9bfGX4iJpHxw,11985
 appium/webdriver/extensions/flutter_integration/flutter_finder.py,sha256=HH9vGAouJuHzp29Jam_lQGrh67PDq6MxU5Ifewf7C5w,2164
 appium/webdriver/extensions/flutter_integration/scroll_directions.py,sha256=CkOv7k21SMe-h2-EYSZ6MBKBGTRC1csQ-tuowHgMn0E,85
-appium_python_client-6.0.11.dist-info/METADATA,sha256=iUBcndrEVFUXXuJo138Lg1E8RN4oxkKwcXHnkK3_Wn0,21274
-appium_python_client-6.0.11.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
-appium_python_client-6.0.11.dist-info/licenses/LICENSE,sha256=QxeKfXNmPWCfFyrXiwdVzMFPFMK0nlBrKhYLUoIcqhk,11384
-appium_python_client-6.0.11.dist-info/RECORD,,
+appium_python_client-6.1.0.dist-info/METADATA,sha256=lnYvisOqH_pImigF_8hYtOb-kSMOLzqzSnpE2k7oLS4,21766
+appium_python_client-6.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+appium_python_client-6.1.0.dist-info/licenses/LICENSE,sha256=QxeKfXNmPWCfFyrXiwdVzMFPFMK0nlBrKhYLUoIcqhk,11384
+appium_python_client-6.1.0.dist-info/RECORD,,