aioxlib 0.0.3__tar.gz → 0.0.5__tar.gz

{aioxlib-0.0.3 → aioxlib-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioxlib
-Version: 0.0.3
+Version: 0.0.5
 Summary: Human friendly interface to XLib subsystems using asyncio python
 Author-email: Jose Tiago Macara Coutinho <coutinhotiago@gmail.com>
 License-Expression: GPL-3.0-or-later
@@ -58,6 +58,7 @@ pip install aioxlib
 import asyncio
 import aioxlib
 
+
 async def main():
     display = await aioxlib.get_display()
     async with display:
@@ -72,11 +73,14 @@ async def main():
         await wnd.set_wm_protocols([delete])
 
         async for event in display.events():
-            if (event["code"] == aioxlib.Event.ClientMessage
-                    and event["type"] == protocols
-                    and event["data"][0] == delete):
+            if (
+                event["code"] == aioxlib.Event.ClientMessage
+                and event["type"] == protocols
+                and event["data"][0] == delete
+            ):
                 break
 
+
 asyncio.run(main())
 ```
 

{aioxlib-0.0.3 → aioxlib-0.0.5}/README.md

@@ -34,6 +34,7 @@ pip install aioxlib
 import asyncio
 import aioxlib
 
+
 async def main():
     display = await aioxlib.get_display()
     async with display:
@@ -48,11 +49,14 @@ async def main():
         await wnd.set_wm_protocols([delete])
 
         async for event in display.events():
-            if (event["code"] == aioxlib.Event.ClientMessage
-                    and event["type"] == protocols
-                    and event["data"][0] == delete):
+            if (
+                event["code"] == aioxlib.Event.ClientMessage
+                and event["type"] == protocols
+                and event["data"][0] == delete
+            ):
                 break
 
+
 asyncio.run(main())
 ```
 

{aioxlib-0.0.3 → aioxlib-0.0.5}/aioxlib/__init__.py

@@ -4,7 +4,7 @@
 # Copyright (c) 2026 Tiago Coutinho
 # Distributed under the GPLv3 license. See LICENSE for more info.
 
-__version__ = "0.0.3"
+__version__ = "0.0.5"
 
 import asyncio
 import enum
@@ -27,9 +27,7 @@ PROTOCOL_MINOR = 0
 
 TYPE = b"MIT-MAGIC-COOKIE-1"
 SUPPORTED_PROTOCOLS = "unix", "tcp"
-DISPLAY_RE = re.compile(
-    r"^((?P<protocol>tcp|unix)/)?(?P<host>[-a-zA-Z0-9._]*):(?P<port>\d+)(\.(?P<screen>\d+))?$"
-)
+DISPLAY_RE = re.compile(r"^((?P<protocol>tcp|unix)/)?(?P<host>[-a-zA-Z0-9._]*):(?P<port>\d+)(\.(?P<screen>\d+))?$")
 
 BASE_TCP_PORT = 6000
 UNIX_PATH_TEMPLATE = "/tmp/.X11-unix/X{}"
@@ -541,10 +539,12 @@ YSorted = 1
 YXSorted = 2
 YXBanded = 3
 
+
 class CoordinateMode(enum.IntEnum):
     Origin = 0
     Previous = 1
 
+
 Complex = 0
 Nonconvex = 1
 Convex = 2
@@ -698,7 +698,7 @@ FONT_FIELDS = (
 def parse_font_name(name):
     parts = name.split("-")[1:15]
     result = {"name": name}
-    for key, value in zip(FONT_FIELDS, parts):
+    for key, value in zip(FONT_FIELDS, parts, strict=True):
         if value == "":
             result[key] = None
         else:
@@ -977,7 +977,7 @@ def pack_list_properties(wid) -> bytes:
 
 def unpack_list_properties(data, offset=0):
     offset += 8
-    nb_atoms, = struct.unpack_from("H", data, offset)
+    (nb_atoms,) = struct.unpack_from("H", data, offset)
     offset += 2 + 22
     return struct.unpack_from(f"{nb_atoms}I", data, offset), offset + nb_atoms * 4
 
@@ -989,7 +989,7 @@ def pack_get_font_path():
 def unpack_get_font_path(data, offset=0):
     result, offset = unpack_reply_head(data, offset)
     assert result["reply"] == 1
-    n, = struct.unpack_from("H", data, offset)
+    (n,) = struct.unpack_from("H", data, offset)
     offset += 2 + 22
     result["path"], offset = unpack_list_strings(data, n, offset)
     return result, offset + 32 + result["length"] * 4
@@ -1000,9 +1000,7 @@ def pack_intern_atom(name, only_if_exists=False):
     n = len(name)
     p = pad(n)
     length = 2 + (n + p) // 4
-    return struct.pack(
-        f"BBHH2x{n+p}s", Command.InternAtom, int(only_if_exists), length, n, name
-    )
+    return struct.pack(f"BBHH2x{n + p}s", Command.InternAtom, int(only_if_exists), length, n, name)
 
 
 def pack_poly_fill_rectangles(drawable, gc, rectangles) -> bytes:
@@ -1052,7 +1050,7 @@ def pack_open_font(fid, name, encoding=DEFAULT_STRING_ENCODING):
     length = 3 + (n + p) // 4
 
     return struct.pack(
-        f"BxHIHxx{n+p}s",
+        f"BxHIHxx{n + p}s",
         Command.OpenFont,  # OpenFont
         length,
         fid,
@@ -1147,9 +1145,7 @@ def pack_create_gc(cid, drawable, **kwargs):
         fmts.append(fmt)
         vals.append(val)
     length = 4 + len(kwargs)
-    return struct.pack(
-        "".join(fmts), Command.CreateGC, length, cid, drawable, mask, *vals
-    )
+    return struct.pack("".join(fmts), Command.CreateGC, length, cid, drawable, mask, *vals)
 
 
 def pack_free_gc(gc):
@@ -1224,7 +1220,7 @@ def pack_query_extension(name) -> bytes:
     n = len(name)
     p = pad(n)
     length = 2 + (n + p) // 4
-    return struct.pack(f"BxHH2x{n+p}s", Command.QueryExtension, length, n, name)
+    return struct.pack(f"BxHH2x{n + p}s", Command.QueryExtension, length, n, name)
 
 
 def unpack_query_extension(data: bytes, offset: int = 0):
@@ -1241,7 +1237,7 @@ def pack_list_fonts(pattern, nmax=2**16):
     pattern = pattern.encode(DEFAULT_STRING_ENCODING)
     n = len(pattern)
     p = pad(n)
-    fmt = f"BxBHH{n+p}s"
+    fmt = f"BxBHH{n + p}s"
     length = 2 + (n + p) // 4
     return struct.pack(fmt, Command.ListFonts, length, nmax, n, pattern)
 
@@ -1261,7 +1257,7 @@ def pack_image_text(wnd, gc, x, y, text):
     n = len(text)
     p = pad(n)
     length = 4 + (n + p) // 4
-    fmt = f"BBHIIhh{n+p}s"
+    fmt = f"BBHIIhh{n + p}s"
     return struct.pack(fmt, Command.ImageText8, n, length, wnd, gc, x, y, text)
 
 
@@ -1270,9 +1266,7 @@ def pack_image(format, drawable, gc, w, h, x, y, left_pad, depth, data):
     n = len(data)
     p = pad(n)
     length = 6 + (n + p) // 4
-    head = struct.pack(
-        fmt, 72, format, length, drawable, gc, w, h, x, y, left_pad, depth
-    )
+    head = struct.pack(fmt, 72, format, length, drawable, gc, w, h, x, y, left_pad, depth)
     return head, data, p * b"\x00"
 
 
@@ -1312,9 +1306,7 @@ def get_auth_config(filename: str) -> list[dict]:
         offset += 2
         data = raw[offset : offset + datalen]
         offset += datalen
-        entries.append(
-            {"family": family, "address": addr, "port": num, "name": name, "data": data}
-        )
+        entries.append({"family": family, "address": addr, "port": num, "name": name, "data": data})
     return entries
 
 
@@ -1468,9 +1460,7 @@ class Window(Drawable):
     async def set_name(self, name):
         await self.change_text_property(Atom.WM_NAME, name)
 
-    async def change_text_property(
-        self, property, data, property_type=Atom.STRING, mode=PropMode.Replace
-    ):
+    async def change_text_property(self, property, data, property_type=Atom.STRING, mode=PropMode.Replace):
         if not isinstance(data, bytes):
             if property_type == Atom.STRING:
                 data = data.encode(DEFAULT_STRING_ENCODING)
@@ -1490,12 +1480,8 @@ class Window(Drawable):
     async def destroy(self):
         return await self.display.destroy_window(self.id)
 
-    async def change_property(
-        self, property, property_type, format, data, mode=PropMode.Replace
-    ):
-        payload = pack_change_property(
-            self.id, property, property_type, format, data, mode
-        )
+    async def change_property(self, property, property_type, format, data, mode=PropMode.Replace):
+        payload = pack_change_property(self.id, property, property_type, format, data, mode)
         self.display.connection.write(payload)
 
     async def set_wm_protocols(self, protocols):
@@ -1509,7 +1495,7 @@ class Window(Drawable):
         return await self.display.list_properties(self)
 
     async def clear_area(self, x, y, w, h, exposure=False):
-        await self.display.clear_area(self , x, y, w, h, exposure)
+        await self.display.clear_area(self, x, y, w, h, exposure)
 
     async def clear(self, exposure=0):
         await self.clear_area(0, 0, 0, 0, exposure)
@@ -1539,19 +1525,6 @@ class GC(Resource):
         self.display.connection.write(payload)
 
 
-class LogBytes:
-    __slots__ = ["data"]
-    Limit = 32
-
-    def __init__(self, data):
-        self.data = data
-
-    def __str__(self):
-        if len(self.data) > self.Limit:
-            return " ".join(f"{b:02X}" for b in self.data[: self.Limit]) + " [...]"
-        return " ".join(f"{b:02X}" for b in self.data)
-
-
 class Connection:
     def __init__(self, reader, writer, config):
         self.reader = reader
@@ -1586,13 +1559,6 @@ class Connection:
         self.writer.write(payload)
 
     def writelines(self, lines):
-        l0 = lines[0]
-        code = l0[0]
-        if code in {LITTLE_ENDIAN, BIG_ENDIAN}:
-            cmd_name = "Setup"
-        else:
-            cmd_name = Command(code).name
-        log.debug("WRITEL(%3d): %s %s", len(lines), cmd_name, LogBytes(l0))
         self.writer.writelines(lines)
 
     async def flush(self):
@@ -1646,11 +1612,7 @@ class Xauthority:
             ename, eport = entry["name"], entry["port"]
             if not eport and entry["name"] not in matches:
                 eport = bport
-            if (
-                entry["family"] == family
-                and entry["address"] == address
-                and eport == bport
-            ):
+            if entry["family"] == family and entry["address"] == address and eport == bport:
                 matches[ename] = entry
         for type_ in types:
             try:
@@ -1708,9 +1670,7 @@ def pack_shm_attach(opcode, rid, shmid, read_only=True):
 def pack_shm_attach_fd(opcode, fd, read_only=True):
     fmt = "BBHIB3x"
     length = struct.calcsize(fmt) // 4
-    return struct.pack(
-        fmt, opcode, SharedMemoryOperation.AttachFd, length, fd, 1 if read_only else 0
-    )
+    return struct.pack(fmt, opcode, SharedMemoryOperation.AttachFd, length, fd, 1 if read_only else 0)
 
 
 def pack_shm_version(opcode):
@@ -1858,7 +1818,213 @@ class SharedMemory(Extension):
         self.display.write(payload)
 
 
-EXTENSIONS = {"MIT-SHM": SharedMemory}
+class DoubleBufferOperation(enum.IntEnum):
+    GetVersion = 0
+    AllocateBackBufferName = 1
+    DeallocateBackBufferName = 2
+    SwapBuffers = 3
+    BeginIdiom = 4
+    EndIdiom = 5
+    GetVisualInfo = 6
+    GetBackBufferAttributes = 7
+
+
+class SwapAction(enum.IntEnum):
+    """What to do with the new back buffer after a swap."""
+
+    Undefined = 0
+    Background = 1
+    Untouched = 2
+    Copied = 3
+
+
+def pack_dbe_get_version(opcode, client_major=1, client_minor=0):
+    return struct.pack(
+        "BBHBBH",
+        opcode,
+        DoubleBufferOperation.GetVersion,
+        2,
+        client_major,
+        client_minor,
+        0,
+    )
+
+
+def unpack_dbe_get_version(data, offset=0):
+    result, offset = unpack_reply_head(data, offset)
+    major, minor = struct.unpack_from("=BB", data, offset)
+    offset += 2 + 22
+    result["major_version"] = major
+    result["minor_version"] = minor
+    return result, offset
+
+
+def pack_dbe_allocate_back_buffer(opcode, window, buffer, swap_action=SwapAction.Undefined):
+    return struct.pack(
+        "BBHIIB3x",
+        opcode,
+        DoubleBufferOperation.AllocateBackBufferName,
+        4,
+        int(window),
+        int(buffer),
+        int(swap_action),
+    )
+
+
+def pack_dbe_deallocate_back_buffer(opcode, buffer):
+    return struct.pack(
+        "BBHI",
+        opcode,
+        DoubleBufferOperation.DeallocateBackBufferName,
+        2,
+        int(buffer),
+    )
+
+
+def pack_dbe_swap_buffers(opcode, actions):
+    """actions: sequence of (window, swap_action) pairs."""
+    n = len(actions)
+    length = 2 + 2 * n
+    parts = [struct.pack("=BBHI", opcode, DoubleBufferOperation.SwapBuffers, length, n)]
+    for window, action in actions:
+        parts.append(struct.pack("=IB3x", int(window), int(action)))
+    return b"".join(parts)
+
+
+def pack_dbe_begin_idiom(opcode):
+    return struct.pack("=BBH", opcode, DoubleBufferOperation.BeginIdiom, 1)
+
+
+def pack_dbe_end_idiom(opcode):
+    return struct.pack("=BBH", opcode, DoubleBufferOperation.EndIdiom, 1)
+
+
+def pack_dbe_get_visual_info(opcode, drawables):
+    """drawables: sequence of drawable ids (empty = all screens)."""
+    n = len(drawables)
+    length = 2 + n
+    header = struct.pack("=BBHI", opcode, DoubleBufferOperation.GetVisualInfo, length, n)
+    body = b"".join(struct.pack("=I", int(d)) for d in drawables)
+    return header + body
+
+
+def unpack_dbe_get_visual_info(data, offset=0):
+    result, offset = unpack_reply_head(data, offset)
+    (n_screens,) = struct.unpack_from("=I", data, offset)
+    offset += 4 + 20
+    screens = []
+    for _ in range(n_screens):
+        (n_infos,) = struct.unpack_from("=I", data, offset)
+        offset += 4
+        infos = []
+        for _ in range(n_infos):
+            visual, depth, perflevel = struct.unpack_from("=IBB2x", data, offset)
+            offset += 8
+            infos.append({"visual": visual, "depth": depth, "perflevel": perflevel})
+        screens.append(infos)
+    result["screens"] = screens
+    return result, offset
+
+
+def pack_dbe_get_back_buffer_attributes(opcode, buffer):
+    return struct.pack(
+        "BBHI",
+        opcode,
+        DoubleBufferOperation.GetBackBufferAttributes,
+        2,
+        int(buffer),
+    )
+
+
+def unpack_dbe_get_back_buffer_attributes(data, offset=0):
+    result, offset = unpack_reply_head(data, offset)
+    (window,) = struct.unpack_from("=I", data, offset)
+    offset += 4 + 20
+    result["window"] = window
+    return result, offset
+
+
+class BackBuffer(Drawable):
+    def __init__(self, bid, window, extension):
+        super().__init__(extension.display, bid)
+        self.window = window
+        self.extension = extension
+
+    async def swap(self, swap_action=SwapAction.Undefined):
+        return await self.extension.swap(self.window, swap_action)
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *_):
+        await self.extension.deallocate_back_buffer(self.id)
+
+
+class DoubleBuffer(Extension):
+    """X Double Buffer Extension (DOUBLE-BUFFER / DBE).
+
+    Provides front/back buffers for flicker-free animation. Query with::
+
+        dbe = await display.query_extension("DOUBLE-BUFFER")
+    """
+
+    BaseBadBuffer = 0
+
+    def __init__(self, display, info):
+        super().__init__(display, info)
+        self.BadBuffer = info["base_error"] + self.BaseBadBuffer
+        self.errors = {self.BadBuffer: "BadBuffer"}
+        self.commands = {self.code: "Dbe"}
+
+    async def version(self, client_major=1, client_minor=0):
+        payload = pack_dbe_get_version(self.code, client_major, client_minor)
+        return await self.display.write_read(payload, unpack_dbe_get_version)
+
+    async def allocate_back_buffer(self, window, swap_action=SwapAction.Undefined, buffer=None):
+        """Allocate a back-buffer XID for *window*.
+
+        Returns the back-buffer resource id (drawable usable with core
+        drawing requests).
+        """
+        if buffer is None:
+            buffer = self.display.resources.allocate()
+        payload = pack_dbe_allocate_back_buffer(self.code, window, buffer, swap_action)
+        self.display.write(payload)
+        return BackBuffer(buffer, window, self)
+
+    async def deallocate_back_buffer(self, buffer):
+        payload = pack_dbe_deallocate_back_buffer(self.code, buffer)
+        self.display.write(payload)
+
+    async def swap_buffers(self, actions):
+        """Swap front/back buffers.
+
+        *actions* is a sequence of ``(window, swap_action)`` pairs.
+        """
+        payload = pack_dbe_swap_buffers(self.code, actions)
+        self.display.write(payload)
+
+    async def swap(self, window, swap_action=SwapAction.Undefined):
+        """Convenience: swap a single window."""
+        await self.swap_buffers([(window, swap_action)])
+
+    async def begin_idiom(self):
+        self.display.write(pack_dbe_begin_idiom(self.code))
+
+    async def end_idiom(self):
+        self.display.write(pack_dbe_end_idiom(self.code))
+
+    async def get_visual_info(self, drawables=()):
+        """Return per-screen lists of visuals that support double buffering."""
+        payload = pack_dbe_get_visual_info(self.code, drawables)
+        return await self.display.write_read(payload, unpack_dbe_get_visual_info)
+
+    async def get_back_buffer_attributes(self, buffer):
+        payload = pack_dbe_get_back_buffer_attributes(self.code, buffer)
+        return await self.display.write_read(payload, unpack_dbe_get_back_buffer_attributes)
+
+
+EXTENSIONS = {"MIT-SHM": SharedMemory, "DOUBLE-BUFFER": DoubleBuffer}
 
 
 class Pipeline:
@@ -1956,9 +2122,7 @@ class Display:
         await self.flush()
         info = await read_setup(self)
         self.info = info
-        self.resources = ResourceManager(
-            info["resource_id_base"], info["resource_id_mask"]
-        )
+        self.resources = ResourceManager(info["resource_id_base"], info["resource_id_mask"])
         self.screens = [Screen(self, sinfo) for sinfo in info["screens"]]
         self._task = asyncio.create_task(self._loop())
         return info
@@ -2011,9 +2175,7 @@ class Display:
             return self._atom_cache[name]
 
         atom = await self.intern_atom(name, only_if_exists)
-        if (
-            atom != NONE
-        ):  # don't cache NONE responses in case someone creates this later
+        if atom != NONE:  # don't cache NONE responses in case someone creates this later
             self._atom_cache[name] = atom
         return atom
 

{aioxlib-0.0.3 → aioxlib-0.0.5}/aioxlib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioxlib
-Version: 0.0.3
+Version: 0.0.5
 Summary: Human friendly interface to XLib subsystems using asyncio python
 Author-email: Jose Tiago Macara Coutinho <coutinhotiago@gmail.com>
 License-Expression: GPL-3.0-or-later
@@ -58,6 +58,7 @@ pip install aioxlib
 import asyncio
 import aioxlib
 
+
 async def main():
     display = await aioxlib.get_display()
     async with display:
@@ -72,11 +73,14 @@ async def main():
         await wnd.set_wm_protocols([delete])
 
         async for event in display.events():
-            if (event["code"] == aioxlib.Event.ClientMessage
-                    and event["type"] == protocols
-                    and event["data"][0] == delete):
+            if (
+                event["code"] == aioxlib.Event.ClientMessage
+                and event["type"] == protocols
+                and event["data"][0] == delete
+            ):
                 break
 
+
 asyncio.run(main())
 ```
 

{aioxlib-0.0.3 → aioxlib-0.0.5}/aioxlib.egg-info/SOURCES.txt

@@ -4,4 +4,5 @@ aioxlib/__init__.py
 aioxlib.egg-info/PKG-INFO
 aioxlib.egg-info/SOURCES.txt
 aioxlib.egg-info/dependency_links.txt
-aioxlib.egg-info/top_level.txt
+aioxlib.egg-info/top_level.txt
+tests/test_aioxlib.py

{aioxlib-0.0.3 → aioxlib-0.0.5}/pyproject.toml

@@ -49,9 +49,16 @@ docs = [
     "pymdown-extensions",
     "mkdocs-coverage",
 ]
+test = [
+    "pytest>=7",
+    "pytest-cov>=4",
+    "coverage>=7",
+    "pytest-asyncio>=1.4",
+]
 dev = [
     {include-group = "build-deploy"},
     {include-group = "docs"},
+    {include-group = "test"},
 ]
 
 [project.scripts]
@@ -89,3 +96,14 @@ target-version = "py312"
 
 [tool.ruff.lint.isort]
 combine-as-imports = true
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+testpaths = ["tests"]
+addopts = [
+    "-ra",
+    "--strict-markers",
+    "--cov=aioxlib",
+    "--cov-report=term-missing",
+    "--cov-report=html"
+]