pyobs-gui 2.0.0.dev22__tar.gz → 2.1.0__tar.gz

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyobs-gui
-Version: 2.0.0.dev22
+Version: 2.1.0
 Summary: A remote GUI for pyobs
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT
@@ -11,7 +11,7 @@ Requires-Dist: astropy<8,>=7.0.1
 Requires-Dist: colour<0.2,>=0.1.5
 Requires-Dist: keyring<26,>=25.7.0
 Requires-Dist: matplotlib<4,>=3.10.1
-Requires-Dist: pyobs-core<3,>=2.0.0.dev93
+Requires-Dist: pyobs-core<3,>=2.2.0
 Requires-Dist: pyside6>=6.10.1
 Requires-Dist: qasync<0.29,>=0.27.1
 Requires-Dist: qfitswidget>=0.13.1

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/docs/source/index.rst

@@ -18,6 +18,11 @@ This is an example configuration for a GUI that defines one custom widget for th
         widget:
           class: mypackage.GuidingWidget
 
+    sidebar:
+      - module: guiding
+        widget:
+          class: mypackage.GuidingExtraSidebarWidget
+
     comm:
       jid: test@example.com
       password: ***
@@ -54,9 +59,39 @@ GUI
 Widgets
 *******
 
-The GUI shows one page per connected module, picking a widget by the module's interfaces
-(``DEFAULT_WIDGETS`` in ``mainwindow.py``), plus three always-present "Tools" pages. No screenshots
-yet — this section was written from source, not from a running GUI; add screenshots as a follow-up.
+The GUI shows one page per connected module, matching its interfaces against an ordered registry
+of **main widgets** (``MAIN_WIDGETS`` in ``mainwindow.py``) — see below for the current list — plus
+three always-present "Tools" pages. No screenshots yet — this section was written from source, not
+from a running GUI; add screenshots as a follow-up.
+
+Main widgets vs. sidebar widgets
+=================================
+Every entry in the registry drives either a **main widget** (fills the page) or is declared as a
+**sidebar widget** for one or more main widgets (lives only in the page's sidebar, e.g. filter
+wheel, focuser, temperature, cooling and FITS-header controls). A module matching several main
+widgets gets one nav entry whose page is a tab widget, one tab per main widget (e.g. a camera
+module that is also a filter wheel shows a "Camera" tab, with filter controls in the shared
+sidebar rather than a separate tab); one match keeps a plain, tab-bar-less page; the sidebar itself
+is shared across every tab, so e.g. FITS-header info stays visible while switching tabs. Some
+interfaces (``IFilters``, ``IFocuser``, ``ITemperatures``, ``ICooling``) are *sidebar-preferred*:
+they fill a sidebar slot on another matched main widget by default, but still get their own page if
+a module implements one of them standalone (e.g. a bare filter-wheel-only module).
+
+Custom ``widgets:``/``sidebar:`` config
+==========================================
+Each ``widgets:`` entry (``module``, ``widget``, optional ``label``, ``icon``, ``interface``,
+``overwrite``) targets one connected module:
+
+- ``interface: ICamera`` replaces/merges only the ``ICamera``-derived tab for that module (same
+  registry slot, so tab order is stable); ignored with a log message if the module doesn't
+  implement it.
+- No ``interface`` and no ``overwrite`` — the entry is appended as an **extra tab** alongside
+  whatever the registry already matched.
+- No ``interface`` and ``overwrite: true`` — the page becomes **exactly** the custom entries (the
+  ``guiding`` example above).
+
+``sidebar:`` entries (``module``, ``widget``) are always appended to the page's sidebar, visible
+regardless of the module's matched interfaces.
 
 Shell
 =====
@@ -118,6 +153,16 @@ Filter wheel — drives ``IFilters``
 =====================================
 Set the active filter.
 
