Appium-Python-Client 3.1.0__tar.gz → 3.2.0__tar.gz

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 3.1.0
+Version: 3.2.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -8,7 +8,6 @@ Author-email: isaac@saucelabs.com
 Maintainer: Kazuaki Matsuo, Mykola Mokhnach, Mori Atsushi
 License: Apache 2.0
 Keywords: appium,selenium,selenium 4,python client,mobile automation
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
@@ -89,6 +88,10 @@ For example, some changes in the Selenium binding could break the Appium client.
 
 
 ### Quick migration guide from v2 to v3
+- `options` keyword argument in the `webdriver.Remote` constructor such as `XCUITestOptions` instead of `desired_capabilities`
+    - Available options are https://github.com/appium/python-client/tree/master/appium/options
+        - Please check the [Usage](#usage) below as an exampple.
+    - Not a "new" change, but the `desired_capabilities` argument has been removed since v3.
 - Replacement
     - `start_activity` method: Please use [`mobile: startActivity`](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#mobile-startactivity)
     - `launch_app`, `close_app` and `reset` methods: Please refer to https://github.com/appium/appium/issues/15807
@@ -96,8 +99,8 @@ For example, some changes in the Selenium binding could break the Appium client.
     - `set_value` and `set_text` methods: Please use `element.send_keys` or `send_keys` by W3C Actions
 - Removal
     - `end_test_coverage` method is no longer available
-    - `session` properly is no longer available
-    - `all_sessions` properly is no longer available
+    - `session` property is no longer available
+    - `all_sessions` property is no longer available
 
 ### Quick migration guide from v1 to v2
 - Enhancement
@@ -107,10 +110,10 @@ For example, some changes in the Selenium binding could break the Appium client.
         - Please check each behavior. Their behaviors could slightly differ.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
-    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions.
+    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions or `mobile:` extensions
         - e.g.
             - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
-            - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
+            - https://www.selenium.dev/documentation/webdriver/actions_api/
             - https://www.youtube.com/watch?v=oAJ7jwMNFVU
             - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
             - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
@@ -122,8 +125,10 @@ On UIA2, some elements can be handled with `touch` pointer action instead of the
 For example, the below action builder is to replace the default one with the `touch` pointer action.
 
 ```python
+from selenium.webdriver import ActionChains
 from selenium.webdriver.common.actions import interaction
 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
@@ -136,6 +141,9 @@ actions.w3c_actions.pointer_action.release()
 actions.perform()
 ```
 
+- [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+- https://www.selenium.dev/documentation/webdriver/actions_api/
+
 ## Usage
 
 The Appium Python Client is fully compliant with the WebDriver Protocol
@@ -177,7 +185,7 @@ APPIUM_HOST = '127.0.0.1'
 def appium_service():
     service = AppiumService()
     service.start(
-        # Check the output of `appium server --help` for the complete list of 
+        # Check the output of `appium server --help` for the complete list of
         # server command line arguments
         args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)],
         timeout_ms=20000,
@@ -186,7 +194,7 @@ def appium_service():
     service.stop()
 
 
-def create_ios_driver(custom_opts = None):    
+def create_ios_driver(custom_opts = None):
     options = XCUITestOptions()
     options.platformVersion = '13.4'
     options.udid = '123456789ABC'
@@ -194,9 +202,9 @@ def create_ios_driver(custom_opts = None):
         options.load_capabilities(custom_opts)
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)
-    
 
-def create_android_driver(custom_opts = None):    
+
+def create_android_driver(custom_opts = None):
     options = UiAutomator2Options()
     options.platformVersion = '10'
     options.udid = '123456789ABC'
@@ -209,16 +217,16 @@ def create_android_driver(custom_opts = None):
 @pytest.fixture
 def ios_driver_factory():
     return create_ios_driver
-    
+
 
 @pytest.fixture
 def ios_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_ios_driver()
     yield driver
     driver.quit()
 
-    
+
 @pytest.fixture
 def android_driver_factory():
     return create_android_driver
@@ -226,12 +234,12 @@ def android_driver_factory():
 
 @pytest.fixture
 def android_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_android_driver()
     yield driver
     driver.quit()
 
-            
+
 def test_ios_click(appium_service, ios_driver_factory):
     # Usage of the context manager ensures the driver session is closed properly
     # after the test completes. Otherwise, make sure to call `driver.quit()` on teardown.
@@ -438,5 +446,3 @@ $ ./release.sh # release
 ## License
 
 Apache License v2
-
-

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 3.1.0
+Version: 3.2.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -8,7 +8,6 @@ Author-email: isaac@saucelabs.com
 Maintainer: Kazuaki Matsuo, Mykola Mokhnach, Mori Atsushi
 License: Apache 2.0
 Keywords: appium,selenium,selenium 4,python client,mobile automation
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
@@ -89,6 +88,10 @@ For example, some changes in the Selenium binding could break the Appium client.
 
 
 ### Quick migration guide from v2 to v3
+- `options` keyword argument in the `webdriver.Remote` constructor such as `XCUITestOptions` instead of `desired_capabilities`
+    - Available options are https://github.com/appium/python-client/tree/master/appium/options
+        - Please check the [Usage](#usage) below as an exampple.
+    - Not a "new" change, but the `desired_capabilities` argument has been removed since v3.
 - Replacement
     - `start_activity` method: Please use [`mobile: startActivity`](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#mobile-startactivity)
     - `launch_app`, `close_app` and `reset` methods: Please refer to https://github.com/appium/appium/issues/15807
@@ -96,8 +99,8 @@ For example, some changes in the Selenium binding could break the Appium client.
     - `set_value` and `set_text` methods: Please use `element.send_keys` or `send_keys` by W3C Actions
 - Removal
     - `end_test_coverage` method is no longer available
-    - `session` properly is no longer available
-    - `all_sessions` properly is no longer available
+    - `session` property is no longer available
+    - `all_sessions` property is no longer available
 
 ### Quick migration guide from v1 to v2
 - Enhancement
@@ -107,10 +110,10 @@ For example, some changes in the Selenium binding could break the Appium client.
         - Please check each behavior. Their behaviors could slightly differ.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
-    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions.
+    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions or `mobile:` extensions
         - e.g.
             - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
-            - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
+            - https://www.selenium.dev/documentation/webdriver/actions_api/
             - https://www.youtube.com/watch?v=oAJ7jwMNFVU
             - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
             - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
@@ -122,8 +125,10 @@ On UIA2, some elements can be handled with `touch` pointer action instead of the
 For example, the below action builder is to replace the default one with the `touch` pointer action.
 
 ```python
+from selenium.webdriver import ActionChains
 from selenium.webdriver.common.actions import interaction
 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
@@ -136,6 +141,9 @@ actions.w3c_actions.pointer_action.release()
 actions.perform()
 ```
 
+- [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+- https://www.selenium.dev/documentation/webdriver/actions_api/
+
 ## Usage
 
 The Appium Python Client is fully compliant with the WebDriver Protocol
@@ -177,7 +185,7 @@ APPIUM_HOST = '127.0.0.1'
 def appium_service():
     service = AppiumService()
     service.start(
-        # Check the output of `appium server --help` for the complete list of 
+        # Check the output of `appium server --help` for the complete list of
         # server command line arguments
         args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)],
         timeout_ms=20000,
@@ -186,7 +194,7 @@ def appium_service():
     service.stop()
 
 
-def create_ios_driver(custom_opts = None):    
+def create_ios_driver(custom_opts = None):
     options = XCUITestOptions()
     options.platformVersion = '13.4'
     options.udid = '123456789ABC'
@@ -194,9 +202,9 @@ def create_ios_driver(custom_opts = None):
         options.load_capabilities(custom_opts)
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)
-    
 
-def create_android_driver(custom_opts = None):    
+
+def create_android_driver(custom_opts = None):
     options = UiAutomator2Options()
     options.platformVersion = '10'
     options.udid = '123456789ABC'
@@ -209,16 +217,16 @@ def create_android_driver(custom_opts = None):
 @pytest.fixture
 def ios_driver_factory():
     return create_ios_driver
-    
+
 
 @pytest.fixture
 def ios_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_ios_driver()
     yield driver
     driver.quit()
 
-    
+
 @pytest.fixture
 def android_driver_factory():
     return create_android_driver
@@ -226,12 +234,12 @@ def android_driver_factory():
 
 @pytest.fixture
 def android_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_android_driver()
     yield driver
     driver.quit()
 
-            
+
 def test_ios_click(appium_service, ios_driver_factory):
     # Usage of the context manager ensures the driver session is closed properly
     # after the test completes. Otherwise, make sure to call `driver.quit()` on teardown.
@@ -438,5 +446,3 @@ $ ./release.sh # release
 ## License
 
 Apache License v2
-
-

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/README.md

@@ -60,6 +60,10 @@ For example, some changes in the Selenium binding could break the Appium client.
 
 
 ### Quick migration guide from v2 to v3
+- `options` keyword argument in the `webdriver.Remote` constructor such as `XCUITestOptions` instead of `desired_capabilities`
+    - Available options are https://github.com/appium/python-client/tree/master/appium/options
+        - Please check the [Usage](#usage) below as an exampple.
+    - Not a "new" change, but the `desired_capabilities` argument has been removed since v3.
 - Replacement
     - `start_activity` method: Please use [`mobile: startActivity`](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#mobile-startactivity)
     - `launch_app`, `close_app` and `reset` methods: Please refer to https://github.com/appium/appium/issues/15807
@@ -67,8 +71,8 @@ For example, some changes in the Selenium binding could break the Appium client.
     - `set_value` and `set_text` methods: Please use `element.send_keys` or `send_keys` by W3C Actions
 - Removal
     - `end_test_coverage` method is no longer available
-    - `session` properly is no longer available
-    - `all_sessions` properly is no longer available
+    - `session` property is no longer available
+    - `all_sessions` property is no longer available
 
 ### Quick migration guide from v1 to v2
 - Enhancement
@@ -78,10 +82,10 @@ For example, some changes in the Selenium binding could break the Appium client.
         - Please check each behavior. Their behaviors could slightly differ.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
-    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions.
+    - `MultiAction` and `TouchAction` are deprecated. Please use W3C WebDriver actions or `mobile:` extensions
         - e.g.
             - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
-            - https://www.selenium.dev/documentation/support_packages/mouse_and_keyboard_actions_in_detail/
+            - https://www.selenium.dev/documentation/webdriver/actions_api/
             - https://www.youtube.com/watch?v=oAJ7jwMNFVU
             - https://appiumpro.com/editions/30-ios-specific-touch-action-methods
             - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api
@@ -93,8 +97,10 @@ On UIA2, some elements can be handled with `touch` pointer action instead of the
 For example, the below action builder is to replace the default one with the `touch` pointer action.
 
 ```python
+from selenium.webdriver import ActionChains
 from selenium.webdriver.common.actions import interaction
 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
@@ -107,6 +113,9 @@ actions.w3c_actions.pointer_action.release()
 actions.perform()
 ```
 
+- [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+- https://www.selenium.dev/documentation/webdriver/actions_api/
+
 ## Usage
 
 The Appium Python Client is fully compliant with the WebDriver Protocol
@@ -148,7 +157,7 @@ APPIUM_HOST = '127.0.0.1'
 def appium_service():
     service = AppiumService()
     service.start(
-        # Check the output of `appium server --help` for the complete list of 
+        # Check the output of `appium server --help` for the complete list of
         # server command line arguments
         args=['--address', APPIUM_HOST, '-p', str(APPIUM_PORT)],
         timeout_ms=20000,
@@ -157,7 +166,7 @@ def appium_service():
     service.stop()
 
 
-def create_ios_driver(custom_opts = None):    
+def create_ios_driver(custom_opts = None):
     options = XCUITestOptions()
     options.platformVersion = '13.4'
     options.udid = '123456789ABC'
@@ -165,9 +174,9 @@ def create_ios_driver(custom_opts = None):
         options.load_capabilities(custom_opts)
     # Appium1 points to http://127.0.0.1:4723/wd/hub by default
     return webdriver.Remote(f'http://{APPIUM_HOST}:{APPIUM_PORT}', options=options)
-    
 
-def create_android_driver(custom_opts = None):    
+
+def create_android_driver(custom_opts = None):
     options = UiAutomator2Options()
     options.platformVersion = '10'
     options.udid = '123456789ABC'
@@ -180,16 +189,16 @@ def create_android_driver(custom_opts = None):
 @pytest.fixture
 def ios_driver_factory():
     return create_ios_driver
-    
+
 
 @pytest.fixture
 def ios_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_ios_driver()
     yield driver
     driver.quit()
 
-    
+
 @pytest.fixture
 def android_driver_factory():
     return create_android_driver
@@ -197,12 +206,12 @@ def android_driver_factory():
 
 @pytest.fixture
 def android_driver():
-    # prefer this fixture if there is no need to customize driver options in tests 
+    # prefer this fixture if there is no need to customize driver options in tests
     driver = create_android_driver()
     yield driver
     driver.quit()
 
-            
+
 def test_ios_click(appium_service, ios_driver_factory):
     # Usage of the context manager ensures the driver session is closed properly
     # after the test completes. Otherwise, make sure to call `driver.quit()` on teardown.

Appium-Python-Client-3.2.0/appium/version.py

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

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/appium/webdriver/common/multi_action.py

@@ -33,7 +33,7 @@ if TYPE_CHECKING:
 class MultiAction:
     """
     deprecated:: 2.0.0
-        Please use W3C actions instead: http://appium.io/docs/en/commands/interactions/actions/
+        Please use W3C actions instead: https://github.com/appium/python-client?tab=readme-ov-file#multiactiontouchaction-to-w3c-actions
     """
 
     def __init__(self, driver: 'WebDriver', element: Optional['WebElement'] = None) -> None:
@@ -45,7 +45,7 @@ class MultiAction:
         self._element = element
         self._touch_actions: List['TouchAction'] = []
 
-    def add(self, *touch_actions: 'TouchAction') -> None:
+    def add(self, *touch_actions: 'TouchAction') -> 'MultiAction':
         """Add TouchAction objects to the MultiAction, to be performed later.
 
         Args:
@@ -67,6 +67,8 @@ class MultiAction:
 
             self._touch_actions.append(copy.copy(touch_action))
 
+        return self
+
     def perform(self) -> 'MultiAction':
         """Perform the actions stored in the object.
 

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/appium/webdriver/common/touch_action.py

@@ -37,7 +37,7 @@ if TYPE_CHECKING:
 class TouchAction:
     """
     deprecated:: 2.0.0
-        Please use W3C actions instead: http://appium.io/docs/en/commands/interactions/actions/
+        Please use W3C actions instead: https://github.com/appium/python-client?tab=readme-ov-file#multiactiontouchaction-to-w3c-actions
     """
 
     def __init__(self, driver: Optional['WebDriver'] = None):

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/appium/webdriver/extensions/action_helpers.py

@@ -61,12 +61,15 @@ class ActionHelpers:
         actions.perform()
         return cast('WebDriver', self)
 
-    def drag_and_drop(self, origin_el: WebElement, destination_el: WebElement) -> 'WebDriver':
+    def drag_and_drop(
+        self, origin_el: WebElement, destination_el: WebElement, pause: Optional[float] = None
+    ) -> 'WebDriver':
         """Drag the origin element to the destination element
 
         Args:
             origin_el: the element to drag
             destination_el: the element to drag to
+            pause: how long the action pauses before moving after the tap and hold, in float seconds.
 
         Returns:
             Union['WebDriver', 'ActionHelpers']: Self instance
@@ -74,6 +77,8 @@ class ActionHelpers:
         actions = ActionChains(self)
         # 'mouse' pointer action
         actions.w3c_actions.pointer_action.click_and_hold(origin_el)
+        if pause is not None and pause > 0:
+            actions.w3c_actions.pointer_action.pause(pause)
         actions.w3c_actions.pointer_action.move_to(destination_el)
         actions.w3c_actions.pointer_action.release()
         actions.perform()
@@ -96,7 +101,7 @@ class ActionHelpers:
         """
         if len(positions) == 1:
             actions = ActionChains(self)
-            actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, 'touc'))
+            actions.w3c_actions = ActionBuilder(self, mouse=PointerInput(interaction.POINTER_TOUCH, 'touch'))
             x = positions[0][0]
             y = positions[0][1]
             actions.w3c_actions.pointer_action.move_to_location(x, y)

{Appium-Python-Client-3.1.0 → Appium-Python-Client-3.2.0}/appium/webdriver/webdriver.py

@@ -295,8 +295,11 @@ class WebDriver(
         executor = f'{protocol}://{hostname}:{port}{path}'
 
         logger.debug('Updated request endpoint to %s', executor)
-        # Override command executor
-        self.command_executor = RemoteConnection(executor, keep_alive=keep_alive)
+        # Override command executor.
+        if isinstance(self.command_executor, AppiumConnection):  # type: ignore
+            self.command_executor = AppiumConnection(executor, keep_alive=keep_alive)
+        else:
+            self.command_executor = RemoteConnection(executor, keep_alive=keep_alive)
         self._add_commands()
 
     # https://github.com/SeleniumHQ/selenium/blob/06fdf2966df6bca47c0ae45e8201cd30db9b9a49/py/selenium/webdriver/remote/webdriver.py#L277

Appium-Python-Client-3.1.0/appium/version.py

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