python-libei 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

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.5.0"
+__version__ = "0.5.1"
 
 __all__ = ["__version__"]

libei/portal.py

@@ -926,6 +926,53 @@ def _input_capture_version(
     return int(version)
 
 
+def _create_input_capture_session_v1(
+    connection: Any,
+    Gio: Any,
+    GLib: Any,
+    busname: str,
+    types: int,
+    timeout: float,
+) -> str:
+    """Create an InputCapture session on a portal that predates v2.
+
+    v1 has no ``Start`` at all -- that method, like ``CreateSession2``, was
+    added in version 2. Here ``CreateSession`` itself carries
+    ``capabilities`` and raises the consent dialog, and the session is ready
+    for ``GetZones`` / ``SetPointerBarriers`` / ``Enable`` the moment its
+    ``Response`` arrives. ``ConnectToEIS`` is a v1 original, so the rest of
+    this class works against such a portal unchanged.
+
+    Returns the session handle. ``persist_mode`` and ``restore_token`` have
+    no v1 equivalent -- both are documented as version 2 additions to
+    ``Start``, which does not exist here -- so the caller must reject them
+    before getting this far rather than have them silently ignored.
+    """
+    code, results = _request(
+        connection,
+        Gio,
+        GLib,
+        busname,
+        _INPUT_CAPTURE,
+        "CreateSession",
+        "(sa{sv})",
+        ("",),
+        {
+            "session_handle_token": GLib.Variant("s", uuid.uuid4().hex),
+            "capabilities": GLib.Variant("u", int(types)),
+        },
+        timeout,
+    )
+    if code != 0:
+        raise PortalDeniedError(
+            "CreateSession", "the user declined the input-capture consent dialog"
+        )
+    session_handle = results.get("session_handle")
+    if not isinstance(session_handle, str):
+        raise PortalError("CreateSession returned no session_handle")
+    return session_handle
+
+
 def _wait_for_signal(
     connection: Any,
     Gio: Any,
@@ -1392,11 +1439,18 @@ class InputCaptureSession:
         Blocks until ``CreateSession2`` -> ``Start`` -> ``ConnectToEIS``
         resolves, prompting the user for consent along the way unless
         ``restore_token`` lets the portal skip that. Raises
-        :class:`PortalVersionError` if the compositor's InputCapture portal
-        predates ``CreateSession2`` (needs v2+ -- this module never speaks
-        the deprecated v1 ``CreateSession``), :class:`PortalDeniedError` if
-        ``Start`` is declined, and :class:`PortalTimeoutError` if any one
-        round trip exceeds ``timeout`` seconds.
+        :class:`PortalDeniedError` if consent is declined, and
+        :class:`PortalTimeoutError` if any one round trip exceeds ``timeout``
+        seconds.
+
+        A portal older than v2 has neither ``CreateSession2`` nor ``Start``,
+        and is negotiated through the deprecated v1 ``CreateSession``
+        instead -- one call that carries ``capabilities`` and raises the
+        consent dialog itself. Everything after negotiation is identical;
+        ``ConnectToEIS`` is a v1 original. The one thing v1 cannot do is
+        persist: ``persist_mode`` and ``restore_token`` were added to
+        ``Start``, so passing either against such a portal raises
+        :class:`PortalVersionError` rather than being quietly ignored.
 
         Returns before anything is actually captured: :meth:`set_pointer_barriers`
         and :meth:`enable` still have to be called, and even then nothing
@@ -1435,62 +1489,95 @@ class InputCaptureSession:
                 raise PortalError(f"cannot reach the session bus: {exc}") from exc
 
         version = _input_capture_version(connection, Gio, GLib, busname, timeout)
-        if version < _MIN_INPUT_CAPTURE_VERSION:
+        # A version below 2 is not a portal to give up on -- it is a portal
+        # that speaks the older half of the same interface. Only
+        # `CreateSession2` and `Start` are version 2 additions; `GetZones`,
+        # `SetPointerBarriers`, `Enable`, `Disable`, `Release` and, crucially,
+        # `ConnectToEIS` are all v1 originals, so everything this class does
+        # after negotiation works either way and only session creation forks.
+        #
+        # This is not hypothetical. xdg-desktop-portal-gnome 50 reports
+        # version 0 -- it registers the full impl interface and never sets the
+        # property -- and calling `CreateSession2` against it fails with
+        # `UnknownMethod`, while v1 `CreateSession` is dispatched normally.
+        # Note that its introspection XML advertises `CreateSession2` anyway:
+        # that XML is static, so it says nothing about what the frontend will
+        # actually dispatch. The `version` property is the only usable signal,
+        # which is why it is read first and believed.
+        legacy = version < _MIN_INPUT_CAPTURE_VERSION
+
+        if legacy and (persist_mode != PersistMode.NONE or restore_token is not None):
             raise PortalVersionError(
-                f"InputCapture version {version} is too old for "
-                f"CreateSession2 (need {_MIN_INPUT_CAPTURE_VERSION}+)"
+                f"InputCapture version {version} has no Start method, and "
+                f"persist_mode/restore_token are version "
+                f"{_MIN_INPUT_CAPTURE_VERSION} additions to it -- this portal "
+                f"cannot persist a session. Retry with persist_mode=NONE and "
+                f"no restore_token to negotiate a one-shot session."
             )
 
         if capabilities == DeviceType.ALL_DEVICES:
             types = _ALL_DEVICE_TYPES
         else:
             types = capabilities
-        reply = _call_sync(
-            connection,
-            Gio,
-            GLib,
-            busname,
-            _OBJECT_PATH,
-            _INPUT_CAPTURE,
-            "CreateSession2",
-            GLib.Variant(
-                "(a{sv})",
-                ({"session_handle_token": GLib.Variant("s", uuid.uuid4().hex)},),
-            ),
-            None,
-            int(timeout * 1000),
-        )
-        (results,) = reply.unpack()
-        session_handle = results.get("session_handle")
-        if not isinstance(session_handle, str):
-            raise PortalError("CreateSession2 returned no session_handle")
 
-        # Past this point a session exists inside xdg-desktop-portal, and
-        # nothing else can close it -- see RemoteDesktopSession.negotiate's
-        # identical reasoning, which this mirrors line for line.
-        try:
-            options: dict[str, Any] = {"capabilities": GLib.Variant("u", int(types))}
-            if persist_mode != PersistMode.NONE:
-                options["persist_mode"] = GLib.Variant("u", int(persist_mode))
-            if restore_token is not None:
-                options["restore_token"] = GLib.Variant("s", restore_token)
-            code, start_results = _request(
+        if legacy:
+            session_handle = _create_input_capture_session_v1(
+                connection, Gio, GLib, busname, int(types), timeout
+            )
+        else:
+            reply = _call_sync(
                 connection,
                 Gio,
                 GLib,
                 busname,
+                _OBJECT_PATH,
                 _INPUT_CAPTURE,
-                "Start",
-                "(osa{sv})",
-                (session_handle, ""),
-                options,
-                timeout,
+                "CreateSession2",
+                GLib.Variant(
+                    "(a{sv})",
+                    ({"session_handle_token": GLib.Variant("s", uuid.uuid4().hex)},),
+                ),
+                None,
+                int(timeout * 1000),
             )
-            if code != 0:
-                raise PortalDeniedError(
-                    "Start", "the user declined the input-capture consent dialog"
+            (results,) = reply.unpack()
+            session_handle = results.get("session_handle")
+            if not isinstance(session_handle, str):
+                raise PortalError("CreateSession2 returned no session_handle")
+
+        # Past this point a session exists inside xdg-desktop-portal, and
+        # nothing else can close it -- see RemoteDesktopSession.negotiate's
+        # identical reasoning, which this mirrors line for line.
+        try:
+            # v1 asked for consent and capabilities in CreateSession itself,
+            # and has no Start to call; it can therefore never issue a
+            # restore token either.
+            new_restore_token = None
+            if not legacy:
+                options: dict[str, Any] = {
+                    "capabilities": GLib.Variant("u", int(types))
+                }
+                if persist_mode != PersistMode.NONE:
+                    options["persist_mode"] = GLib.Variant("u", int(persist_mode))
+                if restore_token is not None:
+                    options["restore_token"] = GLib.Variant("s", restore_token)
+                code, start_results = _request(
+                    connection,
+                    Gio,
+                    GLib,
+                    busname,
+                    _INPUT_CAPTURE,
+                    "Start",
+                    "(osa{sv})",
+                    (session_handle, ""),
+                    options,
+                    timeout,
                 )
-            new_restore_token = start_results.get("restore_token")
+                if code != 0:
+                    raise PortalDeniedError(
+                        "Start", "the user declined the input-capture consent dialog"
+                    )
+                new_restore_token = start_results.get("restore_token")
 
             eis_fd = _call_for_fd(
                 connection,

{python_libei-0.5.0.dist-info → python_libei-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-libei
-Version: 0.5.0
+Version: 0.5.1
 Summary: Inject and receive input on Wayland from Python: ctypes bindings for libei, libeis and liboeffis
 Author: Dennis K. Paulsen
 License-Expression: MIT
@@ -156,7 +156,7 @@ and why, is in
 
 ## Status
 
-Beta (`0.5.0`), published on [PyPI](https://pypi.org/project/python-libei/)
+Beta (`0.5.1`), 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.5.0.dist-info → python_libei-0.5.1.dist-info}/RECORD

@@ -1,17 +1,17 @@
-libei/__init__.py,sha256=ovsIL7-rEp8LMbiWdmlGSoU6r4lNS_stMLULlkFgwGg,1858
+libei/__init__.py,sha256=ZknUZWRNN4JfCH08NGpbBhqr_e2YZjHnk8B1aXe2J9Y,1858
 libei/_cobject.py,sha256=msrbviABSWjc5fKsXHSCg7nQ0Y4Etcq_Dkh0fblW-sY,12845
 libei/ei.py,sha256=Da3ezXnFPXtejlcJFH8bcE5f4pxKZXXqb6ltCh2zAdE,46704
 libei/eis.py,sha256=aYWOCN1NlRchcWd6NjIUi1eYMFWJbp0UHMcQFEJ0ii4,43642
 libei/oeffis.py,sha256=UcnDwLErFxB0xuktNpIzAK01ylpl6ZrmaGnWiUOcFOo,9302
-libei/portal.py,sha256=-OAg_g0Q6s0BNN2B6bzfyD2T5N_dCuHbSpqtcL8dCUk,60488
+libei/portal.py,sha256=LGRINrYQ-x46i0pzGOzpM6ZT3xek_AoExNIgR2BZRB8,64498
 libei/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 libei/_capi/__init__.py,sha256=3VxixYYlr_ZcuiK0GwrCpbE3VvEv_O990mJzdIJ8i74,209
 libei/_capi/libei.py,sha256=gpp42bhqPonhVD2zmFWCl4rdk_lm4XvD_7W2Rw5RsuI,11308
 libei/_capi/libeis.py,sha256=jQR0Z0YN9qa71mAcSJ__-UaoF8PsVsBs8OXwjfqstFk,13080
 libei/_capi/liboeffis.py,sha256=V8jdmJm3qOQUzzNiCAXt4Jr2JY11Y4-w6NIfIxbxGI4,1218
 libei/_capi/loader.py,sha256=k7fb_Nz0fg5QkuLJ_duKXj8bESSktLQ2ZyS5LNQ5v2I,4689
-python_libei-0.5.0.dist-info/licenses/LICENSE,sha256=l6xbMU6Y-JZDzmBciBj-J5t6h6jNg_Bcyp4bHxDepqU,1074
-python_libei-0.5.0.dist-info/METADATA,sha256=YDry3cY8Id0Z9bwQh_27SZkR8U8Ntf-S2t7Elf2nojo,20475
-python_libei-0.5.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_libei-0.5.0.dist-info/top_level.txt,sha256=_DQXzGjDsUBENI_cNkiOxPB4xi8coCbQS1lq18FMudQ,6
-python_libei-0.5.0.dist-info/RECORD,,
+python_libei-0.5.1.dist-info/licenses/LICENSE,sha256=l6xbMU6Y-JZDzmBciBj-J5t6h6jNg_Bcyp4bHxDepqU,1074
+python_libei-0.5.1.dist-info/METADATA,sha256=Bg1meYzLmMAp9HqeMWbU4SzZZOurlSGzIR49ZmoJNgo,20475
+python_libei-0.5.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_libei-0.5.1.dist-info/top_level.txt,sha256=_DQXzGjDsUBENI_cNkiOxPB4xi8coCbQS1lq18FMudQ,6
+python_libei-0.5.1.dist-info/RECORD,,