+Temperatures — drives ``ITemperatures``
+==========================================
+Live sensor readout. Normally a sidebar block on a camera/telescope page; a temperature-sensor-only
+module gets its own page.
+
+Cooling — drives ``ICooling``
+================================
+Set/get the cooling setpoint. Normally a sidebar block on a camera page; a cooling-only module
+gets its own page.
+
 
 Keyboard shortcuts
 *******************

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/pyobs_gui/__init__.py

@@ -6,7 +6,10 @@ __title__ = "GUI"
 
 from ._nuitka_astropy_patch import patch_generic_unit_parser
 
-patch_generic_unit_parser()
+# Only relevant in the Nuitka-compiled standalone binary: under a regular interpreter the
+# patch must not install, or it breaks astropy's unit/coordinate parsing (issue #151). The
+# marker is evaluated here because pyobs_gui/__init__.py is guaranteed compiled in the binary.
+patch_generic_unit_parser(compiled="__compiled__" in globals())
 
 from .gui import GUI
 from .camerawidget import CameraWidget

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/pyobs_gui/_nuitka_astropy_patch.py

@@ -34,6 +34,23 @@ unconditionally at startup. astropy's cds/ogip/vounit formats and astropy.coordi
 the same PLY pattern and would need the identical treatment if/when they're actually exercised in
 the compiled binary.
 
