leaf-framework 0.9.4__tar.gz → 0.9.6__tar.gz

{leaf_framework-0.9.4 → leaf_framework-0.9.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: leaf-framework
-Version: 0.9.4
+Version: 0.9.6
 Summary: Lightweight Adapter Framework (LEAF)
 License: Apache-2.0
 License-File: LICENSE

{leaf_framework-0.9.4 → leaf_framework-0.9.6}/leaf/ui/desktop_launcher.py

@@ -12,6 +12,28 @@ from leaf.utility.logger.logger_utils import get_logger
 
 logger = get_logger(__name__, log_file="desktop_launcher.log")
 
+# Works around a libXcursor/Xlib bug that aborts the whole process on Linux,
+# the first time a tk.Button is created: ButtonCreate -> TkButtonWorldChanged
+# -> Tk_GetBitmap -> ... -> libXcursor's XcursorSupportsARGB ->
+# XRenderQueryExtension -> XQueryExtension -> Xlib's _XSend, which hits
+# `assert(!xcb_xlib_unknown_seq_number)` and aborts. Root-caused via a core
+# dump (gdb, `thread apply all bt`) on a genuine Debian/Xorg reproduction --
+# NOT a threading race (every other thread was idle, blocked on condition
+# variables); the single main thread aborts inside libXcursor's lazy
+# ARGB-cursor/display-info detection, which corrupts Xlib's XCB
+# sequence-number tracking. XLIB_SKIP_ARGB_VISUALS=1 is libXcursor's own
+# documented escape hatch for exactly this, and was confirmed to fix it:
+# without it, LEAF aborted within ~1s of "Starting desktop control panel..."
+# on every run; with it, the full GUI lifecycle (button creation, 40s+
+# runtime, clean shutdown) ran with no crash, in the same environment.
+#
+# Must be set here, before tkinter is ever imported below -- libXcursor
+# reads this once via a load-time constructor and caches it, so setting it
+# via os.environ any later (even right before the first tk.Tk()) is too
+# late and has no effect. Confirmed by direct reproduction.
+if sys.platform.startswith("linux"):
+    os.environ.setdefault("XLIB_SKIP_ARGB_VISUALS", "1")
+
 # Check if tkinter is available
 try:
     import tkinter as tk
@@ -23,6 +45,28 @@ except ImportError:
     logger.warning("tkinter not available - desktop GUI will not be available")
 
 
+def _init_x11_threads() -> None:
+    """Tell Xlib this process is multi-threaded, before it ever touches X11.
+
+    LEAF runs several other threads by the time this GUI starts (the
+    NiceGUI web server thread, adapter/simulation threads -- see start.py).
+    None of them were shown to touch Tk/X11 in the libXcursor crash
+    reproduction above (see the XLIB_SKIP_ARGB_VISUALS comment near the top
+    of this file for that actual root cause), but Xlib documents
+    XInitThreads() as required before its first use in any multi-threaded
+    process regardless of which thread issues X calls, so there's no reason
+    to skip it. No equivalent exists on macOS (Cocoa) or Windows.
+    """
+    if not sys.platform.startswith("linux"):
+        return
+    try:
+        import ctypes
+
+        ctypes.CDLL("libX11.so.6").XInitThreads()
+    except Exception as e:
+        logger.debug(f"Could not call XInitThreads: {e}")
+
+
 def is_desktop_environment() -> bool:
     """
     Detect if we're running in a desktop environment.
@@ -82,6 +126,7 @@ class LeafDesktopLauncher:
         self.is_running = True
 
         # Create main window
+        _init_x11_threads()
         self.root = tk.Tk()
         self.root.title("LEAF - Lightweight Equipment Adapter Framework")
         self.root.geometry("500x350")
@@ -281,6 +326,7 @@ class LeafDesktopLauncher:
 
         # Call the stop callback in a separate thread
         if self.on_stop_callback:
+            stop_finished = threading.Event()
 
             def stop_thread():
                 try:
@@ -288,13 +334,24 @@ class LeafDesktopLauncher:
                 except Exception as e:
                     logger.error(f"Error in stop callback: {e}")
                 finally:
-                    # Close the window after stopping
-                    try:
-                        self.root.after(1000, self.root.destroy)
-                    except Exception:
-                        pass
+                    stop_finished.set()
 
             threading.Thread(target=stop_thread, daemon=True).start()
+
+            # Tk/Tcl calls (root.after, root.destroy) must only ever happen
+            # on the main thread that's running mainloop() -- on Linux,
+            # Xlib can abort the whole process ("XInitThreads has not been
+            # called") if a background thread issues X11 calls concurrently
+            # with it. Polling here (itself scheduled via root.after, so it
+            # always runs on the main thread) instead of destroying directly
+            # from stop_thread keeps every Tk call on that one thread.
+            def wait_and_destroy():
+                if stop_finished.is_set():
+                    self.root.destroy()
+                else:
+                    self.root.after(100, wait_and_destroy)
+
+            self.root.after(1000, wait_and_destroy)
         else:
             # If no callback, just close
             self.root.after(500, self.root.destroy)

{leaf_framework-0.9.4 → leaf_framework-0.9.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "leaf-framework"
-version = "0.9.4"
+version = "0.9.6"
 description = "Lightweight Adapter Framework (LEAF)"
 authors = [
     "Matthew Crowther <nmc215@ncl.ac.uk>",