python-libei 0.6.1__tar.gz → 0.8.0__tar.gz

{python_libei-0.6.1/src/python_libei.egg-info → python_libei-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-libei
-Version: 0.6.1
+Version: 0.8.0
 Summary: Inject, receive and capture input on Wayland from Python: ctypes bindings for libei, libeis and liboeffis, plus the RemoteDesktop and InputCapture portals
 Author: Dennis K. Paulsen
 License-Expression: MIT
@@ -40,6 +40,7 @@ Dynamic: license-file
 
 # python-libei
 
+[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/ctrondlp/python-libei/blob/main/CONTRIBUTING.md)
 [![CI](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/python-libei)](https://pypi.org/project/python-libei/)
 [![License](https://img.shields.io/pypi/l/python-libei)](https://github.com/ctrondlp/python-libei/blob/main/LICENSE)
@@ -174,7 +175,7 @@ and why, is in
 
 ## Status
 
-Beta (`0.6.1`), published on [PyPI](https://pypi.org/project/python-libei/)
+Beta (`0.8.0`), published on [PyPI](https://pypi.org/project/python-libei/)
 since `0.1.0`, and **the API is not frozen** — expect renames before 1.0.
 
 The injection path is exercised end to end against the real libraries by the

{python_libei-0.6.1 → python_libei-0.8.0}/README.md

@@ -1,5 +1,6 @@
 # python-libei
 
+[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/ctrondlp/python-libei/blob/main/CONTRIBUTING.md)
 [![CI](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/python-libei)](https://pypi.org/project/python-libei/)
 [![License](https://img.shields.io/pypi/l/python-libei)](https://github.com/ctrondlp/python-libei/blob/main/LICENSE)
@@ -134,7 +135,7 @@ and why, is in
 
 ## Status
 
-Beta (`0.6.1`), published on [PyPI](https://pypi.org/project/python-libei/)
+Beta (`0.8.0`), published on [PyPI](https://pypi.org/project/python-libei/)
 since `0.1.0`, and **the API is not frozen** — expect renames before 1.0.
 
 The injection path is exercised end to end against the real libraries by the

{python_libei-0.6.1 → python_libei-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-libei"
-version = "0.6.1"
+version = "0.8.0"
 description = "Inject, receive and capture input on Wayland from Python: ctypes bindings for libei, libeis and liboeffis, plus the RemoteDesktop and InputCapture portals"
 readme = "README.md"
 license = "MIT"

{python_libei-0.6.1 → python_libei-0.8.0}/src/libei/__init__.py

@@ -31,6 +31,6 @@ the full breakdown, including which features need which libei version.
 Beta: the API is not frozen.
 """
 
-__version__ = "0.6.1"
+__version__ = "0.8.0"
 
 __all__ = ["__version__"]

{python_libei-0.6.1 → python_libei-0.8.0}/src/libei/portal.py

@@ -90,6 +90,8 @@ __all__ = [
     "PortalVersionError",
     "PortalDeniedError",
     "PortalTimeoutError",
+    "PortalSessionClosedError",
+    "PortalProtocolError",
     "RemoteDesktopSession",
     "Activation",
     "InputCaptureSession",
@@ -185,6 +187,67 @@ class PortalDeniedError(PortalError):
         self.message = message
 
 
+class PortalProtocolError(PortalError):
+    """A portal signal arrived with a payload that does not match the spec.
+
+    Every signal :func:`_wait_for_signal` waits on is specified as
+    ``(o session_handle, a{sv} options)``, and two kinds of mismatch used
+    to fail in two different, equally unhelpful ways. The *shape* being
+    wrong -- an empty tuple, a non-string handle, a wrong-length tuple, a
+    non-dict options -- either raised ``IndexError`` *inside* the GLib
+    signal callback, where PyGI prints the traceback to stderr and
+    swallows it so the wait hung invisibly (unboundedly, with
+    ``timeout=None``), or slipped through to the caller and crashed it with
+    ``ValueError``/``AttributeError``. A *value* inside a correctly-shaped
+    options being wrong -- an ``activation_id`` that is not an integer, a
+    ``cursor_position`` that is not two numbers -- crashed the caller later
+    still, doing arithmetic on it. Both now end the wait with this error.
+
+    ``detail`` distinguishes the two: ``None`` for a shape fault (the
+    default message names the expected shape), a phrase for a value fault
+    (naming the field). ``payload`` is whatever best shows the fault -- the
+    whole signal tuple for a shape fault, the options dict for a value one.
+    """
+
+    def __init__(self, step: str, payload: object, detail: str | None = None) -> None:
+        """Name the signal, what arrived, and -- for a value fault -- which."""
+        reason = detail or (
+            "the portal spec gives it the shape (session_handle, options dict)"
+        )
+        super().__init__(
+            f"{step} arrived with a malformed payload: {reason}, got {payload!r}"
+        )
+        # `step` mirrors the attribute every sibling portal error raised
+        # from the same `_wait_for_signal` call site carries
+        # (PortalTimeoutError, PortalSessionClosedError), so a caller that
+        # catches PortalError and reads `.step` works across all of them.
+        self.step = step
+        self.payload = payload
+        self.detail = detail
+
+
+class PortalSessionClosedError(PortalError):
+    """The portal session ended while something was still waiting on it.
+
+    The ``org.freedesktop.portal.Session`` interface emits ``Closed`` when
+    the compositor or the portal ends a session from its side -- a
+    compositor restart, the portal process dying, a session revoked from a
+    settings panel. Distinct from :class:`PortalTimeoutError` (the session
+    is fine, the signal just has not come) and from
+    :class:`PortalDeniedError` (a request was answered, negatively): here
+    there is no session left to answer anything, so the wait that raised
+    this can never be satisfied by waiting longer.
+    """
+
+    def __init__(self, step: str) -> None:
+        """Name what was being waited for when the session went away."""
+        super().__init__(
+            f"the portal session was closed while waiting for {step}; "
+            "the compositor or portal ended it from its side"
+        )
+        self.step = step
+
+
 def _gio() -> tuple[Any, Any] | None:
     """Import Gio and GLib, or return None.
 
@@ -999,6 +1062,98 @@ def _create_input_capture_session_v1(
     return session_handle
 
 
+def _classify_signal_payload(
+    args: tuple[Any, ...], session_handle: str, signal: str
+) -> str:
+    """How `_wait_for_signal` should treat one unpacked signal payload.
+
+    ``"take"`` -- it is this session's, correctly shaped, record it.
+    ``"drop"`` -- another session's; keep waiting (logged, since a dropped
+    signal is otherwise indistinguishable from one that never fired).
+    ``"malformed"`` -- not the ``(o session_handle, a{sv} options)`` shape
+    the spec gives every signal here.
+
+    Two shape checks with the session filter between them, so how a
+    malformed payload is treated depends on how it is broken. A payload
+    whose *options* are the wrong shape (the second check) is reached only
+    after the filter has matched its handle, so another session's is already
+    dropped before that check runs -- it is raised only for this session. A
+    payload with no first element, or one that is not a string, cannot be
+    matched to any session at all: there is no handle to compare it with, so
+    it is malformed for every possible waiter and is raised here whichever
+    session it might have been meant for -- the filter cannot run before it,
+    only after. In the single-session process this almost always is, the
+    distinction never arises.
+    """
+    if not args or not isinstance(args[0], str):
+        return "malformed"
+    if args[0] != session_handle:
+        logger.debug(
+            "ignoring %s for session %s while waiting for %s",
+            signal,
+            args[0],
+            session_handle,
+        )
+        return "drop"
+    if len(args) != 2 or not isinstance(args[1], dict):
+        return "malformed"
+    return "take"
+
+
+def _deactivation_id(options: dict[str, Any], signal: str) -> int:
+    """The ``activation_id`` from Deactivated's options, as the spec's ``u``.
+
+    ``_wait_for_signal`` checks the payload's *shape* -- that options is a
+    dict -- but not the types of the values in it. ``activation_id`` is a
+    ``u``, and a non-conforming portal that put something else there would
+    crash the caller with ``ValueError``/``TypeError``/``OverflowError``
+    (the last from ``int(float('inf'))``) past the shape check. Converting
+    it here turns that into the same typed :class:`PortalProtocolError` the
+    shape check raises, so a caller that guards against malformed signals
+    catches one error, not two.
+    """
+    try:
+        return int(options.get("activation_id", 0))
+    except (ValueError, TypeError, OverflowError) as exc:
+        raise PortalProtocolError(
+            signal, options, "activation_id is not an integer"
+        ) from exc
+
+
+def _activation_from_options(options: dict[str, Any], signal: str) -> Activation:
+    """Build an :class:`Activation` from Activated's options, spec-typed.
+
+    The companion to the shape check in ``_wait_for_signal`` for the value
+    level: every field the portal spec types is converted here under one
+    guard, so a non-conforming value in any of them -- an ``activation_id``
+    that is not a ``u``, a ``cursor_position`` that is not two ``d``s, a
+    ``barrier_id`` that is not a ``u`` -- becomes the same typed
+    :class:`PortalProtocolError` rather than a crash in the caller later,
+    doing arithmetic on a string. One guard rather than three means the
+    next field added to the signal is validated by construction, not by a
+    fourth hand-rolled check nobody remembers to write.
+    """
+    try:
+        activation_id = int(options.get("activation_id", 0))
+        cursor = options.get("cursor_position")
+        if cursor is None:
+            cursor_position = None
+        else:
+            cx, cy = cursor  # (dd): exactly two, or this unpacking raises
+            cursor_position = (float(cx), float(cy))
+        barrier = options.get("barrier_id")
+        barrier_id = None if barrier is None else int(barrier)
+    except (ValueError, TypeError, OverflowError) as exc:
+        raise PortalProtocolError(
+            signal, options, "an option value is not the type the spec gives it"
+        ) from exc
+    return Activation(
+        activation_id=activation_id,
+        cursor_position=cursor_position,
+        barrier_id=barrier_id,
+    )
+
+
 def _wait_for_signal(
     connection: Any,
     Gio: Any,
@@ -1034,10 +1189,60 @@ def _wait_for_signal(
     D-Bus specification restricts plain ``arg0=`` match rules to arguments
     of type STRING, and this one is an OBJECT_PATH, which is the same shape
     of silent non-delivery all over again.
+
+    A payload that does not match the spec's ``(o session_handle, a{sv}
+    options)`` shape raises :class:`PortalProtocolError` rather than being
+    unpacked on faith -- see that class for why the alternative was not an
+    exception but a hang.
     """
     loop = GLib.MainLoop()
     result: dict[str, Any] = {}
+    malformed: dict[str, Any] = {}
     timed_out = False
+    # Distinct from `timed_out`: whether `on_timeout` ran at all, either
+    # path. `on_timeout` returns False whichever branch it takes, and False
+    # is what makes GLib deregister the source -- so the finally block must
+    # key its "already removed?" check on "did on_timeout fire", not on "did
+    # the wait time out". When a signal and the deadline land in the same
+    # poll, on_timeout takes the `_settled()` early return (leaving
+    # `timed_out` False) yet its False return still removed the source;
+    # keying on `timed_out` there would double-remove it and trip the very
+    # "Source ID N was not found" critical the guard exists to avoid.
+    timeout_fired = False
+    session_closed = False
+
+    def _settled() -> bool:
+        """Whether some terminal outcome has already been recorded.
+
+        GLib dispatches every source ready in one main-context iteration,
+        regardless of an earlier ``loop.quit()``, so two outcomes -- a
+        signal and the timeout, a signal and Closed -- can both fire in the
+        same poll. Every callback checks this first so the *first* recorded
+        outcome wins and the post-loop raise order is never handed a second
+        one to misreport (a delivered activation dropped for a timeout, a
+        protocol fault overwritten by session-closed).
+        """
+        return bool(result) or bool(malformed) or timed_out or session_closed
+
+    def on_closed(*_args: Any) -> None:
+        """End the wait: a closed session can never deliver the signal.
+
+        ``Closed`` is emitted on the **session object's own path** (unlike
+        ``Activated``/``Deactivated``, which fire on the portal object --
+        see above), so the subscription below uses ``session_handle`` as
+        the path and needs no payload filtering: any ``Closed`` there is
+        this session's. Without this subscription, a wait with
+        ``timeout=None`` on a session the compositor has ended -- a
+        compositor restart, the portal dying, capture revoked from a
+        settings panel -- blocked forever, indistinguishable from a signal
+        that merely had not fired yet.
+        """
+        nonlocal session_closed
+        if _settled():
+            return
+        logger.debug("session %s closed while waiting for %s", session_handle, signal)
+        session_closed = True
+        loop.quit()
 
     def on_signal(
         _conn: Any,
@@ -1049,21 +1254,22 @@ def _wait_for_signal(
         *_a: Any,
     ) -> None:
         """Record the first matching signal; anything else is logged and dropped."""
-        if result:  # a subscription that outlives its own wait can fire twice
+        if _settled():  # a subscription outliving its wait fires twice
             return
         args = params.unpack()
-        if args[0] != session_handle:
-            # Logged, not silently dropped: this filter can hide a signal
-            # that *did* arrive just as effectively as the wrong-path
-            # subscription above did, and the two are indistinguishable
-            # from the outside -- both look exactly like a compositor that
-            # never fired. One debug line is what tells them apart.
-            logger.debug(
-                "ignoring %s for session %s while waiting for %s",
-                signal,
-                args[0],
-                session_handle,
-            )
+        # The verdict is computed by `_classify_signal_payload`, but ACTED
+        # on here and the error raised only after the loop, because this
+        # runs inside a GLib callback: PyGI prints an exception raised here
+        # to stderr and swallows it, so a bare raise on a malformed payload
+        # would leave the loop running -- a timeout at best, an unbounded
+        # hang with timeout=None, both indistinguishable from a compositor
+        # that never fired.
+        verdict = _classify_signal_payload(args, session_handle, signal)
+        if verdict == "drop":
+            return
+        if verdict == "malformed":
+            malformed["args"] = args
+            loop.quit()
             return
         logger.debug("received %s for session %s", signal, session_handle)
         result["args"] = args
@@ -1071,7 +1277,16 @@ def _wait_for_signal(
 
     def on_timeout() -> bool:
         """Stop the loop and record that it timed out rather than finished."""
-        nonlocal timed_out
+        nonlocal timed_out, timeout_fired
+        # Set first, before the early return: GLib removes the source the
+        # moment this returns False (which both paths do), so the finally
+        # block keys "already removed" on this, not on `timed_out`.
+        timeout_fired = True
+        if _settled():
+            # A signal delivered in the same poll as the deadline has
+            # already recorded its outcome; the timeout must not overwrite
+            # a real activation with PortalTimeoutError.
+            return False
         timed_out = True
         loop.quit()
         return False
@@ -1086,6 +1301,16 @@ def _wait_for_signal(
         on_signal,
         None,
     )
+    closed_subscription = connection.signal_subscribe(
+        busname,
+        _SESSION_INTERFACE,
+        "Closed",
+        session_handle,
+        None,
+        Gio.DBusSignalFlags.NONE,
+        on_closed,
+        None,
+    )
     logger.debug(
         "waiting up to %s for %s.%s on %s for session %s",
         "forever" if timeout is None else f"{timeout:g}s",
@@ -1095,7 +1320,7 @@ def _wait_for_signal(
         session_handle,
     )
     try:
-        if not result:
+        if not result and not session_closed and not malformed:
             timeout_source = None
             if timeout is not None:
                 timeout_source = GLib.timeout_add(int(timeout * 1000), on_timeout)
@@ -1111,10 +1336,41 @@ def _wait_for_signal(
                 # every real timeout this session hit, never against
                 # test_portal.py's fake GLib.source_remove, which just
                 # clears pending_timeout with no complaint either way.
-                if timeout_source is not None and not timed_out:
+                # Keyed on `timeout_fired` (did on_timeout run), not
+                # `timed_out` (did the wait time out): a signal landing in
+                # the same poll as the deadline runs on_timeout down its
+                # `_settled` early return, which removes the source yet
+                # leaves `timed_out` False.
+                if timeout_source is not None and not timeout_fired:
                     GLib.source_remove(timeout_source)
     finally:
         connection.signal_unsubscribe(subscription)
+        connection.signal_unsubscribe(closed_subscription)
+    return _signal_outcome(
+        signal, timeout, result, malformed, timed_out, session_closed
+    )
+
+
+def _signal_outcome(
+    signal: str,
+    timeout: float | None,
+    result: dict[str, Any],
+    malformed: dict[str, Any],
+    timed_out: bool,
+    session_closed: bool,
+) -> tuple[Any, ...]:
+    """Raise for the terminal outcome `_wait_for_signal` recorded, or return it.
+
+    Order is load-bearing and matches the callbacks' `_settled` guard:
+    whichever outcome was recorded first is the only one set, so this order
+    only ever decides between genuinely simultaneous dispatches, where a
+    session that has closed or a payload that was malformed is the more
+    useful answer than "timed out".
+    """
+    if session_closed:
+        raise PortalSessionClosedError(signal)
+    if malformed:
+        raise PortalProtocolError(signal, malformed["args"])
     if timed_out:
         # timed_out is only ever set inside on_timeout, itself only ever
         # registered when timeout is not None -- so this always holds, but
@@ -1441,12 +1697,7 @@ class InputCaptureSession:
             self.session_handle,
             timeout,
         )
-        cursor = options.get("cursor_position")
-        return Activation(
-            activation_id=int(options.get("activation_id", 0)),
-            cursor_position=tuple(cursor) if cursor is not None else None,
-            barrier_id=options.get("barrier_id"),
-        )
+        return _activation_from_options(options, "Activated")
 
     def wait_for_deactivation(self, timeout: float | None = None) -> int:
         """Block until the current capture ends, returning its activation_id."""
@@ -1464,7 +1715,7 @@ class InputCaptureSession:
             self.session_handle,
             timeout,
         )
-        return int(options.get("activation_id", 0))
+        return _deactivation_id(options, "Deactivated")
 
     def close(self) -> None:
         """End the portal session, and close the EIS fd if unclaimed.

{python_libei-0.6.1 → python_libei-0.8.0/src/python_libei.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-libei
-Version: 0.6.1
+Version: 0.8.0
 Summary: Inject, receive and capture input on Wayland from Python: ctypes bindings for libei, libeis and liboeffis, plus the RemoteDesktop and InputCapture portals
 Author: Dennis K. Paulsen
 License-Expression: MIT
@@ -40,6 +40,7 @@ Dynamic: license-file
 
 # python-libei
 
+[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/ctrondlp/python-libei/blob/main/CONTRIBUTING.md)
 [![CI](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ctrondlp/python-libei/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/python-libei)](https://pypi.org/project/python-libei/)
 [![License](https://img.shields.io/pypi/l/python-libei)](https://github.com/ctrondlp/python-libei/blob/main/LICENSE)
@@ -174,7 +175,7 @@ and why, is in
 
 ## Status
 
-Beta (`0.6.1`), published on [PyPI](https://pypi.org/project/python-libei/)
+Beta (`0.8.0`), published on [PyPI](https://pypi.org/project/python-libei/)
 since `0.1.0`, and **the API is not frozen** — expect renames before 1.0.
 
 The injection path is exercised end to end against the real libraries by the

{python_libei-0.6.1 → python_libei-0.8.0}/tests/test_abi.py

@@ -97,7 +97,15 @@ def _declared(prefix: str) -> dict[str, tuple[tuple[type, ...], type | None]]:
 
 
 def _installed_version(soname: str) -> tuple[int, ...] | None:
-    """The version in the loaded library's file name (``libei.so.1.6.0``)."""
+    """The version in the loaded library's file name (``libei.so.1.6.0``).
+
+    A micro of 900 or more is upstream's prerelease numbering for the *next*
+    minor -- Debian 13 ships 1.3.901, a snapshot on the way to 1.4 that
+    already exports the 1.4 symbols -- so it is normalized to that next
+    minor. Read literally, 1.3.901 "predates" every 1.4 marker while
+    carrying everything they mark, which failed the absent-function pin
+    below on a library whose only sin was being packaged mid-cycle.
+    """
     try:
         maps = Path("/proc/self/maps").read_text()
     except OSError:
@@ -106,7 +114,10 @@ def _installed_version(soname: str) -> tuple[int, ...] | None:
     for line in maps.splitlines():
         found = re.search(rf"/{re.escape(stem)}\.so\.(\d+\.\d+\.\d+)$", line)
         if found:
-            return _version(found.group(1))
+            major, minor, micro = _version(found.group(1))
+            if micro >= 900:
+                return (major, minor + 1, 0)
+            return (major, minor, micro)
     return None
 
 

{python_libei-0.6.1 → python_libei-0.8.0}/tests/test_inputcapture.py

@@ -32,6 +32,7 @@ import pytest
 from libei import portal
 from test_portal import (
     FakeGLibError,
+    FakeMainLoop,
     FakeReply,
     FakeUnixFDList,
     FakeVariant,
@@ -83,6 +84,9 @@ class FakeInputCaptureConnection:
         pending_activated: dict[str, Any] | None = None,
         pending_deactivated: dict[str, Any] | None = None,
         signal_session_handle: str | None = None,
+        pending_closed: bool = False,
+        pending_activated_raw: tuple[Any, ...] | None = None,
+        pending_deactivated_raw: tuple[Any, ...] | None = None,
     ) -> None:
         self.session_handle = session_handle
         self.signal_session_handle = signal_session_handle or session_handle
@@ -105,6 +109,13 @@ class FakeInputCaptureConnection:
         self._pending_reply: tuple[str, int, dict[str, Any]] | None = None
         self._pending_activated = pending_activated
         self._pending_deactivated = pending_deactivated
+        self._pending_closed = pending_closed
+        # Delivered VERBATIM as the signal's whole parameter tuple, unlike
+        # pending_activated, which is an options dict the fake wraps in the
+        # correct (session_handle, options) shape -- this is how a test
+        # hands the waiter a payload a spec-conforming portal cannot send.
+        self._pending_activated_raw = pending_activated_raw
+        self._pending_deactivated_raw = pending_deactivated_raw
         # A permanent log, unlike _subscriptions: signal_unsubscribe removes
         # an entry from that (correctly -- see its own docstring), so a test
         # checking *what was subscribed to* after the fact needs a record
@@ -176,14 +187,31 @@ class FakeInputCaptureConnection:
                 self._pending_reply = None
                 _path, code, results = pending
                 callback(None, None, path, None, "Response", FakeReply((code, results)))
+        elif signal == "Activated" and self._pending_activated_raw is not None:
+            raw = self._pending_activated_raw
+            self._pending_activated_raw = None
+            callback(None, None, portal._OBJECT_PATH, None, "Activated", FakeReply(raw))
         elif signal == "Activated" and self._pending_activated is not None:
             payload = self._pending_activated
             self._pending_activated = None
             self._emit_session_signal(callback, "Activated", payload)
+        elif signal == "Deactivated" and self._pending_deactivated_raw is not None:
+            raw = self._pending_deactivated_raw
+            self._pending_deactivated_raw = None
+            callback(
+                None, None, portal._OBJECT_PATH, None, "Deactivated", FakeReply(raw)
+            )
         elif signal == "Deactivated" and self._pending_deactivated is not None:
             payload = self._pending_deactivated
             self._pending_deactivated = None
             self._emit_session_signal(callback, "Deactivated", payload)
+        elif signal == "Closed" and self._pending_closed:
+            # Closed fires on the session object's own path, not the
+            # portal's -- the opposite of Activated/Deactivated above -- so
+            # it is only delivered to a subscription made there.
+            if path == self.session_handle:
+                self._pending_closed = False
+                callback(None, None, path, None, "Closed", FakeReply(({},)))
         return self._next_subscription_id
 
     def _emit_session_signal(
@@ -557,6 +585,166 @@ def test_wait_for_activation_tolerates_a_missing_barrier_id() -> None:
     assert activation.barrier_id is None
 
 
+def test_a_malformed_activated_payload_raises_a_typed_error() -> None:
+    # An empty payload cannot even be matched to a session, so it is broken
+    # for every possible waiter. Before the shape checks this was an
+    # IndexError *inside* the GLib callback -- which PyGI prints and
+    # swallows, so the wait hung (timeout=None) or timed out, both
+    # indistinguishable from a compositor that never fired.
+    connection = FakeInputCaptureConnection(pending_activated_raw=())
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_activation(timeout=1.0)
+    # `.step` is the attribute every sibling portal error raised from the
+    # same call site carries, so a caller that catches PortalError and reads
+    # `.step` works for this one too (PortalTimeoutError/SessionClosedError).
+    assert excinfo.value.step == "Activated"
+    assert excinfo.value.payload == ()
+    # A shape fault, so no value-level detail.
+    assert excinfo.value.detail is None
+
+
+def test_a_malformed_deactivated_payload_raises_a_typed_error() -> None:
+    # Same shape check, the other signal: wait_for_deactivation goes through
+    # the identical _wait_for_signal, and nothing else exercises its
+    # malformed branch (the timeout/closed paths test both signals, so this
+    # one should too).
+    connection = FakeInputCaptureConnection(pending_deactivated_raw=("/session/1",))
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_deactivation(timeout=1.0)
+    assert excinfo.value.step == "Deactivated"
+    assert excinfo.value.payload == ("/session/1",)
+
+
+def test_a_non_integer_activation_id_raises_a_typed_error() -> None:
+    # Shape-valid payload (a dict), but activation_id is not the `u` the
+    # spec promises -- this passes _wait_for_signal's shape check and used
+    # to crash the caller with ValueError on int(). It is now the same
+    # typed error as a shape violation, and carries a value-level detail so
+    # its message does not misdiagnose a correct shape.
+    connection = FakeInputCaptureConnection(
+        pending_activated={"activation_id": "not-a-number"}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_activation(timeout=1.0)
+    assert excinfo.value.step == "Activated"
+    assert excinfo.value.detail is not None
+    assert "shape" not in str(excinfo.value)
+
+
+def test_a_non_iterable_cursor_position_raises_a_typed_error() -> None:
+    # cursor_position is `(dd)`; a scalar here would crash the caller with
+    # TypeError unpacking it. Guarded into PortalProtocolError too.
+    connection = FakeInputCaptureConnection(
+        pending_activated={"activation_id": 1, "cursor_position": 5}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError):
+            session.wait_for_activation(timeout=1.0)
+
+
+def test_a_wrong_arity_cursor_position_raises_a_typed_error() -> None:
+    # (dd) is exactly two: tuple("ab") would not raise, so the old guard let
+    # a wrong-arity or stringly-typed cursor through as a bad Activation.
+    # The explicit two-element unpack rejects it.
+    for bad in ("ab", (1.0,), (1.0, 2.0, 3.0)):
+        connection = FakeInputCaptureConnection(
+            pending_activated={"activation_id": 1, "cursor_position": bad}
+        )
+        with install_fake_gi(connection):
+            session = portal.InputCaptureSession.negotiate(connection=connection)
+            with pytest.raises(portal.PortalProtocolError):
+                session.wait_for_activation(timeout=1.0)
+
+
+def test_a_non_numeric_cursor_component_raises_a_typed_error() -> None:
+    connection = FakeInputCaptureConnection(
+        pending_activated={"activation_id": 1, "cursor_position": ("x", "y")}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError):
+            session.wait_for_activation(timeout=1.0)
+
+
+def test_a_non_integer_barrier_id_raises_a_typed_error() -> None:
+    # barrier_id is a `u` the caller compares against the ids it armed; a
+    # string here used to pass straight through into a type-violating
+    # Activation that mismatched silently or crashed on arithmetic later.
+    connection = FakeInputCaptureConnection(
+        pending_activated={"activation_id": 1, "barrier_id": "b-3"}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError):
+            session.wait_for_activation(timeout=1.0)
+
+
+def test_an_infinite_activation_id_raises_a_typed_error() -> None:
+    # int(float('inf')) raises OverflowError, which the old (ValueError,
+    # TypeError) guard missed -- it would have escaped a caller's
+    # `except PortalError`.
+    connection = FakeInputCaptureConnection(
+        pending_activated={"activation_id": float("inf")}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError):
+            session.wait_for_activation(timeout=1.0)
+
+
+def test_a_non_integer_deactivation_id_raises_a_typed_error() -> None:
+    connection = FakeInputCaptureConnection(
+        pending_deactivated={"activation_id": "not-a-number"}
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_deactivation(timeout=1.0)
+    assert excinfo.value.step == "Deactivated"
+
+
+def test_an_options_payload_that_is_not_a_dict_raises_a_typed_error() -> None:
+    # The right session's signal, but options is not the a{sv} the spec
+    # promises -- before the shape checks this surfaced wherever the caller
+    # happened to poke the payload (an AttributeError on .get here).
+    connection = FakeInputCaptureConnection(pending_activated_raw=("/session/1", 42))
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_activation(timeout=1.0)
+    assert "Activated" in str(excinfo.value)
+    assert excinfo.value.payload == ("/session/1", 42)
+
+
+def test_a_non_string_session_handle_raises_a_typed_error() -> None:
+    connection = FakeInputCaptureConnection(pending_activated_raw=(7, {}))
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError):
+            session.wait_for_activation(timeout=1.0)
+
+
+def test_a_payload_with_an_extra_trailing_field_raises_a_typed_error() -> None:
+    # The right session and a valid options dict, but a third field the
+    # spec's (o, a{sv}) shape has no room for -- pins the `len(args) != 2`
+    # clause on its own, which the not-a-dict case above does not reach.
+    connection = FakeInputCaptureConnection(
+        pending_activated_raw=("/session/1", {}, "extra")
+    )
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalProtocolError) as excinfo:
+            session.wait_for_activation(timeout=1.0)
+    assert excinfo.value.payload == ("/session/1", {}, "extra")
+
+
 def test_wait_for_activation_times_out_with_no_signal() -> None:
     connection = FakeInputCaptureConnection()
     with install_fake_gi(connection):
@@ -589,6 +777,44 @@ def test_wait_for_activation_does_not_double_remove_the_timeout_source_on_timeou
     source_remove.assert_not_called()
 
 
+def test_a_signal_and_the_deadline_in_one_poll_do_not_double_remove_the_source() -> (
+    None
+):
+    # The harder half of the same bug: GLib dispatches every source ready in
+    # one iteration, so a real Activated can land in the *same poll* as the
+    # timeout deadline. on_signal records the activation and quits; on_timeout
+    # still runs, sees the wait already settled, and returns False -- which
+    # GLib treats as "remove this source". The finally block must not remove
+    # it a second time. Keyed on `timed_out` (which this early return leaves
+    # False) rather than on "did on_timeout fire", it did -- tripping the
+    # "Source ID N was not found" critical that is fatal under
+    # G_DEBUG=fatal-criticals. The fake delivers the signal in the same run()
+    # as the timeout via inject_before_timeout to model the race.
+    connection = FakeInputCaptureConnection()  # nothing fires on subscribe
+
+    def deliver_activation() -> None:
+        key = (portal._INPUT_CAPTURE, "Activated", portal._OBJECT_PATH)
+        connection._subscriptions[key](
+            None,
+            None,
+            portal._OBJECT_PATH,
+            None,
+            "Activated",
+            FakeReply((connection.session_handle, {"activation_id": 7})),
+        )
+
+    with install_fake_gi(connection):
+        glib = sys.modules["gi.repository.GLib"]
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        FakeMainLoop.inject_before_timeout = deliver_activation
+        with mock.patch.object(glib, "source_remove") as source_remove:
+            activation = session.wait_for_activation(timeout=5.0)
+    # The delivered signal wins -- not a timeout -- and the source the firing
+    # on_timeout already removed is not removed again.
+    assert activation.activation_id == 7
+    source_remove.assert_not_called()
+
+
 def test_wait_for_activation_subscribes_on_the_portal_not_the_session() -> None:
     # The bug that made this whole feature look like a compositor gap: the
     # portal emits Activated on its own object, never on the session's, so
@@ -770,3 +996,91 @@ def test_a_failed_session_close_does_not_propagate() -> None:
     with install_fake_gi(connection):
         session = portal.InputCaptureSession.negotiate(connection=connection)
         session.close()  # must not raise
+
+
+# -- the session Closed signal ------------------------------------------------
+
+
+def test_a_closed_session_ends_wait_for_activation_rather_than_hanging() -> None:
+    # The compositor-disconnect case: Session.Closed fires when the portal
+    # or compositor ends the session from its side. Before the Closed
+    # subscription existed, a wait with timeout=None on such a session
+    # blocked forever -- indistinguishable from a barrier nobody had
+    # crossed yet.
+    connection = FakeInputCaptureConnection(pending_closed=True)
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalSessionClosedError) as excinfo:
+            session.wait_for_activation(timeout=None)
+    assert excinfo.value.step == "Activated"
+
+
+def test_a_closed_session_ends_wait_for_deactivation_too() -> None:
+    connection = FakeInputCaptureConnection(pending_closed=True)
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalSessionClosedError) as excinfo:
+            session.wait_for_deactivation(timeout=None)
+    assert excinfo.value.step == "Deactivated"
+
+
+def test_closed_is_subscribed_on_the_session_path_not_the_portal() -> None:
+    # The mirror image of the Activated-path bug: Closed is the one signal
+    # that really does fire on the session object's own path, so the
+    # subscription has to go there.
+    connection = FakeInputCaptureConnection()
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalTimeoutError):
+            session.wait_for_activation(timeout=0.01)
+    subscribed = {
+        key[2] for key in connection.signal_subscriptions if key[1] == "Closed"
+    }
+    assert subscribed == {connection.session_handle}
+
+
+def test_every_wait_subscription_is_unsubscribed_again() -> None:
+    # Both the signal's own subscription and the Closed one: a leak here
+    # means a long-running capture loop accumulates one dead subscription
+    # per activation cycle.
+    connection = FakeInputCaptureConnection(pending_activated={"activation_id": 1})
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        session.wait_for_activation(timeout=1.0)
+    live = [k for k in connection._subscriptions if k[1] in ("Activated", "Closed")]
+    assert live == []
+
+
+def test_a_session_closed_mid_wait_still_cleans_up_its_subscriptions() -> None:
+    connection = FakeInputCaptureConnection(pending_closed=True)
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        with pytest.raises(portal.PortalSessionClosedError):
+            session.wait_for_activation(timeout=None)
+    live = [k for k in connection._subscriptions if k[1] in ("Activated", "Closed")]
+    assert live == []
+
+
+def test_repeated_activation_cycles_each_get_their_own_signal() -> None:
+    # A capture loop waits, releases, waits again -- each wait is its own
+    # subscription, delivered its own payload, with nothing carried over.
+    connection = FakeInputCaptureConnection(pending_activated={"activation_id": 1})
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        first = session.wait_for_activation(timeout=1.0)
+        connection._pending_activated = {"activation_id": 2}
+        second = session.wait_for_activation(timeout=1.0)
+    assert (first.activation_id, second.activation_id) == (1, 2)
+
+
+def test_an_activation_payload_without_an_id_defaults_to_zero() -> None:
+    # The spec says activation_id is always sent; a portal that omits it
+    # anyway gets the same 0 a compositor that "could not determine" sends,
+    # rather than a KeyError mid-wait.
+    connection = FakeInputCaptureConnection(pending_activated={})
+    with install_fake_gi(connection):
+        session = portal.InputCaptureSession.negotiate(connection=connection)
+        activation = session.wait_for_activation(timeout=1.0)
+    assert activation == portal.Activation(
+        activation_id=0, cursor_position=None, barrier_id=None
+    )

{python_libei-0.6.1 → python_libei-0.8.0}/tests/test_portal.py

@@ -112,6 +112,11 @@ class FakeMainLoop:
     # What GLib.timeout_add was asked to wait, so a test can check the
     # Response leg got only the time the call leg left of the deadline.
     pending_timeout_msec: int | None = None
+    # A callable a test can set to model real GLib dispatching several
+    # sources ready in one iteration: it runs just before the stashed
+    # timeout callback, so a signal it delivers and the timeout both fire in
+    # the same `run()`. Left None, `run()` behaves exactly as before.
+    inject_before_timeout: Any = None
 
     def __init__(self) -> None:
         self._quit = False
@@ -122,6 +127,10 @@ class FakeMainLoop:
         callback = FakeMainLoop.pending_timeout
         if callback is not None:
             FakeMainLoop.pending_timeout = None
+            inject = FakeMainLoop.inject_before_timeout
+            if inject is not None:
+                FakeMainLoop.inject_before_timeout = None
+                inject()
             callback()
             return
         raise AssertionError("run() called before a synchronous quit()")
@@ -296,6 +305,8 @@ def install_fake_gi(connection: Any = None) -> Any:
 
     # timeout_add stashes the callback rather than scheduling it; only the
     # timeout tests, which never quit() the loop, actually let it fire.
+    FakeMainLoop.inject_before_timeout = None
+
     def timeout_add(ms: int, callback: Any) -> int:
         FakeMainLoop.pending_timeout = callback
         FakeMainLoop.pending_timeout_msec = ms