Appium-Python-Client 3.2.1__tar.gz → 4.0.0__tar.gz

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 3.2.1
+Version: 4.0.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -87,6 +87,16 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v3 to v4
+- Removal
+    - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
+        - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+        - 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
+    - Deprecated `AppiumBy.WINDOWS_UI_AUTOMATION`, which has no usage right now.
+
 ### 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
@@ -111,12 +121,6 @@ For example, some changes in the Selenium binding could break the Appium client.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
     - `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/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
     - `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

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -286,8 +286,6 @@ appium/webdriver/webdriver.py
 appium/webdriver/webelement.py
 appium/webdriver/common/__init__.py
 appium/webdriver/common/appiumby.py
-appium/webdriver/common/multi_action.py
-appium/webdriver/common/touch_action.py
 appium/webdriver/extensions/__init__.py
 appium/webdriver/extensions/action_helpers.py
 appium/webdriver/extensions/applications.py

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 3.2.1
+Version: 4.0.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -87,6 +87,16 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v3 to v4
+- Removal
+    - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
+        - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+        - 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
+    - Deprecated `AppiumBy.WINDOWS_UI_AUTOMATION`, which has no usage right now.
+
 ### 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
@@ -111,12 +121,6 @@ For example, some changes in the Selenium binding could break the Appium client.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
     - `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/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
     - `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

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/README.md

@@ -59,6 +59,16 @@ For example, some changes in the Selenium binding could break the Appium client.
 > to keep compatible version combinations.
 
 
+### Quick migration guide from v3 to v4
+- Removal
+    - `MultiAction` and `TouchAction` are removed. Please use W3C WebDriver actions or `mobile:` extensions
+        - [appium/webdriver/extensions/action_helpers.py](appium/webdriver/extensions/action_helpers.py)
+        - 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
+    - Deprecated `AppiumBy.WINDOWS_UI_AUTOMATION`, which has no usage right now.
+
 ### 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
@@ -83,12 +93,6 @@ For example, some changes in the Selenium binding could break the Appium client.
     - Added `strict_ssl` to relax SSL errors such as self-signed ones
 - Deprecated
     - `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/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
     - `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

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

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

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/appium/webdriver/common/appiumby.py

@@ -23,8 +23,6 @@ class AppiumBy(By):
     ANDROID_VIEWTAG = '-android viewtag'
     ANDROID_DATA_MATCHER = '-android datamatcher'
     ANDROID_VIEW_MATCHER = '-android viewmatcher'
-    # Deprecated
-    WINDOWS_UI_AUTOMATION = '-windows uiautomation'
     ACCESSIBILITY_ID = 'accessibility id'
     IMAGE = '-image'
     CUSTOM = '-custom'

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/appium/webdriver/webdriver.py

