Appium-Python-Client 5.2.2__tar.gz → 5.2.3__tar.gz

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/.github/workflows/functional-test.yml

@@ -21,14 +21,14 @@ jobs:
           - target: test/functional/ios/safari_tests.py
             name: func_test_ios1
 
-    runs-on: macos-14
+    runs-on: macos-15
 
     # Please make sure the available Xcode versions and iOS versions
     # on the runner images. https://github.com/actions/runner-images
     env:
-      XCODE_VERSION: 15.3
-      IOS_VERSION: 17.4
-      IPHONE_MODEL: iPhone 15 Plus
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IPHONE_MODEL: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v4
@@ -186,7 +186,7 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - platform: macos-14
+          - platform: macos-15
             e2e-tests: flutter-ios
           - platform: ubuntu-latest
             e2e-tests: flutter-android
@@ -197,9 +197,9 @@ jobs:
       API_LEVEL: 28
       ARCH: x86
       CI: true
-      XCODE_VERSION: 15.4
-      IOS_VERSION: 17.5
-      IPHONE_MODEL: iPhone 15
+      XCODE_VERSION: 16.4
+      IOS_VERSION: 18.5
+      IPHONE_MODEL: iPhone 16
       FLUTTER_ANDROID_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/app-debug.apk"
       FLUTTER_IOS_APP: "https://github.com/AppiumTestDistribution/appium-flutter-server/releases/latest/download/ios.zip"
 
@@ -231,12 +231,12 @@ jobs:
         node-version: 'lts/*'
 
     - name: Install Appium
-      run: npm install --location=global appium
+      run: npm install --location=global appium@2.19.0
 
     - name: Install Android drivers and Run Appium
       if: matrix.e2e-tests == 'flutter-android'
       run: |
-        appium driver install uiautomator2
+        appium driver install uiautomator2@4.2.9
         appium driver install appium-flutter-integration-driver --source npm
         nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_flutter_android.log &
 
@@ -279,7 +279,7 @@ jobs:
     - name: Install IOS drivers and Run Appium
       if: matrix.e2e-tests == 'flutter-ios'
       run: |
-        appium driver install xcuitest
+        appium driver install xcuitest@9.10.5
         appium driver install appium-flutter-integration-driver --source npm
         appium driver run xcuitest build-wda
         nohup appium --allow-insecure=adb_shell --relaxed-security --log-timestamp --log-no-colors 2>&1 > appium_ios.log &

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 <!-- version list -->
 
+## v5.2.3 (2025-09-09)
+
+### Bug Fixes
+
+- Adjust images payload for image comparison API
+  ([#1170](https://github.com/appium/python-client/pull/1170),
+  [`b471a05`](https://github.com/appium/python-client/commit/b471a050833c59bb5cacf0872013bd5dc1f24491))
+
+### Continuous Integration
+
+- Update CI config ([#1171](https://github.com/appium/python-client/pull/1171),
+  [`f867ea5`](https://github.com/appium/python-client/commit/f867ea580c86e043b5fbb586149a18ad87d08239))
+
+
 ## v5.2.2 (2025-08-15)
 
 ### Chores

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Appium-Python-Client
-Version: 5.2.2
+Version: 5.2.3
 Summary: Python client for Appium
 Project-URL: Homepage, http://appium.io/
 Project-URL: Repository, https://github.com/appium/python-client

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/appium/webdriver/extensions/images_comparison.py

@@ -18,9 +18,11 @@ from appium.protocols.webdriver.can_execute_commands import CanExecuteCommands
 
 from ..mobilecommand import MobileCommand as Command
 
+Base64Payload = Union[str, bytes]
+
 
 class ImagesComparison(CanExecuteCommands):
-    def match_images_features(self, base64_image1: bytes, base64_image2: bytes, **opts: Any) -> Dict[str, Any]:
+    def match_images_features(self, base64_image1: Base64Payload, base64_image2: Base64Payload, **opts: Any) -> Dict[str, Any]:
         """Performs images matching by features.
 
         Read
@@ -66,11 +68,16 @@ class ImagesComparison(CanExecuteCommands):
             rect2 (dict): The bounding rect for the `points2` array or a zero rect if not enough matching points
                 were found. The rect is represented by a dictionary with 'x', 'y', 'width' and 'height' keys
         """
-        options = {'mode': 'matchFeatures', 'firstImage': base64_image1, 'secondImage': base64_image2, 'options': opts}
+        options = {
+            'mode': 'matchFeatures',
+            'firstImage': _adjust_image_payload(base64_image1),
+            'secondImage': _adjust_image_payload(base64_image2),
+            'options': opts,
+        }
         return self.execute(Command.COMPARE_IMAGES, options)['value']
 
     def find_image_occurrence(
-        self, base64_full_image: bytes, base64_partial_image: bytes, **opts: Any
+        self, base64_full_image: Base64Payload, base64_partial_image: Base64Payload, **opts: Any
     ) -> Dict[str, Union[bytes, Dict]]:
         """Performs images matching by template to find possible occurrence of the partial image
         in the full image.
@@ -97,13 +104,15 @@ class ImagesComparison(CanExecuteCommands):
         """
         options = {
             'mode': 'matchTemplate',
-            'firstImage': base64_full_image,
-            'secondImage': base64_partial_image,
+            'firstImage': _adjust_image_payload(base64_full_image),
+            'secondImage': _adjust_image_payload(base64_partial_image),
             'options': opts,
         }
         return self.execute(Command.COMPARE_IMAGES, options)['value']
 
-    def get_images_similarity(self, base64_image1: bytes, base64_image2: bytes, **opts: Any) -> Dict[str, Union[bytes, Dict]]:
+    def get_images_similarity(
+        self, base64_image1: Base64Payload, base64_image2: Base64Payload, **opts: Any
+    ) -> Dict[str, Union[bytes, Dict]]:
         """Performs images matching to calculate the similarity score between them.
 
         The flow there is similar to the one used in
@@ -125,8 +134,17 @@ class ImagesComparison(CanExecuteCommands):
                 score (float): The similarity score as a float number in range [0.0, 1.0].
                     1.0 is the highest score (means both images are totally equal).
         """
-        options = {'mode': 'getSimilarity', 'firstImage': base64_image1, 'secondImage': base64_image2, 'options': opts}
+        options = {
+            'mode': 'getSimilarity',
+            'firstImage': _adjust_image_payload(base64_image1),
+            'secondImage': _adjust_image_payload(base64_image2),
+            'options': opts,
+        }
         return self.execute(Command.COMPARE_IMAGES, options)['value']
 
     def _add_commands(self) -> None:
         self.command_executor.add_command(Command.COMPARE_IMAGES, 'POST', '/session/$sessionId/appium/compare_images')
+
+
+def _adjust_image_payload(payload: Base64Payload) -> str:
+    return payload if isinstance(payload, str) else payload.decode('utf-8')

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/pyproject.toml

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

{appium_python_client-5.2.2 → appium_python_client-5.2.3}/uv.lock

@@ -43,7 +43,7 @@ wheels = [
 
 [[package]]
 name = "appium-python-client"
-version = "5.2.2"
+version = "5.2.3"
 source = { editable = "." }
 dependencies = [
     { name = "selenium" },