Appium-Python-Client 6.1.2__tar.gz → 6.1.4__tar.gz

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 <!-- version list -->
 
+## v6.1.4 (2026-11-02)
+
+### Bug Fixes
+
+- **flutter**: Accept a FlutterFinder as scrollView in scroll_till_visible
+  ([#1352](https://github.com/appium/python-client/pull/1352),
+  [`1ac4254`](https://github.com/appium/python-client/commit/1ac4254acd804171ebc091f333c09e54b6715110))
+
+### Testing
+
+- **webdriver**: Add unit tests for HardwareActions.unlock
+  ([#1331](https://github.com/appium/python-client/pull/1331),
+  [`9c723e8`](https://github.com/appium/python-client/commit/9c723e8c1d455216e945d7a709ca7437479bc097))
+
+
+## v6.1.3 (2026-11-02)
+
+### Bug Fixes
+
+- **flutter**: Support horizontal scrolling in scroll_till_visible
+  ([#1351](https://github.com/appium/python-client/pull/1351),
+  [`ae9042d`](https://github.com/appium/python-client/commit/ae9042dcabd6c6b6967f938b8bbb38683f58ded1))
+
+### Documentation
+
+- Fix broken README and docstring examples
+  ([#1350](https://github.com/appium/python-client/pull/1350),
+  [`6e0bf47`](https://github.com/appium/python-client/commit/6e0bf47fc8e0fb3f6737f79bd9d07fb7d53d23fc))
+
+
 ## v6.1.2 (2026-11-01)
 
 ### Bug Fixes

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: Appium-Python-Client
-Version: 6.1.2
+Version: 6.1.4
 Summary: Python client for Appium
 Project-URL: Homepage, https://appium.io/
 Project-URL: Repository, https://github.com/appium/python-client
@@ -232,7 +232,7 @@ def appium_service():
 
 def create_ios_driver(custom_opts=None):
     options = XCUITestOptions()
-    options.platformVersion = '13.4'
+    options.platform_version = '13.4'
     options.udid = '123456789ABC'
     if custom_opts is not None:
         options.load_capabilities(custom_opts)
@@ -242,7 +242,7 @@ def create_ios_driver(custom_opts=None):
 
 def create_android_driver(custom_opts=None):
     options = UiAutomator2Options()
-    options.platformVersion = '10'
+    options.platform_version = '10'
     options.udid = '123456789ABC'
     if custom_opts is not None:
         options.load_capabilities(custom_opts)
@@ -408,15 +408,20 @@ from appium.options.ios import XCUITestOptions
 
 import urllib3
 from appium.webdriver.appium_connection import AppiumConnection
+from appium.webdriver.client_config import AppiumClientConfig
 
 # 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
+# Selenium passes the arguments under the nested 'init_args_for_pool_manager' key to urllib3.PoolManager.
+init_args_for_pool_manager = {
+    'init_args_for_pool_manager': {'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)}
+}
+client_config = AppiumClientConfig(
+    remote_server_addr='http://127.0.0.1:4723', init_args_for_pool_manager=init_args_for_pool_manager
 )
+appium_executor = AppiumConnection(client_config=client_config)
 
 options = XCUITestOptions()
-options.platformVersion = '13.4'
+options.platform_version = '13.4'
 options.udid = '123456789ABC'
 options.app = '/full/path/to/app/UICatalog.app.zip'
 driver = webdriver.Remote(appium_executor, options=options)

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/README.md

@@ -204,7 +204,7 @@ def appium_service():
 
 def create_ios_driver(custom_opts=None):
     options = XCUITestOptions()
-    options.platformVersion = '13.4'
+    options.platform_version = '13.4'
     options.udid = '123456789ABC'
     if custom_opts is not None:
         options.load_capabilities(custom_opts)
@@ -214,7 +214,7 @@ def create_ios_driver(custom_opts=None):
 
 def create_android_driver(custom_opts=None):
     options = UiAutomator2Options()
-    options.platformVersion = '10'
+    options.platform_version = '10'
     options.udid = '123456789ABC'
     if custom_opts is not None:
         options.load_capabilities(custom_opts)
@@ -380,15 +380,20 @@ from appium.options.ios import XCUITestOptions
 
 import urllib3
 from appium.webdriver.appium_connection import AppiumConnection
+from appium.webdriver.client_config import AppiumClientConfig
 
 # 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
+# Selenium passes the arguments under the nested 'init_args_for_pool_manager' key to urllib3.PoolManager.
+init_args_for_pool_manager = {
+    'init_args_for_pool_manager': {'retries': urllib3.util.retry.Retry(total=3, connect=3, read=False)}
+}
+client_config = AppiumClientConfig(
+    remote_server_addr='http://127.0.0.1:4723', init_args_for_pool_manager=init_args_for_pool_manager
 )
+appium_executor = AppiumConnection(client_config=client_config)
 
 options = XCUITestOptions()
-options.platformVersion = '13.4'
+options.platform_version = '13.4'
 options.udid = '123456789ABC'
 options.app = '/full/path/to/app/UICatalog.app.zip'
 driver = webdriver.Remote(appium_executor, options=options)

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/appium/webdriver/extensions/flutter_integration/flutter_commands.py

@@ -38,7 +38,8 @@ class FlutterCommand:
 
         Args:
             locator (Union[WebElement, FlutterFinder]): The element to wait for; can be a WebElement or a FlutterFinder.
-            timeout (Optional[float]): Maximum wait time in seconds. Defaults to a predefined timeout if not specified.
+            timeout (Optional[float]): Maximum wait time in whole seconds. The Flutter server drops any fractional
+                part, so 0.5 becomes 0. Defaults to a predefined timeout if not specified.
 
         Returns:
             None
@@ -59,7 +60,8 @@ class FlutterCommand:
 
         Args:
             locator (Union[WebElement, FlutterFinder]): The element to wait for; can be a WebElement or a FlutterFinder.
-            timeout (Optional[float]): Maximum wait time in seconds. Defaults to a predefined timeout if not specified.
+            timeout (Optional[float]): Maximum wait time in whole seconds. The Flutter server drops any fractional
+                part, so 0.5 becomes 0. Defaults to a predefined timeout if not specified.
 
         Returns:
             None:
@@ -128,10 +130,10 @@ class FlutterCommand:
 
         Args:
             scroll_to (FlutterFinder): The Flutter element to scroll to.
-            scroll_direction (ScrollDirection): The direction to scroll up or down. Defaults to `ScrollDirection.DOWN`.
+            scroll_direction (ScrollDirection): The direction to scroll. Defaults to `ScrollDirection.DOWN`.
 
         KeywordArgs:
-                scrollView (str): The view of the scroll. Default value is 'Scrollable'
+                scrollView (FlutterFinder | dict): Finder of the scrollable view. Defaults to the first `Scrollable` widget
                 delta (int): delta for the scroll. Default value is 64
                 maxScrolls (int): Max times to scroll. Default value is 15
                 settleBetweenScrollsTimeout (float): settle timeout in milliseconds. Default value is 5000
@@ -142,6 +144,8 @@ class FlutterCommand:
         """
         opts['finder'] = scroll_to.to_dict()
         opts['scrollDirection'] = scroll_direction.value
+        if isinstance(opts.get('scrollView'), FlutterFinder):
+            opts['scrollView'] = opts['scrollView'].to_dict()
         return self.execute_flutter_command('scrollTillVisible', opts)
 
     def inject_mock_image(self, value: str) -> str:

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/appium/webdriver/extensions/flutter_integration/scroll_directions.py

@@ -4,3 +4,5 @@ from enum import Enum
 class ScrollDirection(Enum):
     UP = 'up'
     DOWN = 'down'
+    LEFT = 'left'
+    RIGHT = 'right'

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/appium/webdriver/webdriver.py

@@ -74,7 +74,7 @@ class ExtensionBase:
 
     Example:
         When you want to add `example_command` which calls a get request to
-        `session/$sessionId/path/to/your/custom/url`.
+        `/session/$sessionId/path/to/your/custom/url`.
 
         #. Defines an extension as a subclass of `ExtensionBase`
             .. code-block:: python
@@ -91,7 +91,7 @@ class ExtensionBase:
 
                     # Used to register the command pair as "Appium command" in this driver.
                     def add_command(self):
-                        return ('GET', 'session/$sessionId/path/to/your/custom/url')
+                        return ('GET', '/session/$sessionId/path/to/your/custom/url')
 
         #. Creates a session with the extension.
             .. code-block:: python
@@ -105,7 +105,7 @@ class ExtensionBase:
             .. code-block:: python
 
                 # Then, the driver calls a get request against
-                # `session/$sessionId/path/to/your/custom/url`. `$sessionId` will be
+                # `/session/$sessionId/path/to/your/custom/url`. `$sessionId` will be
                 # replaced properly in the driver. Then, the method returns
                 # the `value` part of the response.
                 driver.custom_method_name()
@@ -127,16 +127,16 @@ class ExtensionBase:
                 def method_name(self):
                     return 'custom_method_name'
 
-                def test_command(self, argument):
+                def custom_method_name(self, argument):
                     return self.execute(argument)['value']
 
                 def add_command(self):
-                    return ('post', 'session/$sessionId/path/to/your/custom/url')
+                    return ('post', '/session/$sessionId/path/to/your/custom/url')
 
             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`
+            # Then, the driver sends a post request to `/session/$sessionId/path/to/your/custom/url`
             # with `{'dummy_arg': 'as a value'}` JSON body.
             driver.custom_method_name({'dummy_arg': 'as a value'})
 
@@ -153,13 +153,13 @@ class ExtensionBase:
                     return self.execute({'id': element_id})['value']
 
                 def add_command(self):
-                    return ('GET', 'session/$sessionId/path/to/your/custom/$id/url')
+                    return ('GET', '/session/$sessionId/path/to/your/custom/$id/url')
 
             driver = webdriver.Remote('http://localhost:4723/wd/hub', options=options,
-                extensions=[YourCustomCommand])
+                extensions=[CustomURLCommand])
             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`
+            # 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`
             driver.custom_method_name(element.id)
 

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "Appium-Python-Client"
 description = "Python client for Appium"
-version = "6.1.2"
+version = "6.1.4"
 readme = "README.md"
 license = "Apache-2.0"
 license-files = ["LICENSE"]

{appium_python_client-6.1.2 → appium_python_client-6.1.4}/uv.lock

@@ -27,7 +27,7 @@ wheels = [
 
 [[package]]
 name = "appium-python-client"
-version = "6.1.2"
+version = "6.1.4"
 source = { editable = "." }
 dependencies = [
     { name = "selenium" },