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

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/.github/workflows/functional-test.yml

@@ -83,7 +83,7 @@ jobs:
         python-version: 3.14
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v10.3.1
+      uses: astral-sh/setup-uv@v10.3.3
       with:
         enable-cache: true
         python-version: '3.14'
@@ -190,7 +190,7 @@ jobs:
         python-version: 3.14
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v10.3.1
+      uses: astral-sh/setup-uv@v10.3.3
       with:
         enable-cache: true
         python-version: '3.14'
@@ -306,7 +306,7 @@ jobs:
         log_file: appium-${{ matrix.e2e-tests }}.log
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v10.3.1
+      uses: astral-sh/setup-uv@v10.3.3
       with:
         enable-cache: true
         python-version: '3.14'

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/.github/workflows/unit-test.yml

@@ -25,7 +25,7 @@ jobs:
       with:
         python-version: '3.14'
     - name: Set up uv
-      uses: astral-sh/setup-uv@v10.3.1
+      uses: astral-sh/setup-uv@v10.3.3
       with:
         enable-cache: true
         python-version: '3.14'
@@ -47,7 +47,7 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Set up uv
-      uses: astral-sh/setup-uv@v10.3.1
+      uses: astral-sh/setup-uv@v10.3.3
       with:
         enable-cache: true
         python-version: ${{ matrix.python-version }}

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

@@ -2,6 +2,43 @@
 
 <!-- version list -->
 
