Appium-Python-Client 4.2.0__tar.gz → 4.2.1__tar.gz

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/Appium_Python_Client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.2.0
+Version: 4.2.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -25,7 +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
+Requires-Dist: selenium<4.26,~=4.12
 
 # Appium Python Client
 
@@ -34,8 +34,6 @@ Requires-Dist: selenium~=4.12
 
 [![Functional Tests](https://github.com/appium/python-client/actions/workflows/functional-test.yml/badge.svg)](https://github.com/appium/python-client/actions/workflows/functional-test.yml)
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
 An extension library for adding [WebDriver Protocol](https://www.w3.org/TR/webdriver/) and Appium commands to the Selenium Python language binding for use with the mobile testing framework [Appium](https://appium.io).
 
 ## Getting the Appium Python client
@@ -72,7 +70,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`3.0.0`+ |`4.12.0`+ | 3.8+ |
+|`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`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+ |
@@ -266,6 +264,26 @@ def test_android_click(appium_service, android_driver_factory):
         el.click()
 ```
 
+### Available `options`
+
+Appium Python Client has a common options class named `AppiumOptions` but the available commands are minimal.
+It does not have driver/automationName specific commands unless adding commands with `add_command` method.
+
+Available options for each automation name below will help to check what options are already defined.
+Please use proper options for your automaiton usage.
+
+`automationName` | Package path
+|:---|:-----|
+any | `appium.options.common.base.AppiumOptions`
+`uiautomator2` | `appium.options.android.Uiautomator2Options`
+`espresso` | `appium.options.android.EspressoOptions`
+`xcuitest` | `appium.options.ios.XCUITestOptions`
+`safari` | `appium.options.ios.SafariOptions`
+`mac2` | `appium.options.mac.Mac2Options`
+`windows` | `appium.options.WindowsOptions`
+`gecko` | `appium.options.GeckoOptions`
+`flutterintegration` | `appium.options.flutter_integration.FlutterOptions`
+
 ## Direct Connect URLs
 
 If your Selenium/Appium server decorates the new session capabilities response with the following keys:
@@ -384,7 +402,7 @@ driver = webdriver.Remote(custom_executor, options=options)
 ## Development
 
 - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
-  - Apply `black`, `isort` and `mypy` as pre commit hook
+  - Apply `ruff` as pre commit hook
   - Run `make` command for development. See `make help` output for details
 - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 - `gitchangelog` generates `CHANGELOG.rst`

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/Appium_Python_Client.egg-info/SOURCES.txt

@@ -1,7 +1,6 @@
 LICENSE
 MANIFEST.in
 README.md
-setup.cfg
 setup.py
 Appium_Python_Client.egg-info/PKG-INFO
 Appium_Python_Client.egg-info/SOURCES.txt

appium_python_client-4.2.1/Appium_Python_Client.egg-info/requires.txt

@@ -0,0 +1 @@
+selenium<4.26,~=4.12

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Appium-Python-Client
-Version: 4.2.0
+Version: 4.2.1
 Summary: Python client for Appium
 Home-page: http://appium.io/
 Author: Isaac Murchie
@@ -25,7 +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
+Requires-Dist: selenium<4.26,~=4.12
 
 # Appium Python Client
 
@@ -34,8 +34,6 @@ Requires-Dist: selenium~=4.12
 
 [![Functional Tests](https://github.com/appium/python-client/actions/workflows/functional-test.yml/badge.svg)](https://github.com/appium/python-client/actions/workflows/functional-test.yml)
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
 An extension library for adding [WebDriver Protocol](https://www.w3.org/TR/webdriver/) and Appium commands to the Selenium Python language binding for use with the mobile testing framework [Appium](https://appium.io).
 
 ## Getting the Appium Python client
@@ -72,7 +70,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`3.0.0`+ |`4.12.0`+ | 3.8+ |
+|`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`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+ |
@@ -266,6 +264,26 @@ def test_android_click(appium_service, android_driver_factory):
         el.click()
 ```
 
+### Available `options`
+
+Appium Python Client has a common options class named `AppiumOptions` but the available commands are minimal.
+It does not have driver/automationName specific commands unless adding commands with `add_command` method.
+
+Available options for each automation name below will help to check what options are already defined.
+Please use proper options for your automaiton usage.
+
+`automationName` | Package path
+|:---|:-----|
+any | `appium.options.common.base.AppiumOptions`
+`uiautomator2` | `appium.options.android.Uiautomator2Options`
+`espresso` | `appium.options.android.EspressoOptions`
+`xcuitest` | `appium.options.ios.XCUITestOptions`
+`safari` | `appium.options.ios.SafariOptions`
+`mac2` | `appium.options.mac.Mac2Options`
+`windows` | `appium.options.WindowsOptions`
+`gecko` | `appium.options.GeckoOptions`
+`flutterintegration` | `appium.options.flutter_integration.FlutterOptions`
+
 ## Direct Connect URLs
 
 If your Selenium/Appium server decorates the new session capabilities response with the following keys:
@@ -384,7 +402,7 @@ driver = webdriver.Remote(custom_executor, options=options)
 ## Development
 
 - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
-  - Apply `black`, `isort` and `mypy` as pre commit hook
+  - Apply `ruff` as pre commit hook
   - Run `make` command for development. See `make help` output for details
 - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 - `gitchangelog` generates `CHANGELOG.rst`

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/README.md

@@ -5,8 +5,6 @@
 
 [![Functional Tests](https://github.com/appium/python-client/actions/workflows/functional-test.yml/badge.svg)](https://github.com/appium/python-client/actions/workflows/functional-test.yml)
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-
 An extension library for adding [WebDriver Protocol](https://www.w3.org/TR/webdriver/) and Appium commands to the Selenium Python language binding for use with the mobile testing framework [Appium](https://appium.io).
 
 ## Getting the Appium Python client
@@ -43,7 +41,7 @@ download and unarchive the source tarball (Appium-Python-Client-X.X.tar.gz).
 
 |Appium Python Client| Selenium binding| Python version |
 |----|----|----|
-|`3.0.0`+ |`4.12.0`+ | 3.8+ |
+|`3.0.0` - `4.2.1` |`4.12.0` - `4.25.0` | 3.8+ |
 |`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+ |
@@ -237,6 +235,26 @@ def test_android_click(appium_service, android_driver_factory):
         el.click()
 ```
 
+### Available `options`
+
+Appium Python Client has a common options class named `AppiumOptions` but the available commands are minimal.
+It does not have driver/automationName specific commands unless adding commands with `add_command` method.
+
+Available options for each automation name below will help to check what options are already defined.
+Please use proper options for your automaiton usage.
+
+`automationName` | Package path
+|:---|:-----|
+any | `appium.options.common.base.AppiumOptions`
+`uiautomator2` | `appium.options.android.Uiautomator2Options`
+`espresso` | `appium.options.android.EspressoOptions`
+`xcuitest` | `appium.options.ios.XCUITestOptions`
+`safari` | `appium.options.ios.SafariOptions`
+`mac2` | `appium.options.mac.Mac2Options`
+`windows` | `appium.options.WindowsOptions`
+`gecko` | `appium.options.GeckoOptions`
+`flutterintegration` | `appium.options.flutter_integration.FlutterOptions`
+
 ## Direct Connect URLs
 
 If your Selenium/Appium server decorates the new session capabilities response with the following keys:
@@ -355,7 +373,7 @@ driver = webdriver.Remote(custom_executor, options=options)
 ## Development
 
 - Code Style: [PEP-0008](https://www.python.org/dev/peps/pep-0008/)
-  - Apply `black`, `isort` and `mypy` as pre commit hook
+  - Apply `ruff` as pre commit hook
   - Run `make` command for development. See `make help` output for details
 - Docstring style: [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 - `gitchangelog` generates `CHANGELOG.rst`

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/common/adb/adb_exec_timeout_option.py

@@ -38,6 +38,4 @@ class AdbExecTimeoutOption(SupportsCapabilities):
         Maximum time to wait until single ADB command is executed.
         20000 ms by default.
         """
-        self.set_capability(
-            ADB_EXEC_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(ADB_EXEC_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/common/app/app_wait_duration_option.py

@@ -38,6 +38,4 @@ class AppWaitDurationOption(SupportsCapabilities):
         Maximum amount of time to wait until the application under test is started
         (e.g. an activity returns the control to the caller). 20000 ms by default.
         """
-        self.set_capability(
-            APP_WAIT_DURATION, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(APP_WAIT_DURATION, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/common/avd/avd_launch_timeout_option.py

@@ -38,6 +38,4 @@ class AvdLaunchTimeoutOption(SupportsCapabilities):
         Maximum timeout to wait until Android Emulator is started.
         60000 ms by default.
         """
-        self.set_capability(
-            AVD_LAUNCH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(AVD_LAUNCH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/common/avd/avd_ready_timeout_option.py

@@ -38,6 +38,4 @@ class AvdReadyTimeoutOption(SupportsCapabilities):
         Maximum timeout to wait until Android Emulator is fully booted and is ready for usage.
         60000 ms by default
         """
-        self.set_capability(
-            AVD_READY_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(AVD_READY_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/common/context/auto_webview_timeout_option.py

@@ -38,6 +38,4 @@ class AutoWebviewTimeoutOption(SupportsCapabilities):
         """
         Timeout to wait until a web view is available.
         """
-        self.set_capability(
-            AUTO_WEBVIEW_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(AUTO_WEBVIEW_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/android/espresso/espresso_build_config_option.py

@@ -43,6 +43,4 @@ class EspressoBuildConfigOption(SupportsCapabilities):
         https://github.com/appium/appium-espresso-driver#espresso-build-config
         for more information on how to properly construct such config.
         """
-        self.set_capability(
-            ESPRESSO_BUILD_CONFIG, value if isinstance(value, str) else json.dumps(value, ensure_ascii=False)
-        )
+        self.set_capability(ESPRESSO_BUILD_CONFIG, value if isinstance(value, str) else json.dumps(value, ensure_ascii=False))

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/common/supports_capabilities.py

@@ -21,8 +21,6 @@ T = TypeVar('T')
 
 
 class SupportsCapabilities(Protocol):
-    def set_capability(self: T, name: str, value: Any) -> T:
-        ...
+    def set_capability(self: T, name: str, value: Any) -> T: ...
 
-    def get_capability(self: T, name: str) -> Any:
-        ...
+    def get_capability(self: T, name: str) -> Any: ...

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/flutter_integration/flutter_enable_mock_camera_option.py

@@ -15,7 +15,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-from typing import Optional
 
 from appium.options.common.supports_capabilities import SupportsCapabilities
 

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/ios/xcuitest/app/app_push_timeout_option.py

@@ -39,6 +39,4 @@ class AppPushTimeoutOption(SupportsCapabilities):
         Works for real devices only.
         The default value is 30000ms.
         """
-        self.set_capability(
-            APP_PUSH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(APP_PUSH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/options/ios/xcuitest/wda/wda_launch_timeout_option.py

@@ -38,6 +38,4 @@ class WdaLaunchTimeoutOption(SupportsCapabilities):
         Timeout to wait for WebDriverAgent to be pingable,
         after its building is finished. Defaults to 60000ms.
         """
-        self.set_capability(
-            WDA_LAUNCH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value
-        )
+        self.set_capability(WDA_LAUNCH_TIMEOUT, int(value.total_seconds() * 1000) if isinstance(value, timedelta) else value)

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/protocols/webdriver/can_execute_commands.py

@@ -20,5 +20,4 @@ from selenium.webdriver.remote.remote_connection import RemoteConnection
 class CanExecuteCommands(Protocol):
     command_executor: RemoteConnection
 
-    def execute(self, driver_command: str, params: Union[Dict, None] = None) -> Dict:
-        ...
+    def execute(self, driver_command: str, params: Union[Dict, None] = None) -> Dict: ...

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/protocols/webdriver/can_execute_scripts.py

@@ -16,17 +16,12 @@ from typing import Any, List, Optional, Protocol
 
 
 class CanExecuteScripts(Protocol):
-    def pin_script(self, script: str, script_key: Optional[Any] = None) -> Any:
-        ...
+    def pin_script(self, script: str, script_key: Optional[Any] = None) -> Any: ...
 
-    def unpin(self, script_key: Any) -> None:
-        ...
+    def unpin(self, script_key: Any) -> None: ...
 
-    def get_pinned_scripts(self) -> List[str]:
-        ...
+    def get_pinned_scripts(self) -> List[str]: ...
 
-    def execute_script(self, script: str, *args: Any) -> Any:
-        ...
+    def execute_script(self, script: str, *args: Any) -> Any: ...
 
-    def execute_async_script(self, script: str, *args: Any) -> Any:
-        ...
+    def execute_async_script(self, script: str, *args: Any) -> Any: ...

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/protocols/webdriver/can_find_elements.py

@@ -19,8 +19,6 @@ if TYPE_CHECKING:
 
 
 class CanFindElements(Protocol):
-    def find_element(self, by: str, value: Union[str, Dict, None] = None) -> 'WebElement':
-        ...
+    def find_element(self, by: str, value: Union[str, Dict, None] = None) -> 'WebElement': ...
 
-    def find_elements(self, by: str, value: Union[str, Dict, None] = None) -> List['WebElement']:
-        ...
+    def find_elements(self, by: str, value: Union[str, Dict, None] = None) -> List['WebElement']: ...

{appium_python_client-4.2.0 → appium_python_client-4.2.1}/appium/protocols/webdriver/can_remember_extension_presence.py

@@ -18,8 +18,6 @@ T = TypeVar('T')
 
 
 class CanRememberExtensionPresence(Protocol):
-    def assert_extension_exists(self: T, ext_name: str) -> T:
-        ...
+    def assert_extension_exists(self: T, ext_name: str) -> T: ...
 
-    def mark_extension_absence(self: T, ext_name: str) -> T:
-        ...
+    def mark_extension_absence(self: T, ext_name: str) -> T: ...

appium_python_client-4.2.1/appium/version.py

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