@@ -245,7 +245,6 @@ class WebDriver(
         By.IOS_CLASS_CHAIN = AppiumBy.IOS_CLASS_CHAIN
         By.ANDROID_UIAUTOMATOR = AppiumBy.ANDROID_UIAUTOMATOR
         By.ANDROID_VIEWTAG = AppiumBy.ANDROID_VIEWTAG
-        By.WINDOWS_UI_AUTOMATION = AppiumBy.WINDOWS_UI_AUTOMATION
         By.ACCESSIBILITY_ID = AppiumBy.ACCESSIBILITY_ID
         By.IMAGE = AppiumBy.IMAGE
         By.CUSTOM = AppiumBy.CUSTOM

{Appium-Python-Client-3.2.1 → Appium-Python-Client-4.0.0}/docs/webdriver.common.rst

@@ -12,22 +12,6 @@ webdriver.common.mobileby module
    :undoc-members:
    :show-inheritance:
 
-webdriver.common.multi\_action module
--------------------------------------
-
-.. automodule:: webdriver.common.multi_action
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-webdriver.common.touch\_action module
--------------------------------------
-
-.. automodule:: webdriver.common.touch_action
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

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

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

Appium-Python-Client-3.2.1/appium/webdriver/common/multi_action.py

@@ -1,99 +0,0 @@
-#!/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.
-
-
-# The Selenium team implemented something like the Multi Action API in the form of
-# "action chains" (https://code.google.com/p/selenium/source/browse/py/selenium/webdriver/common/action_chains.py).
-# These do not quite work for this situation, and do not allow for ad hoc action
-# chaining as the spec requires.
-
-import copy
-import warnings
-from typing import TYPE_CHECKING, Dict, List, Optional, Union
-
-from appium.webdriver.mobilecommand import MobileCommand as Command
-
-if TYPE_CHECKING:
-    from appium.webdriver.common.touch_action import TouchAction
-    from appium.webdriver.webdriver import WebDriver
-    from appium.webdriver.webelement import WebElement
-
-
-class MultiAction:
-    """
-    deprecated:: 2.0.0
-        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:
-        warnings.warn(
-            '[Deprecated] \'MultiAction\' action is deprecated. Please use W3C actions instead.', DeprecationWarning
-        )
-
-        self._driver = driver
-        self._element = element
-        self._touch_actions: List['TouchAction'] = []
-
-    def add(self, *touch_actions: 'TouchAction') -> 'MultiAction':
-        """Add TouchAction objects to the MultiAction, to be performed later.
-
-        Args:
-            touch_actions: one or more TouchAction objects describing a chain of actions to be performed by one finger
-
-        Usage:
-            | a1 = TouchAction(driver)
-            | a1.press(el1).move_to(el2).release()
-            | a2 = TouchAction(driver)
-            | a2.press(el2).move_to(el1).release()
-            | MultiAction(driver).add(a1, a2)
-
-        Returns:
-            `MultiAction`: Self instance
-        """
-        for touch_action in touch_actions:
-            if self._touch_actions is None:
-                self._touch_actions = []
-
-            self._touch_actions.append(copy.copy(touch_action))
-
-        return self
-
-    def perform(self) -> 'MultiAction':
-        """Perform the actions stored in the object.
-
-        Usage:
-            | a1 = TouchAction(driver)
-            | a1.press(el1).move_to(el2).release()
-            | a2 = TouchAction(driver)
-            | a2.press(el2).move_to(el1).release()
-            | MultiAction(driver).add(a1, a2).perform()
-
-        Returns:
-            `MultiAction`: Self instance
-        """
-        self._driver.execute(Command.MULTI_ACTION, self.json_wire_gestures)
-
-        # clean up and be ready for the next batch
-        self._touch_actions = []
-
-        return self
-
-    @property
-    def json_wire_gestures(self) -> Dict[str, Union[List, str]]:
-        actions = []
-        for action in self._touch_actions:
-            actions.append(action.json_wire_gestures)
-        if self._element is not None:
-            return {'actions': actions, 'elementId': self._element.id}
-        return {'actions': actions}

Appium-Python-Client-3.2.1/appium/webdriver/common/touch_action.py

@@ -1,218 +0,0 @@
-#!/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.
-
-
-# The Selenium team implemented a version of the Touch Action API in their code
-# (https://code.google.com/p/selenium/source/browse/py/selenium/webdriver/common/touch_actions.py)
-# but it is deficient in many ways, and does not work in such a way as to be
-# amenable to Appium's use of iOS UIAutomation and Android UIAutomator
-# So it is reimplemented here.
-#
-# Theirs is `TouchActions`. Appium's is `TouchAction`.
-
-# pylint: disable=no-self-use
-
-import copy
-import warnings
-from typing import TYPE_CHECKING, Dict, List, Optional, Union
-
-from appium.webdriver.mobilecommand import MobileCommand as Command
-
-if TYPE_CHECKING:
-    from appium.webdriver.webdriver import WebDriver
-    from appium.webdriver.webelement import WebElement
-
-
-class TouchAction:
-    """
-    deprecated:: 2.0.0
-        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):
-        warnings.warn(
-            '[Deprecated] \'TouchAction\' action is deprecated. Please use W3C actions instead.', DeprecationWarning
-        )
-
-        self._driver = driver
-        self._actions: List = []
-
-    def tap(
-        self,
-        element: Optional['WebElement'] = None,
-        x: Optional[int] = None,
-        y: Optional[int] = None,
-        count: int = 1,
-    ) -> 'TouchAction':
-        """Perform a tap action on the element
-
-        Args:
-            element: the element to tap
-            x : x coordinate to tap, relative to the top left corner of the element.
-            y : y coordinate. If y is used, x must also be set, and vice versa
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        opts = self._get_opts(element, x, y)
-        opts['count'] = count
-        self._add_action('tap', opts)
-
-        return self
-
-    def press(
-        self,
-        el: Optional['WebElement'] = None,
-        x: Optional[int] = None,
-        y: Optional[int] = None,
-        pressure: Optional[float] = None,
-    ) -> 'TouchAction':
-        """Begin a chain with a press down action at a particular element or point
-
-        Args:
-            el: the element to press
-            x: x coordiate to press. If y is used, x must also be set
-            y: y coordiate to press. If x is used, y must also be set
-            pressure: [iOS Only] press as force touch. Read the description of `force` property on Apple's UITouch class
-                                (https://developer.apple.com/documentation/uikit/uitouch?language=objc) for
-                                more details on possible value ranges.
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        self._add_action('press', self._get_opts(el, x, y, pressure=pressure))
-
-        return self
-
-    def long_press(
-        self,
-        el: Optional['WebElement'] = None,
-        x: Optional[int] = None,
-        y: Optional[int] = None,
-        duration: int = 1000,
-    ) -> 'TouchAction':
-        """Begin a chain with a press down that lasts `duration` milliseconds
-
-        Args:
-            el: the element to press
-            x: x coordiate to press. If y is used, x must also be set
-            y: y coordiate to press. If x is used, y must also be set
-            duration: Duration to press, expressed in milliseconds
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        self._add_action('longPress', self._get_opts(el, x, y, duration))
-
-        return self
-
-    def wait(self, ms: int = 0) -> 'TouchAction':
-        """Pause for `ms` milliseconds.
-
-        Args:
-            ms: The time to pause
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        if ms is None:
-            ms = 0
-
-        opts = {'ms': ms}
-
-        self._add_action('wait', opts)
-
-        return self
-
-    def move_to(
-        self, el: Optional['WebElement'] = None, x: Optional[int] = None, y: Optional[int] = None
-    ) -> 'TouchAction':
-        """Move the pointer from the previous point to the element or point specified
-
-        Args:
-            el: the element to be moved to
-            x: x coordiate to be moved to. If y is used, x must also be set
-            y: y coordiate to be moved to. If x is used, y must also be set
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        self._add_action('moveTo', self._get_opts(el, x, y))
-
-        return self
-
-    def release(self) -> 'TouchAction':
-        """End the action by lifting the pointer off the screen
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        self._add_action('release', {})
-
-        return self
-
-    def perform(self) -> 'TouchAction':
-        """Perform the action by sending the commands to the server to be operated upon
-
-        Returns:
-            `TouchAction`: Self instance
-        """
-        if self._driver is None:
-            raise ValueError('Set driver to constructor as a argument when to create the instance.')
-        params = {'actions': self._actions}
-        self._driver.execute(Command.TOUCH_ACTION, params)
-
-        # get rid of actions so the object can be reused
-        self._actions = []
-
-        return self
-
-    @property
-    def json_wire_gestures(self) -> List[Dict]:
-        gestures = []
-        for action in self._actions:
-            gestures.append(copy.deepcopy(action))
-        return gestures
-
-    def _add_action(self, action: str, options: Dict) -> None:
-        gesture = {
-            'action': action,
-            'options': options,
-        }
-        self._actions.append(gesture)
-
-    def _get_opts(
-        self,
-        el: Optional['WebElement'] = None,
-        x: Optional[int] = None,
-        y: Optional[int] = None,
-        duration: Optional[int] = None,
-        pressure: Optional[float] = None,
-    ) -> Dict[str, Union[int, float]]:
-        opts = {}
-        if el is not None:
-            opts['element'] = el.id
-
-        # it makes no sense to have x but no y, or vice versa.
-        if x is not None and y is not None:
-            opts['x'] = x
-            opts['y'] = y
-
-        if duration is not None:
-            opts['duration'] = duration
-
-        if pressure is not None:
-            opts['pressure'] = pressure
-
-        return opts