+## v6.1.2 (2026-11-01)
+
+### Bug Fixes
+
+- Correct return types of image comparison and get_events
+  ([#1347](https://github.com/appium/python-client/pull/1347),
+  [`16fc1f3`](https://github.com/appium/python-client/commit/16fc1f3807e9c05b55549585de6f3d225c72fba6))
+
+- Correct screen recording return types and documented options
+  ([#1346](https://github.com/appium/python-client/pull/1346),
+  [`b92ec44`](https://github.com/appium/python-client/commit/b92ec444ab68f0588edff3608e5bf7d4d4251073))
+
+### Continuous Integration
+
+- **deps**: Bump astral-sh/setup-uv from 10.3.1 to 10.3.3
+  ([#1348](https://github.com/appium/python-client/pull/1348),
+  [`f7143a7`](https://github.com/appium/python-client/commit/f7143a75fa13a6edb544f486c9572459f4b08ace))
+
+### Refactoring
+
+- Consolidate the process end handling ([#1349](https://github.com/appium/python-client/pull/1349),
+  [`6abcf22`](https://github.com/appium/python-client/commit/6abcf22581928377bdc43aab083ddd6667564923))
+
+
+## v6.1.1 (2026-10-31)
+
+### Bug Fixes
+
+- Keep the server's error output when it ignores terminate
+  ([#1342](https://github.com/appium/python-client/pull/1342),
+  [`4442366`](https://github.com/appium/python-client/commit/4442366d3bd5b82a063d38836054070c3720ccab))
+
+- Prevent AppiumService.start from hanging when the server fails to start
+  ([#1342](https://github.com/appium/python-client/pull/1342),
+  [`4442366`](https://github.com/appium/python-client/commit/4442366d3bd5b82a063d38836054070c3720ccab))
+
+
 ## v6.1.0 (2026-10-31)
 
 ### Features

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

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

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/appium/webdriver/appium_service.py

@@ -27,6 +27,7 @@ from selenium.webdriver.remote.remote_connection import urllib3
 DEFAULT_HOST = '127.0.0.1'
 DEFAULT_PORT = 4723
 STARTUP_TIMEOUT_MS = 60000
+STOP_TIMEOUT_SEC = 5.5
 STATE_CHECK_INTERVAL_MS = 500
 MAIN_SCRIPT_PATH = 'appium/build/lib/main.js'
 STATUS_URL = '/status'
@@ -124,15 +125,16 @@ class AppiumService:
             error_msg = startup_failure_msg
         if error_msg is not None:
             if stderr == sp.PIPE and self._process.stderr is not None:
-                # noinspection PyUnresolvedReferences
-                err_output = self._process.stderr.read()
+                # The server might still be running, for example if it does not listen on the expected URL.
+                # Reading its stderr before the process exits would block forever, so terminate it first.
+                err_output = self._terminate_process(STOP_TIMEOUT_SEC)
                 if err_output:
                     error_msg += f'\nOriginal error: {str(err_output)}'
             self.stop()
             raise AppiumServiceError(error_msg)
         return self._process
 
-    def stop(self, timeout: float = 5.5) -> bool:
+    def stop(self, timeout: float = STOP_TIMEOUT_SEC) -> bool:
         """Stops Appium service if it is running.
 
         The call will be ignored if the service is not running
@@ -144,21 +146,37 @@ class AppiumService:
         Returns:
             `True` if the service was running before being stopped
         """
-        was_running = False
-        if self.is_running:
-            assert self._process
-            was_running = True
-            self._process.terminate()
+        was_running = self.is_running
+        if was_running:
+            self._terminate_process(timeout)
+        else:
+            self._process = None
+            self._cmd = None
+        return was_running
+
+    def _terminate_process(self, timeout: float) -> bytes | str | None:
+        """Terminate the process and collect stderr within bounded waits."""
+        process = self._process
+        if process is None:
+            return None
+        try:
+            process.terminate()
             try:
-                self._process.communicate(timeout=timeout)
+                _, stderr = process.communicate(timeout=timeout)
             except sp.SubprocessError:
                 if sys.platform == 'win32':
-                    sp.call(['taskkill', '/f', '/pid', str(self._process.pid)])
+                    sp.call(['taskkill', '/f', '/pid', str(process.pid)])
                 else:
-                    self._process.kill()
-        self._process = None
-        self._cmd = None
-        return was_running
+                    process.kill()
+                try:
+                    _, stderr = process.communicate(timeout=timeout)
+                except sp.TimeoutExpired as e:
+                    # Another process might still hold stderr open. Keep the output read so far.
+                    stderr = e.stderr
+            return stderr
+        finally:
+            self._process = None
+            self._cmd = None
 
     @property
     def is_running(self) -> bool:

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/appium/webdriver/extensions/images_comparison.py

@@ -51,7 +51,7 @@ class ImagesComparison(CanExecuteCommands):
         Returns:
             The dictionary containing the following entries:
 
-            visualization (bytes): base64-encoded content of PNG visualization of the current comparison
+            visualization (str): base64-encoded content of PNG visualization of the current comparison
                 operation. This entry is only present if `visualize` option is enabled
             count (int): The count of matched edges on both images.
                 The more matching edges there are no both images the more similar they are.
@@ -59,11 +59,11 @@ class ImagesComparison(CanExecuteCommands):
                 It is equal to `count` if `goodMatchesFactor` does not limit the matches,
                 otherwise it contains the total count of matches before `goodMatchesFactor` is
                 applied.
-            points1 (dict): The array of matching points on the first image. Each point is a dictionary
+            points1 (list): The array of matching points on the first image. Each point is a dictionary
                 with 'x' and 'y' keys
             rect1 (dict): The bounding rect for the `points1` 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
-            points2 (dict): The array of matching points on the second image. Each point is a dictionary
+            points2 (list): The array of matching points on the second image. Each point is a dictionary
                 with 'x' and 'y' keys
             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
@@ -78,7 +78,7 @@ class ImagesComparison(CanExecuteCommands):
 
     def find_image_occurrence(
         self, base64_full_image: Base64Payload, base64_partial_image: Base64Payload, **opts: Any
-    ) -> dict[str, bytes | dict]:
+    ) -> dict[str, Any] | list[dict[str, Any]]:
         """Performs images matching by template to find possible occurrence of the partial image
         in the full image.
 
@@ -94,13 +94,17 @@ class ImagesComparison(CanExecuteCommands):
         Keyword Args:
             visualize (bool): Set it to True in order to return the visualization of the matching operation.
                 False by default
+            multiple (bool): Set it to True in order to return all matches above the threshold
+                as a list. False by default
 
         Returns:
-            The dictionary containing the following entries:
-                visualization (bytes): base64-encoded content of PNG visualization of the current comparison
-                    operation. This entry is only present if `visualize` option is enabled
+            The dictionary containing the following entries, or a list of such dictionaries
+            (one per match) if `multiple` is enabled:
+                visualization (str): base64-encoded content of PNG visualization of the current comparison
+                    operation. This entry is only filled if `visualize` option is enabled
                 rect (dict): The region of the partial image occurrence on the full image.
                     The rect is represented by a dictionary with 'x', 'y', 'width' and 'height' keys
+                score (float): The similarity score of the match
         """
         options = {
             'mode': 'matchTemplate',
@@ -110,9 +114,7 @@ class ImagesComparison(CanExecuteCommands):
         }
         return self.execute(Command.COMPARE_IMAGES, options)['value']
 
-    def get_images_similarity(
-        self, base64_image1: Base64Payload, base64_image2: Base64Payload, **opts: Any
-    ) -> dict[str, bytes | dict]:
+    def get_images_similarity(self, base64_image1: Base64Payload, base64_image2: Base64Payload, **opts: Any) -> dict[str, Any]:
         """Performs images matching to calculate the similarity score between them.
 
         The flow there is similar to the one used in
@@ -124,12 +126,12 @@ class ImagesComparison(CanExecuteCommands):
             base64_image2: base64-encoded content of the second image
 
         Keyword Args:
-            visualize (boo): Set it to True in order to return the visualization of the matching operation.
+            visualize (bool): Set it to True in order to return the visualization of the matching operation.
                 False by default
 
         Returns:
             The dictionary containing the following entries:
-                visualization (bytes): base64-encoded content of PNG visualization of the current comparison
+                visualization (str): base64-encoded content of PNG visualization of the current comparison
                     operation. This entry is only present if `visualize` option is enabled
                 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).

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/appium/webdriver/extensions/log_event.py

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+from typing import Any
+
 from typing_extensions import Self
 
 from appium.protocols.webdriver.can_execute_commands import CanExecuteCommands
@@ -21,7 +23,7 @@ from ..mobilecommand import MobileCommand as Command
 
 
 class LogEvent(CanExecuteCommands):
-    def get_events(self, type: list[str] | None = None) -> dict[str, str | int]:
+    def get_events(self, type: list[str] | None = None) -> dict[str, Any]:
         """Retrieves events information from the current session
         (Since Appium 1.16.0)
 
@@ -33,11 +35,13 @@ class LogEvent(CanExecuteCommands):
             | events = driver.get_events(['appium:funEvent'])
 
         Returns:
-            `dict`: A dictionary of events timing information containing the following entries
+            `dict`: A dictionary of events timing information. Every value is a list.
                 | commands: (`list` of `dict`) List of dictionaries containing the following entries
                 | cmd: The command name that has been sent to the appium server
                 | startTime: Received time
                 | endTime: Response time
+                | Each other key is an event name, such as 'appium:funEvent', and its value is
+                | the `list` of timestamps (`int`, milliseconds) when that event happened
         """
         data = {}
         if type is not None:

{appium_python_client-6.1.0 → appium_python_client-6.1.2}/appium/webdriver/extensions/screen_record.py

@@ -20,7 +20,7 @@ from ..mobilecommand import MobileCommand as Command
 
 
 class ScreenRecord(CanExecuteCommands):
-    def start_recording_screen(self, **options: Any) -> bytes | str:
+    def start_recording_screen(self, **options: Any) -> str | None:
         """Start asynchronous screen recording process.
 
         +--------------+-----+---------+-----+-------+
@@ -50,7 +50,9 @@ class ScreenRecord(CanExecuteCommands):
         +--------------+-----+---------+-----+-------+
         | videoFps     | O   |         |     |       |
         +--------------+-----+---------+-----+-------+
-        | videoFilter  | O   |         | O   | O     |
+        | videoFilters | O   |         |     |       |
+        +--------------+-----+---------+-----+-------+
+        | videoFilter  |     |         | O   | O     |
         +--------------+-----+---------+-----+-------+
         | videoScale   | O   |         |     |       |
         +--------------+-----+---------+-----+-------+
@@ -93,13 +95,14 @@ class ScreenRecord(CanExecuteCommands):
                 Only has an effect if `remotePath` is set.
             timeLimit (int): The actual time limit of the recorded video in seconds.
                 The default value for both iOS and Android is 180 seconds (3 minutes).
-                The default value for macOS is 600 seconds (10 minutes).
-                The maximum value for Android is 3 minutes.
-                The maximum value for iOS is 10 minutes.
-                The maximum value for macOS is 10000 seconds (166 minutes).
-            forcedRestart (bool): Whether to ignore the result of previous capture and start a new recording
+                The default value for Windows and macOS is 600 seconds (10 minutes).
+                The maximum value for Android is 1800 seconds (30 minutes).
+                The maximum value for iOS is 4200 seconds (70 minutes).
+            forceRestart (bool): Whether to ignore the result of previous capture and start a new recording
                 immediately (`True` value). By default  (`False`) the endpoint will try to catch and
                 return the result of the previous capture if it's still available.
+                On Windows and macOS the default is `True`, and `False` makes the call do nothing
+                while a recording is already running.
             fileFieldName (str): [multipart/form-data requests] The name of the form field
                 containing the binary payload. "file" by default. (Since Appium 1.18.0)
             formFields (dict): [multipart/form-data requests] Additional form fields mapping. If any entry has
@@ -113,7 +116,7 @@ class ScreenRecord(CanExecuteCommands):
                 'mjpeg' by default. (Since Appium 1.10.0)
             videoFps (int): [iOS] The Frames Per Second rate of the recorded video. Change this value if the
                 resulting video is too slow or too fast. Defaults to 10. This can decrease the resulting file size.
-            videoFilters (str): [iOS, Win, macOS] The FFMPEG video filters to apply. These filters allow to scale,
+            videoFilters (str): [iOS] The FFMPEG video filters to apply. These filters allow to scale,
                 flip, rotate and do many other useful transformations on the source video stream. The format of the
                 property must comply with https://ffmpeg.org/ffmpeg-filters.html. (Since Appium 1.15)
             videoScale (str): [iOS] The scaling value to apply. Read https://trac.ffmpeg.org/wiki/Scaling for
@@ -129,7 +132,7 @@ class ScreenRecord(CanExecuteCommands):
             bitRate (int): [Android] The video bit rate for the video, in bits per second.
                 The default value is 4000000 (4 Mbit/s). You can increase the bit rate to improve video quality,
                 but doing so results in larger movie files.
-            bugReport (str): [Android] Makes the recorder to display an additional information on the video overlay,
+            bugReport (bool): [Android] Makes the recorder to display an additional information on the video overlay,
                 such as a timestamp, that is helpful in videos captured to illustrate bugs.
                 This option is only supported since API level 27 (Android P).
 
@@ -137,8 +140,10 @@ class ScreenRecord(CanExecuteCommands):
                 Increasing fps value also increases the size of the resulting video file and the CPU usage.
             captureCursor (bool): [Win, macOS] Whether to capture the mouse cursor while recording the screen.
                 Disabled by default.
-            captureClick (bool): [Win, macOS] Whether to capture the click gestures while recording the screen.
+            captureClicks (bool): [Win, macOS] Whether to capture the click gestures while recording the screen.
                 Disabled by default.
+            videoFilter (str): [Win, macOS] The FFMPEG video filter to apply. The format is the same as
+                for `videoFilters`.
             deviceId (int): [macOS] Screen device index to use for the recording.
                 The list of available devices could be retrieved using
                 `ffmpeg -f avfoundation -list_devices true -i` command.
@@ -155,16 +160,17 @@ class ScreenRecord(CanExecuteCommands):
             driver.start_recording_screen()
 
         Returns:
-            bytes: Base-64 encoded content of the recorded media
+            str | None: [iOS, Android] Base-64 encoded content of the recorded media
                 if `stop_recording_screen` isn't called after previous `start_recording_screen`.
                 Otherwise returns an empty string.
+                [Win, macOS] Always None.
         """
         if 'password' in options:
             options['pass'] = options['password']
             del options['password']
         return self.execute(Command.START_RECORDING_SCREEN, {'options': options})['value']
 
-    def stop_recording_screen(self, **options: Any) -> bytes:
+    def stop_recording_screen(self, **options: Any) -> str:
         """Gather the output from the previously started screen recording to a media file.
 
         Keyword Args:
@@ -196,7 +202,7 @@ class ScreenRecord(CanExecuteCommands):
                     fd.write(base64.b64decode(payload))
 
         Returns:
-            bytes: Base-64 encoded content of the recorded media file or an empty string
+            str: Base-64 encoded content of the recorded media file or an empty string
                 if the file has been successfully uploaded to a remote location
                 (depends on the actual `remotePath` value).
         """

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

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

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

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