+Two caveats learned the hard way (pyobs-gui issue #151):
+
+- **The patch must be a strict no-op under a regular interpreter.** The wrapper functions below
+  add one stack frame, which shifts astropy's frame-level bookkeeping: ``astropy.utils.parsing``
+  calls ``get_caller_module_dict(2)`` directly, and its own ``_patch_ply_module`` wrapper adds two
+  more levels, so the extra frame makes the walk land on astropy's parsing wrapper instead of the
+  grammar-defining frame -- the fallback fired on plain CPython and corrupted unit/coordinate
+  parsing when running from source ("Invalid coordinates" in the Telescope widget, astropy units
+  failing to import). Therefore the patched functions step one level deeper (``levels + 1``) to
+  restore the original frame targeting, and ``patch_generic_unit_parser`` only installs at all
+  when running under Nuitka (``"__compiled__" in globals()``); otherwise it returns immediately.
+- **The vendored grammar must be a *registered* module.** PLY validates p-functions with
+  ``inspect.getmodule()``/``getsourcefile()``, which resolve the function's ``__module__`` through
+  ``sys.modules`` and want a real source file. ``_build_generic_grammar_namespace`` therefore
+  registers the namespace under its name and materializes its ``__file__`` stub; without that the
+  parser rebuild dies with "Unable to build parser" (``TypeError ... got NoneType``).
+
 Must run before ``astropy.units`` is imported anywhere, i.e. as the first thing in
 ``pyobs_gui/__init__.py``.
 """
@@ -41,6 +58,7 @@ Must run before ``astropy.units`` is imported anywhere, i.e. as the first thing
 from __future__ import annotations
 
 import re
+import sys
 import tempfile
 import types
 from fractions import Fraction
@@ -76,6 +94,18 @@ def _build_generic_grammar_namespace() -> types.ModuleType:
     ns.__file__ = str(stub_dir / "generic.py")
     ns.tokens = tokens
 
+    # Register the namespace under its own name and materialize its __file__ so PLY's
+    # grammar validation can resolve it: ParserReflect.get_pfunctions() calls
+    # inspect.getmodule() on every p_* function (which looks the function's __module__ up
+    # in sys.modules), and validate_pfunctions() calls inspect.getsourcefile() on the
+    # result -- both need a real, registered module or the rebuild dies with
+    # "Unable to build parser" / "TypeError: ... got NoneType".
+    sys.modules.setdefault(ns.__name__, ns)
+    (stub_dir / "generic.py").write_text(
+        "# pyobs-gui: vendored astropy.units.format.generic PLY grammar (Nuitka workaround).\n",
+        encoding="utf-8",
+    )
+
     ns.t_COMMA = r"\,"
     ns.t_PRODUCT = "[*.]"
     ns.t_DIVISION = "/"
@@ -410,12 +440,23 @@ def _namespace_pdict(ns: types.ModuleType) -> dict[str, Any]:
     return {k: getattr(ns, k) for k in dir(ns)}
 
 
-def patch_generic_unit_parser() -> None:
+def patch_generic_unit_parser(*, compiled: bool | None = None) -> None:
     """Patch astropy.extern.ply's frame-walking helpers to fall back to our vendored grammar.
 
-    Safe to call unconditionally (frozen or not) -- under a normal, unfrozen interpreter the
-    original frame walk always succeeds, so the fallback path never triggers.
+    Only intended for the Nuitka-compiled standalone binary. Under a regular interpreter the
+    original frame walk always finds the grammar, and installing the wrapper would *shift* the
+    walk by one stack frame and break astropy's parsing (see module docstring / pyobs-gui issue
+    #151), so unless ``compiled`` is true this is a strict no-op.
+
+    Pass ``compiled`` as ``"__compiled__" in globals()`` evaluated in the entry package
+    (``pyobs_gui/__init__.py``), which is guaranteed to be compiled in the binary. When left as
+    None the marker is checked in this module's own globals instead.
     """
+    if compiled is None:
+        compiled = "__compiled__" in globals()
+    if not compiled:
+        return
+
     from astropy.extern.ply import lex as ply_lex
     from astropy.extern.ply import yacc as ply_yacc
 
@@ -423,6 +464,14 @@ def patch_generic_unit_parser() -> None:
     original_lex_dict = ply_lex.get_caller_module_dict
 
     def _fallback_pdict(pdict: dict[str, Any] | None) -> dict[str, Any]:
+        # Only the *generic unit* format's grammar is vendored here. astropy's other PLY
+        # grammars (angle/cds/ogip/vounit) would need the identical treatment, and feeding
+        # them the generic grammar would silently parse with the wrong productions (that is
+        # exactly how the binary's coordinate parsing broke: the angle parser got the unit
+        # grammar). For any other grammar return the broken-locals pdict unchanged so the
+        # build fails loudly instead of corrupting results.
+        if pdict is not None and pdict.get("__name__") != "astropy.units.format.generic":
+            return dict(pdict)
         # Keep whatever the real (possibly broken-locals) pdict already has -- __file__/
         # __package__/__name__ are module globals and come through fine even on a compiled
         # frame -- and only supplement the missing tokens/p_*/t_* grammar entries. Replacing
@@ -435,7 +484,12 @@ def patch_generic_unit_parser() -> None:
 
     def patched_yacc_dict(levels: int) -> dict[str, Any]:
         try:
-            pdict = original_yacc_dict(levels)
+            # Our wrapper adds one frame compared with the unpatched call chain (the original
+            # walk is now called from here instead of directly from astropy's parsing.yacc /
+            # _patch_ply_module wrapper), so step one level deeper to land on the same frame
+            # the original walk would have inspected. Without this the fallback fires under
+            # plain CPython and astropy's parsing breaks (pyobs-gui issue #151).
+            pdict = original_yacc_dict(levels + 1)
         except Exception:
             return _fallback_pdict(None)
         if "tokens" not in pdict:
@@ -444,7 +498,7 @@ def patch_generic_unit_parser() -> None:
 
     def patched_lex_dict(levels: int) -> dict[str, Any]:
         try:
-            pdict = original_lex_dict(levels)
+            pdict = original_lex_dict(levels + 1)
         except Exception:
             return _fallback_pdict(None)
         if "tokens" not in pdict:

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/pyobs_gui/base.py

@@ -241,8 +241,17 @@ class BaseWidget(BaseWindow, QtWidgets.QWidget):  # type: ignore
             if hasattr(self, "widgetSidebar"):
                 self.widgetSidebar.setLayout(self.sidebar_layout)
 
-        # open it
-        await self._open_child(widget)
+        # open it -- a failing sidebar widget is logged and dropped rather than left to propagate:
+        # otherwise one flaky sidebar widget (e.g. a filter wheel briefly unreachable) would kill
+        # the whole page it's attached to, including every already-open main widget/tab
+        try:
+            await self._open_child(widget)
+        except asyncio.CancelledError:
+            raise
+        except Exception:
+            log.exception("Failed to open sidebar widget %s; dropping it.", type(widget).__name__)
+            await widget.discard()
+            return
 
         # append widget
         self.sidebar_widgets.append(widget)
@@ -251,7 +260,7 @@ class BaseWidget(BaseWindow, QtWidgets.QWidget):  # type: ignore
     async def register_event(self, event_class: type[Event], handler: Callable[[Event, str], Any]) -> None:
         """Register an event handler through comm, tracked so discard() can unregister it later.
 
-        Widgets that are created/destroyed per connected client (see DEFAULT_WIDGETS in
+        Widgets that are created/destroyed per connected client (see MAIN_WIDGETS in
         mainwindow.py) must use this instead of calling self.comm.register_event() directly,
         so their handler stops firing once the widget is discarded.
         """

{pyobs_gui-2.0.0.dev22 → pyobs_gui-2.1.0}/pyobs_gui/camerawidget.py

@@ -17,9 +17,6 @@ from pyobs.interfaces import (
     IBinning,
     BinningState,
     IWindow,
-    IFilters,
-    ICooling,
-    ITemperatures,
     IGain,
     GainState,
     IExposure,
@@ -30,9 +27,6 @@ from pyobs.interfaces import (
 from pyobs.utils.enums import ImageType, ImageFormat, ExposureStatus
 from pyobs.vfs import VirtualFileSystem
 from .base import BaseWidget
-from .coolingwidget import CoolingWidget
-from .filterwidget import FilterWidget
-from .temperatureswidget import TemperaturesWidget
 from .fitsheaderswidget import FitsHeadersWidget
 from .qt.camerawidget_ui import Ui_CameraWidget
 
@@ -50,6 +44,15 @@ class CameraWidget(BaseWidget, Ui_CameraWidget):
     signal_update_gui = QtCore.Signal()
     signal_new_image = QtCore.Signal(NewImageEvent, str)
 
+    # declared sidebar fills (mainwindow.py, MAIN_WIDGETS/collect_main_widgets): consulted via
+    # getattr(widget_class, "sidebar_fills", ...) so a site that wires CameraWidget in via
+    # custom widgets: config still gets these. IFilters/ICooling/ITemperatures are NOT listed
+    # here -- they're sidebar_preferred MAIN_WIDGETS entries, already demoted into the sidebar by
+    # the promotion rule; declaring them here too would add each one twice (PR #157 review).
+    sidebar_fills = [
+        (None, FitsHeadersWidget),
+    ]
+
     def __init__(self, **kwargs: Any):
         BaseWidget.__init__(self, **kwargs)
         self.setupUi(self)  # type: ignore
@@ -106,14 +109,9 @@ class CameraWidget(BaseWidget, Ui_CameraWidget):
         self.butExpose.clicked.connect(self.expose)
         self.butAbort.clicked.connect(self.abort)
 
-        # fill sidebar
-        await self.add_to_sidebar(self.create_widget(FitsHeadersWidget, module=self.module))
-        if await self.comm.has_proxy(self.module, IFilters):
-            await self.add_to_sidebar(self.create_widget(FilterWidget, module=self.module))
-        if await self.comm.has_proxy(self.module, ICooling):
-            await self.add_to_sidebar(self.create_widget(CoolingWidget, module=self.module))
-        if await self.comm.has_proxy(self.module, ITemperatures):
-            await self.add_to_sidebar(self.create_widget(TemperaturesWidget, module=self.module))
+        # sidebar fills are applied by the page assembler (mainwindow.py: open_module_page),
+        # driven by this class's sidebar_fills attribute -- see specs/2026-08-28-gui-main-vs-
+        # sidebar-widgets.md, D2
 
     async def _init(self) -> None:
         # every interface is initialized independently (caps -> state -> subscribe, in that