Appium-Python-Client 2.8.0__tar.gz → 2.9.0__tar.gz

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 2.8.0
+Version: 2.9.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -143,7 +143,7 @@ options = UiAutomator2Options()
 options.platformVersion = '10'
 options.udid = '123456789ABC'
 options.app = PATH('../../../apps/test-app.apk')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -162,7 +162,7 @@ options = XCUITestOptions()
 options.platformVersion = '13.4'
 options.udid = '123456789ABC'
 options.app = PATH('../../apps/UICatalog.app.zip')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -186,7 +186,7 @@ from appium import webdriver
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
 
-# load_capabilities API could be used to 
+# load_capabilities API could be used to
 # load options mapping stored in a dictionary
 options = XCUITestOptions().load_capabilities({
     'platformVersion': '13.4',
@@ -195,9 +195,9 @@ options = XCUITestOptions().load_capabilities({
 })
 
 self.driver = webdriver.Remote(
-    # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
-    'http://127.0.0.1:4723', 
-    options=options, 
+    # Appium1 points to http://127.0.0.1:4723/wd/hub by default
+    'http://127.0.0.1:4723',
+    options=options,
     direct_connection=True
 )
 ```
@@ -220,10 +220,62 @@ options.automation_name = 'safari'
 # calls to it could be chained
 options.set_capability('browser_name', 'safari')
 
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)
 ```
 
+## Set custom `AppiumConnection`
+
+The first argument of `webdriver.Remote` can set an arbitrary command executor for you.
+
+1. Set init arguments for the pool manager Appium Python client uses to manage http requests.
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+import urllib3
+from appium.webdriver.appium_connection import AppiumConnection
+
+# Retry connection error up to 3 times.
+init_args_for_pool_manage = {
+    'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)
+}
+appium_executor = AppiumConnection(remote_server_addr='http://127.0.0.1:4723',
+    init_args_for_pool_manage=init_args_for_pool_manage)
+
+options = XCUITestOptions()
+options.platformVersion = '13.4'
+options.udid = '123456789ABC'
+options.app = PATH('../../apps/UICatalog.app.zip')
+driver = webdriver.Remote(appium_executor, options=options)
+```
+
+
+2. Define a subclass of `AppiumConnection`
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+from appium.webdriver.appium_connection import AppiumConnection
+
+class CustomAppiumConnection(AppiumConnection):
+    # Can add your own methods for the custom class
+    pass
+
+custom_executor = CustomAppiumConnection(remote_server_addr='http://127.0.0.1:4723')
+
+options = XCUITestOptions().load_capabilities({
+    'platformVersion': '13.4',
+    'deviceName': 'iPhone Simulator',
+    'app': PATH('../../apps/UICatalog.app.zip'),
+})
+driver = webdriver.Remote(custom_executor, options=options)
+
+```
+
+
 ## Documentation
 
 - https://appium.github.io/python-client-sphinx/ is detailed documentation

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -319,13 +319,6 @@ appium/webdriver/extensions/android/system_bars.py
 docs/.DS_Store
 docs/Makefile
 docs/README.md
-docs/appium.common.rst
-docs/appium.rst
-docs/appium.webdriver.common.rst
-docs/appium.webdriver.extensions.android.rst
-docs/appium.webdriver.extensions.rst
-docs/appium.webdriver.extensions.search_context.rst
-docs/appium.webdriver.rst
 docs/conf.py
 docs/generate.sh
 docs/index.rst

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 2.8.0
+Version: 2.9.0
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -143,7 +143,7 @@ options = UiAutomator2Options()
 options.platformVersion = '10'
 options.udid = '123456789ABC'
 options.app = PATH('../../../apps/test-app.apk')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -162,7 +162,7 @@ options = XCUITestOptions()
 options.platformVersion = '13.4'
 options.udid = '123456789ABC'
 options.app = PATH('../../apps/UICatalog.app.zip')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -186,7 +186,7 @@ from appium import webdriver
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
 
-# load_capabilities API could be used to 
+# load_capabilities API could be used to
 # load options mapping stored in a dictionary
 options = XCUITestOptions().load_capabilities({
     'platformVersion': '13.4',
@@ -195,9 +195,9 @@ options = XCUITestOptions().load_capabilities({
 })
 
 self.driver = webdriver.Remote(
-    # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
-    'http://127.0.0.1:4723', 
-    options=options, 
+    # Appium1 points to http://127.0.0.1:4723/wd/hub by default
+    'http://127.0.0.1:4723',
+    options=options,
     direct_connection=True
 )
 ```
@@ -220,10 +220,62 @@ options.automation_name = 'safari'
 # calls to it could be chained
 options.set_capability('browser_name', 'safari')
 
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)
 ```
 
+## Set custom `AppiumConnection`
+
+The first argument of `webdriver.Remote` can set an arbitrary command executor for you.
+
+1. Set init arguments for the pool manager Appium Python client uses to manage http requests.
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+import urllib3
+from appium.webdriver.appium_connection import AppiumConnection
+
+# Retry connection error up to 3 times.
+init_args_for_pool_manage = {
+    'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)
+}
+appium_executor = AppiumConnection(remote_server_addr='http://127.0.0.1:4723',
+    init_args_for_pool_manage=init_args_for_pool_manage)
+
+options = XCUITestOptions()
+options.platformVersion = '13.4'
+options.udid = '123456789ABC'
+options.app = PATH('../../apps/UICatalog.app.zip')
+driver = webdriver.Remote(appium_executor, options=options)
+```
+
+
+2. Define a subclass of `AppiumConnection`
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+from appium.webdriver.appium_connection import AppiumConnection
+
+class CustomAppiumConnection(AppiumConnection):
+    # Can add your own methods for the custom class
+    pass
+
+custom_executor = CustomAppiumConnection(remote_server_addr='http://127.0.0.1:4723')
+
+options = XCUITestOptions().load_capabilities({
+    'platformVersion': '13.4',
+    'deviceName': 'iPhone Simulator',
+    'app': PATH('../../apps/UICatalog.app.zip'),
+})
+driver = webdriver.Remote(custom_executor, options=options)
+
+```
+
+
 ## Documentation
 
 - https://appium.github.io/python-client-sphinx/ is detailed documentation

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/README.md

@@ -115,7 +115,7 @@ options = UiAutomator2Options()
 options.platformVersion = '10'
 options.udid = '123456789ABC'
 options.app = PATH('../../../apps/test-app.apk')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -134,7 +134,7 @@ options = XCUITestOptions()
 options.platformVersion = '13.4'
 options.udid = '123456789ABC'
 options.app = PATH('../../apps/UICatalog.app.zip')
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options)
 el = self.driver.find_element(by=AppiumBy.ACCESSIBILITY_ID, value='item')
 el.click()
@@ -158,7 +158,7 @@ from appium import webdriver
 # instead: https://github.com/appium/python-client/pull/720
 from appium.options.ios import XCUITestOptions
 
-# load_capabilities API could be used to 
+# load_capabilities API could be used to
 # load options mapping stored in a dictionary
 options = XCUITestOptions().load_capabilities({
     'platformVersion': '13.4',
@@ -167,9 +167,9 @@ options = XCUITestOptions().load_capabilities({
 })
 
 self.driver = webdriver.Remote(
-    # Appium1 points to http://127.0.0.1:4723/wd/hub by default 
-    'http://127.0.0.1:4723', 
-    options=options, 
+    # Appium1 points to http://127.0.0.1:4723/wd/hub by default
+    'http://127.0.0.1:4723',
+    options=options,
     direct_connection=True
 )
 ```
@@ -192,10 +192,62 @@ options.automation_name = 'safari'
 # calls to it could be chained
 options.set_capability('browser_name', 'safari')
 
-# Appium1 points to http://127.0.0.1:4723/wd/hub by default 
+# Appium1 points to http://127.0.0.1:4723/wd/hub by default
 self.driver = webdriver.Remote('http://127.0.0.1:4723', options=options, strict_ssl=False)
 ```
 
+## Set custom `AppiumConnection`
+
+The first argument of `webdriver.Remote` can set an arbitrary command executor for you.
+
+1. Set init arguments for the pool manager Appium Python client uses to manage http requests.
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+import urllib3
+from appium.webdriver.appium_connection import AppiumConnection
+
+# Retry connection error up to 3 times.
+init_args_for_pool_manage = {
+    'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)
+}
+appium_executor = AppiumConnection(remote_server_addr='http://127.0.0.1:4723',
+    init_args_for_pool_manage=init_args_for_pool_manage)
+
+options = XCUITestOptions()
+options.platformVersion = '13.4'
+options.udid = '123456789ABC'
+options.app = PATH('../../apps/UICatalog.app.zip')
+driver = webdriver.Remote(appium_executor, options=options)
+```
+
+
+2. Define a subclass of `AppiumConnection`
+
+```python
+from appium import webdriver
+from appium.options.ios import XCUITestOptions
+
+from appium.webdriver.appium_connection import AppiumConnection
+
+class CustomAppiumConnection(AppiumConnection):
+    # Can add your own methods for the custom class
+    pass
+
+custom_executor = CustomAppiumConnection(remote_server_addr='http://127.0.0.1:4723')
+
+options = XCUITestOptions().load_capabilities({
+    'platformVersion': '13.4',
+    'deviceName': 'iPhone Simulator',
+    'app': PATH('../../apps/UICatalog.app.zip'),
+})
+driver = webdriver.Remote(custom_executor, options=options)
+
+```
+
+
 ## Documentation
 
 - https://appium.github.io/python-client-sphinx/ is detailed documentation

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

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

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/appium/webdriver/appium_connection.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 import uuid
-from typing import TYPE_CHECKING, Any, Dict, Union
+from typing import TYPE_CHECKING, Any, Dict, Optional, Union
 
 import urllib3
 from selenium.webdriver.remote.remote_connection import RemoteConnection
@@ -25,10 +25,23 @@ if TYPE_CHECKING:
 
 
 class AppiumConnection(RemoteConnection):
+    def __init__(
+        self,
+        remote_server_addr: str,
+        keep_alive: bool = False,
+        ignore_proxy: Optional[bool] = False,
+        init_args_for_pool_manager: Union[Dict[str, Any], None] = None,
+    ):
+
+        # Need to call before super().__init__ in order to pass arguments for the pool manager in the super.
+        self._init_args_for_pool_manager = init_args_for_pool_manager or {}
+
+        super().__init__(remote_server_addr, keep_alive=keep_alive, ignore_proxy=ignore_proxy)
+
     def _get_connection_manager(self) -> Union[urllib3.PoolManager, urllib3.ProxyManager]:
         # https://github.com/SeleniumHQ/selenium/blob/0e0194b0e52a34e7df4b841f1ed74506beea5c3e/py/selenium/webdriver/remote/remote_connection.py#L134
         pool_manager_init_args = {'timeout': self._timeout}
-        # pylint: disable=E1101
+
         if self._ca_certs:
             pool_manager_init_args['cert_reqs'] = 'CERT_REQUIRED'
             pool_manager_init_args['ca_certs'] = self._ca_certs
@@ -36,6 +49,8 @@ class AppiumConnection(RemoteConnection):
             # This line is necessary to disable certificate verification
             pool_manager_init_args['cert_reqs'] = 'CERT_NONE'
 
+        pool_manager_init_args.update(self._init_args_for_pool_manager)
+
         return (
             urllib3.PoolManager(**pool_manager_init_args)
             if self._proxy_url is None

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/appium/webdriver/webdriver.py

@@ -14,6 +14,7 @@
 
 # pylint: disable=too-many-lines,too-many-public-methods,too-many-statements,no-self-use
 
+import warnings
 from typing import Any, Callable, Dict, List, Optional, Tuple, TypeVar, Union
 
 from selenium import webdriver
@@ -203,7 +204,7 @@ class WebDriver(
 ):
     def __init__(
         self,
-        command_executor: str = 'http://127.0.0.1:4444/wd/hub',
+        command_executor: Union[str, AppiumConnection] = 'http://127.0.0.1:4444/wd/hub',
         desired_capabilities: Optional[Dict] = None,
         browser_profile: Union[str, None] = None,
         proxy: Union[str, None] = None,
@@ -227,8 +228,11 @@ class WebDriver(
             AppiumConnection.set_certificate_bundle_path(None)
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
+        if isinstance(command_executor, str):
+            command_executor = AppiumConnection(command_executor, keep_alive=keep_alive)
+
         super().__init__(
-            command_executor=AppiumConnection(command_executor, keep_alive=keep_alive),
+            command_executor=command_executor,
             desired_capabilities=desired_capabilities,
             browser_profile=browser_profile,
             proxy=proxy,
@@ -434,6 +438,7 @@ class WebDriver(
 
     def set_value(self: T, element: MobileWebElement, value: str) -> T:
         """Set the value on an element in the application.
+        deprecated:: 2.8.1
 
         Args:
             element: the element whose value will be set
@@ -442,10 +447,14 @@ class WebDriver(
         Returns:
             `appium.webdriver.webdriver.WebDriver`: Self instance
         """
-        data = {
-            'id': element.id,
-            'value': [value],
-        }
+        warnings.warn(
+            'The "setValue" API is deprecated and will be removed in future versions. '
+            'Instead the "send_keys" API or W3C Actions can be used. '
+            'See https://github.com/appium/python-client/pull/831',
+            DeprecationWarning,
+        )
+
+        data = {'text': value}
         self.execute(Command.SET_IMMEDIATE_VALUE, data)
         return self
 

{Appium-Python-Client-2.8.0 → Appium-Python-Client-2.9.0}/appium/webdriver/webelement.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import warnings
 from typing import Callable, Dict, List, Optional, Union
 
 from selenium.webdriver.common.utils import keys_to_typing
@@ -157,6 +158,7 @@ class WebElement(SeleniumWebElement):
 
     def set_text(self, keys: str = '') -> 'WebElement':
         """Sends text to the element.
+        deprecated:: 2.8.1
 
         Previous text is removed.
         Android only.
@@ -170,7 +172,14 @@ class WebElement(SeleniumWebElement):
         Returns:
             `appium.webdriver.webelement.WebElement`
         """
-        data = {'id': self._id, 'value': [keys]}
+        warnings.warn(
+            'The "setText" API is deprecated and will be removed in future versions. '
+            'Instead the "send_keys" API or W3C Actions can be used. '
+            'See https://github.com/appium/python-client/pull/831',
+            DeprecationWarning,
+        )
+
+        data = {'text': keys}
         self._execute(Command.REPLACE_KEYS, data)
         return self
 
@@ -190,6 +199,7 @@ class WebElement(SeleniumWebElement):
 
     def set_value(self, value: str) -> 'WebElement':
         """Set the value on this element in the application
+        deprecated:: 2.8.1
 
         Args:
             value: The value to be set
@@ -197,10 +207,14 @@ class WebElement(SeleniumWebElement):
         Returns:
             `appium.webdriver.webelement.WebElement`
         """
-        data = {
-            'id': self.id,
-            'value': [value],
-        }
+        warnings.warn(
+            'The "setValue" API is deprecated and will be removed in future versions. '
+            'Instead the "send_keys" API or W3C Actions can be used. '
+            'See https://github.com/appium/python-client/pull/831',
+            DeprecationWarning,
+        )
+
+        data = {'text': value}
         self._execute(Command.SET_IMMEDIATE_VALUE, data)
         return self
 

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

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

Appium-Python-Client-2.8.0/docs/appium.common.rst

@@ -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-2.8.0/docs/appium.rst

@@ -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-2.8.0/docs/appium.webdriver.common.rst

@@ -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: