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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-libei
-Version: 0.6.1
+Version: 0.7.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.7.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.7.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.7.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.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-libei"
-version = "0.6.1"
+version = "0.7.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.7.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.7.0"
 
 __all__ = ["__version__"]

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

@@ -185,6 +185,28 @@ class PortalDeniedError(PortalError):
         self.message = message
 
 
+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.
 
@@ -1038,6 +1060,27 @@ def _wait_for_signal(
     loop = GLib.MainLoop()
     result: dict[str, Any] = {}
     timed_out = False
+    session_closed = False
+
+    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 result:
+            return
+        logger.debug("session %s closed while waiting for %s", session_handle, signal)
+        session_closed = True
+        loop.quit()
 
     def on_signal(
         _conn: Any,
@@ -1086,6 +1129,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 +1148,7 @@ def _wait_for_signal(
         session_handle,
     )
     try:
-        if not result:
+        if not result and not session_closed:
             timeout_source = None
             if timeout is not None:
                 timeout_source = GLib.timeout_add(int(timeout * 1000), on_timeout)
@@ -1115,6 +1168,9 @@ def _wait_for_signal(
                     GLib.source_remove(timeout_source)
     finally:
         connection.signal_unsubscribe(subscription)
+        connection.signal_unsubscribe(closed_subscription)
+    if session_closed:
+        raise PortalSessionClosedError(signal)
     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

{python_libei-0.6.1 → python_libei-0.7.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.7.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.7.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.7.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.7.0}/tests/test_inputcapture.py

@@ -83,6 +83,7 @@ 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,
     ) -> None:
         self.session_handle = session_handle
         self.signal_session_handle = signal_session_handle or session_handle
@@ -105,6 +106,7 @@ 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
         # 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
@@ -184,6 +186,13 @@ class FakeInputCaptureConnection:
             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(
@@ -770,3 +779,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
+    )