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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.0.0
+Version: 4.0.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -25,6 +25,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: selenium~=4.12
 
 # Appium Python Client
 
@@ -75,7 +76,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
 |`2.0.0` - `2.1.4` |`4.0.0` | 3.7+ |
-|`1.0.0` - `1.1.0` |`3.x`| 3.7, 3.8 |
+|`1.0.0` - `1.3.0` |`3.x`| 3.7+ |
 |`0.52` and below|`3.x`| 2.7, 3.4 - 3.7 |
 
 The Appium Python Client depends on [Selenium Python binding](https://pypi.org/project/selenium/), thus
@@ -100,7 +101,7 @@ 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.
+        - Please check the [Usage](#usage) below as an example.
     - 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)

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

@@ -314,7 +314,6 @@ appium/webdriver/extensions/android/performance.py
 appium/webdriver/extensions/android/power.py
 appium/webdriver/extensions/android/sms.py
 appium/webdriver/extensions/android/system_bars.py
-docs/.DS_Store
 docs/Makefile
 docs/README.md
 docs/conf.py
@@ -326,72 +325,4 @@ docs/webdriver.common.rst
 docs/webdriver.extensions.android.rst
 docs/webdriver.extensions.rst
 docs/webdriver.extensions.search_context.rst
-docs/webdriver.rst
-docs/_build/doctrees/appium.common.doctree
-docs/_build/doctrees/appium.doctree
-docs/_build/doctrees/appium.webdriver.common.doctree
-docs/_build/doctrees/appium.webdriver.doctree
-docs/_build/doctrees/appium.webdriver.extensions.android.doctree
-docs/_build/doctrees/appium.webdriver.extensions.doctree
-docs/_build/doctrees/appium.webdriver.extensions.search_context.doctree
-docs/_build/doctrees/environment.pickle
-docs/_build/doctrees/index.doctree
-docs/_build/html/.buildinfo
-docs/_build/html/.nojekyll
-docs/_build/html/appium.common.html
-docs/_build/html/appium.html
-docs/_build/html/appium.webdriver.common.html
-docs/_build/html/appium.webdriver.extensions.android.html
-docs/_build/html/appium.webdriver.extensions.html
-docs/_build/html/appium.webdriver.extensions.search_context.html
-docs/_build/html/appium.webdriver.html
-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/_sources/appium.common.rst.txt
-docs/_build/html/_sources/appium.rst.txt
-docs/_build/html/_sources/appium.webdriver.common.rst.txt
-docs/_build/html/_sources/appium.webdriver.extensions.android.rst.txt
-docs/_build/html/_sources/appium.webdriver.extensions.rst.txt
-docs/_build/html/_sources/appium.webdriver.extensions.search_context.rst.txt
-docs/_build/html/_sources/appium.webdriver.rst.txt
-docs/_build/html/_sources/index.rst.txt
-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-3.5.1.js
-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/underscore-1.13.1.js
-docs/_build/html/_static/underscore.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/js/badge_only.js
-docs/_build/html/_static/js/html5shiv-printshiv.min.js
-docs/_build/html/_static/js/html5shiv.min.js
-docs/_build/html/_static/js/theme.js
+docs/webdriver.rst

{Appium-Python-Client-4.0.0 → appium_python_client-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.0.0
+Version: 4.0.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -25,6 +25,7 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: selenium~=4.12
 
 # Appium Python Client
 
@@ -75,7 +76,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
 |`2.0.0` - `2.1.4` |`4.0.0` | 3.7+ |
-|`1.0.0` - `1.1.0` |`3.x`| 3.7, 3.8 |
+|`1.0.0` - `1.3.0` |`3.x`| 3.7+ |
 |`0.52` and below|`3.x`| 2.7, 3.4 - 3.7 |
 
 The Appium Python Client depends on [Selenium Python binding](https://pypi.org/project/selenium/), thus
@@ -100,7 +101,7 @@ 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.
+        - Please check the [Usage](#usage) below as an example.
     - 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)

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

@@ -47,7 +47,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 |`2.10.0` - `2.11.1` |`4.1.0` - `4.11.2` | 3.7+ |
 |`2.2.0` - `2.9.0` |`4.1.0` - `4.9.0` | 3.7+ |
 |`2.0.0` - `2.1.4` |`4.0.0` | 3.7+ |
-|`1.0.0` - `1.1.0` |`3.x`| 3.7, 3.8 |
+|`1.0.0` - `1.3.0` |`3.x`| 3.7+ |
 |`0.52` and below|`3.x`| 2.7, 3.4 - 3.7 |
 
 The Appium Python Client depends on [Selenium Python binding](https://pypi.org/project/selenium/), thus
@@ -72,7 +72,7 @@ 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.
+        - Please check the [Usage](#usage) below as an example.
     - 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)

appium_python_client-4.0.1/appium/version.py

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

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

@@ -17,7 +17,6 @@ from selenium.webdriver.common.by import By
 
 class AppiumBy(By):
     IOS_PREDICATE = '-ios predicate string'
-    IOS_UIAUTOMATION = '-ios uiautomation'
     IOS_CLASS_CHAIN = '-ios class chain'
     ANDROID_UIAUTOMATOR = '-android uiautomator'
     ANDROID_VIEWTAG = '-android viewtag'

{Appium-Python-Client-4.0.0 → appium_python_client-4.0.1}/appium/webdriver/extensions/clipboard.py

@@ -15,7 +15,11 @@
 import base64
 from typing import TYPE_CHECKING, Optional, cast
 
+from selenium.common.exceptions import UnknownMethodException
+
 from appium.protocols.webdriver.can_execute_commands import CanExecuteCommands
+from appium.protocols.webdriver.can_execute_scripts import CanExecuteScripts
+from appium.protocols.webdriver.can_remember_extension_presence import CanRememberExtensionPresence
 from appium.webdriver.clipboard_content_type import ClipboardContentType
 
 from ..mobilecommand import MobileCommand as Command
@@ -24,7 +28,7 @@ if TYPE_CHECKING:
     from appium.webdriver.webdriver import WebDriver
 
 
-class Clipboard(CanExecuteCommands):
+class Clipboard(CanExecuteCommands, CanExecuteScripts, CanRememberExtensionPresence):
     def set_clipboard(
         self, content: bytes, content_type: str = ClipboardContentType.PLAINTEXT, label: Optional[str] = None
     ) -> 'WebDriver':
@@ -39,13 +43,18 @@ class Clipboard(CanExecuteCommands):
         Returns:
             Union['WebDriver', 'Clipboard']: Self instance
         """
+        ext_name = 'mobile: setClipboard'
         options = {
             'content': base64.b64encode(content).decode('UTF-8'),
             'contentType': content_type,
         }
         if label:
             options['label'] = label
-        self.execute(Command.SET_CLIPBOARD, options)
+        try:
+            self.assert_extension_exists(ext_name).execute_script(ext_name, options)
+        except UnknownMethodException:
+            # TODO: Remove the fallback
+            self.mark_extension_absence(ext_name).execute(Command.SET_CLIPBOARD, options)
         return cast('WebDriver', self)
 
     def set_clipboard_text(self, text: str, label: Optional[str] = None) -> 'WebDriver':
@@ -68,9 +77,15 @@ class Clipboard(CanExecuteCommands):
                 is supported on Android
 
         Returns:
-            base64-encoded string: Clipboard content. Or return an empty string if the clipboard is empty
+            Clipboard content as bytearray. Or empty bytes if the clipboard is empty
         """
-        base64_str = self.execute(Command.GET_CLIPBOARD, {'contentType': content_type})['value']
+        ext_name = 'mobile: getClipboard'
+        options = {'contentType': content_type}
+        try:
+            base64_str = self.assert_extension_exists(ext_name).execute_script(ext_name, options)
+        except UnknownMethodException:
+            # TODO: Remove the fallback
+            base64_str = self.mark_extension_absence(ext_name).execute(Command.GET_CLIPBOARD, options)['value']
         return base64.b64decode(base64_str)
 
     def get_clipboard_text(self) -> str:

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

@@ -118,7 +118,7 @@ class ExtensionBase:
                 def add_command(self):
                     return ('post', 'session/$sessionId/path/to/your/custom/url')
 
-            driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps,
+            driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options,
                 extensions=[YourCustomCommand])
 
             # Then, the driver sends a post request to `session/$sessionId/path/to/your/custom/url`
@@ -126,7 +126,7 @@ class ExtensionBase:
             driver.custom_method_name({'dummy_arg': 'as a value'})
 
 
-        When you customize the URL dinamically with element id.
+        When you customize the URL dynamically with element id.
 
             class CustomURLCommand(ExtensionBase):
                 def method_name(self):
@@ -138,9 +138,9 @@ class ExtensionBase:
                 def add_command(self):
                     return ('GET', 'session/$sessionId/path/to/your/custom/$id/url')
 
-            driver = webdriver.Remote('http://localhost:4723/wd/hub', desired_caps,
+            driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options,
                 extensions=[YourCustomCommand])
-            element = driver.find_elemeent(by=AppiumBy.ACCESSIBILITY_ID, value='id')
+            element = driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='id')
 
             # Then, the driver calls a get request to `session/$sessionId/path/to/your/custom/$id/url`
             # with replacing the `$id` with the given `element.id`
@@ -240,7 +240,6 @@ class WebDriver(
             self._update_command_executor(keep_alive=keep_alive)
 
         # add new method to the `find_by_*` pantheon
-        By.IOS_UIAUTOMATION = AppiumBy.IOS_UIAUTOMATION
         By.IOS_PREDICATE = AppiumBy.IOS_PREDICATE
         By.IOS_CLASS_CHAIN = AppiumBy.IOS_CLASS_CHAIN
         By.ANDROID_UIAUTOMATOR = AppiumBy.ANDROID_UIAUTOMATOR

appium_python_client-4.0.1/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx >= 4.0, < 7.0
+sphinx_rtd_theme < 3.0

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

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

Appium-Python-Client-4.0.0/docs/_build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9b33031670eaa42b3ba6f78d3a372bb1
-tags: 645f666f9bcd5a90fca523b33c5a78b7

Appium-Python-Client-4.0.0/docs/_build/html/_sources/appium.common.rst.txt

@@ -1,37 +0,0 @@
-appium.common package
-=====================
-
-Submodules
-----------
-
-appium.common.exceptions module
--------------------------------
-
-.. automodule:: appium.common.exceptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.common.helper module
----------------------------
-
-.. automodule:: appium.common.helper
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.common.logger module
----------------------------
-
-.. automodule:: appium.common.logger
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: appium.common
-   :members:
-   :undoc-members:
-   :show-inheritance:

Appium-Python-Client-4.0.0/docs/_build/html/_sources/appium.rst.txt

@@ -1,30 +0,0 @@
-appium package
-==============
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   appium.common
-   appium.webdriver
-
-Submodules
-----------
-
-appium.version module
----------------------
-
-.. automodule:: appium.version
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: appium
-   :members:
-   :undoc-members:
-   :show-inheritance:

Appium-Python-Client-4.0.0/docs/_build/html/_sources/appium.webdriver.common.rst.txt

@@ -1,45 +0,0 @@
-appium.webdriver.common package
-===============================
-
-Submodules
-----------
-
-appium.webdriver.common.appiumby module
----------------------------------------
-
-.. automodule:: appium.webdriver.common.appiumby
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.common.mobileby module
----------------------------------------
-
-.. automodule:: appium.webdriver.common.mobileby
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.common.multi\_action module
---------------------------------------------
-
-.. automodule:: appium.webdriver.common.multi_action
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.common.touch\_action module
---------------------------------------------
-
-.. automodule:: appium.webdriver.common.touch_action
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: appium.webdriver.common
-   :members:
-   :undoc-members:
-   :show-inheritance:

Appium-Python-Client-4.0.0/docs/_build/html/_sources/appium.webdriver.extensions.android.rst.txt

@@ -1,93 +0,0 @@
-appium.webdriver.extensions.android package
-===========================================
-
-Submodules
-----------
-
-appium.webdriver.extensions.android.activities module
------------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.activities
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.common module
--------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.common
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.display module
---------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.display
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.gsm module
-----------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.gsm
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.nativekey module
-----------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.nativekey
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.network module
---------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.network
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.performance module
-------------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.performance
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.power module
-------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.power
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.sms module
-----------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.sms
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-appium.webdriver.extensions.android.system\_bars module
--------------------------------------------------------
-
-.. automodule:: appium.webdriver.extensions.android.system_bars
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: appium.webdriver.extensions.android
-   :members:
-   :undoc-members:
-   :show-inheritance: