pyobs-core 2.0.0.dev47__tar.gz → 2.0.0.dev49__tar.gz

{pyobs_core-2.0.0.dev47 → pyobs_core-2.0.0.dev49}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyobs-core
-Version: 2.0.0.dev47
+Version: 2.0.0.dev49
 Summary: robotic telescope software
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT
@@ -20,7 +20,7 @@ Requires-Dist: logging-journald>=0.6.11
 Requires-Dist: numpy<3,>=2.2.5
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: paramiko>=3.5.1
-Requires-Dist: pillow>=11.3.0
+Requires-Dist: pillow>=12.3.0
 Requires-Dist: psutil>=7.2.2
 Requires-Dist: py-expression-eval<0.4,>=0.3.14
 Requires-Dist: pydantic>=2.12.5

{pyobs_core-2.0.0.dev47 → pyobs_core-2.0.0.dev49}/pyobs/application.py

@@ -5,6 +5,7 @@ import os
 import platform
 import signal
 import warnings
+from collections.abc import Awaitable, Callable
 from io import StringIO
 from typing import Any, TypedDict
 
@@ -56,7 +57,9 @@ class Application:
 
     def __init__(
         self,
-        config: str,
+        config: str | None = None,
+        module_factory: Callable[[], Awaitable[Module]] | None = None,
+        loop_module_class: type[Module] | None = None,
         log_file: str | None = None,
         log_level: str = "info",
         syslog: bool = False,
@@ -65,18 +68,36 @@ class Application:
     ):
         """Initializes a pyobs application.
 
+        Exactly one of `config`/`module_factory` must be given.
+
         Args:
             config: Name of config file.
+            module_factory: Async factory that builds the Module once the event loop is already
+                running, instead of parsing a config file synchronously in __init__ -- lets the
+                factory `await` things (e.g. a login dialog's submit signal) before the module
+                (and its comm connection) exists at all. Mutually exclusive with `config`.
+            loop_module_class: Module class to pick `new_event_loop()` from when `module_factory`
+                is given (the caller already knows which module class it's about to build, e.g.
+                `GUI` in pyobs-gui's case). Required when `module_factory` is given, ignored
+                otherwise.
             log_file: Name of log file, if any.
             log_level: Logging level.
             syslog: Send log to systemd journal, tagged with SYSLOG_IDENTIFIER=pyobs
                     and PYOBS_MODULE=<module name>. Requires logging-journald.
             influx_log: Log to influx DB.
         """
+        if (config is None) == (module_factory is None):
+            raise ValueError("Exactly one of 'config' or 'module_factory' must be given.")
+        if module_factory is not None and loop_module_class is None:
+            raise ValueError("loop_module_class is required when module_factory is given.")
 
         # get config name without path and extension
         self._config = config
-        config_base = os.path.splitext(os.path.basename(config))[0]
+        config_base = (
+            os.path.splitext(os.path.basename(config))[0]
+            if config is not None
+            else loop_module_class.__name__.lower()  # type: ignore[union-attr]
+        )
 
         # filter that injects %(pyobs_module)s into every LogRecord from the context var
         module_name_filter = ModuleNameFilter()
@@ -156,72 +177,100 @@ class Application:
 
         log = logging.getLogger(__name__)
 
-        # set (maybe temporary) module name to filename without leading underscores
-        module_name.set(Path(self._config).stem.lstrip("_"))
-
-        # load config
-        log.info("Loading configuration from %s...", self._config)
-        with StringIO(pre_process_yaml(self._config)) as f:
-            cfg: dict[str, Any] = yaml.safe_load(f)
-
-        # get module class
-        class_name = cfg["class"]
-        klass = get_class_from_string(class_name)
-
-        # create event loop — if top-level class doesn't override new_event_loop,
-        # check child modules for one that does (e.g. pyobs_gui.GUI in a MultiModule)
-        loop_class = klass
-        if klass.new_event_loop is Module.new_event_loop:
-            for mod_cfg in cfg.get("modules", {}).values():
-                if isinstance(mod_cfg, dict) and "class" in mod_cfg:
-                    child_klass = get_class_from_string(mod_cfg["class"])
-                    if child_klass.new_event_loop is not Module.new_event_loop:
-                        loop_class = child_klass
-                        break
-        self._loop = loop_class.new_event_loop()
-        asyncio.set_event_loop(self._loop)
-
-        # create module and open it
-        config_stem = Path(self._config).stem.lstrip("_")
-        if "comm" not in cfg and not issubclass(klass, MultiModule):
-            # no comm configured -- module would otherwise fall back to a DummyComm named
-            # with the fixed placeholder "module", indistinguishable from every other
-            # comm-less module in PYOBS_MODULE log tagging (see
-            # specs/steering/finding-module-logs-under-pyobsd.md) and guaranteed to trip the
-            # stem-mismatch check below. Give it the config file's own stem instead.
-            cfg = {**cfg, "comm": {"class": f"{DummyComm.__module__}.{DummyComm.__name__}", "name": config_stem}}
-        log.info("Creating module from class %s...", klass.__name__)
-        self._module = get_object(cfg, Module)
-
-        # a config file whose stem doesn't match its own module's name silently splits
-        # PYOBS_MODULE log tagging in two: logging that falls through both execute()
-        # (module.py) and BackgroundTask (background_task.py) stays on the filename set
-        # above, while logging covered by either of those uses the module's real
-        # Comm-derived name -- refuse to start rather than let that drift run undetected.
-        # MultiModule is exempt: its own .name is always the fixed placeholder "multi"
-        # (module.py), never meant to match a filename -- each child module is already
-        # correctly distinguished via execute()/BackgroundTask.
-        if not isinstance(self._module, MultiModule):
-            if self._module.name != config_stem:
-                log.warning(
-                    "Config file stem (%s) does not match module's own name "
-                    "(%s). Rename the config file or fix the module's "
-                    "comm configuration so they match.",
-                    config_stem,
-                    self._module.name,
-                )
+        # set (maybe temporary) module name -- filename without leading underscores for the
+        # config path, or a placeholder derived from loop_module_class for the factory path
+        # (there's no real name yet until the factory resolves the actual module/comm identity)
+        module_name.set(Path(self._config).stem.lstrip("_") if self._config is not None else config_base)
+
+        self._module: Module | None = None
+        self._module_factory = module_factory
+
+        if config is not None:
+            # load config
+            log.info("Loading configuration from %s...", config)
+            with StringIO(pre_process_yaml(config)) as f:
+                cfg: dict[str, Any] = yaml.safe_load(f)
+
+            # get module class
+            class_name = cfg["class"]
+            klass = get_class_from_string(class_name)
+
+            # create event loop — if top-level class doesn't override new_event_loop,
+            # check child modules for one that does (e.g. pyobs_gui.GUI in a MultiModule)
+            loop_class = klass
+            if klass.new_event_loop is Module.new_event_loop:
+                for mod_cfg in cfg.get("modules", {}).values():
+                    if isinstance(mod_cfg, dict) and "class" in mod_cfg:
+                        child_klass = get_class_from_string(mod_cfg["class"])
+                        if child_klass.new_event_loop is not Module.new_event_loop:
+                            loop_class = child_klass
+                            break
+            self._loop = loop_class.new_event_loop()
+            asyncio.set_event_loop(self._loop)
+
+            # create module and open it
+            config_stem = Path(config).stem.lstrip("_")
+            if "comm" not in cfg and not issubclass(klass, MultiModule):
+                # no comm configured -- module would otherwise fall back to a DummyComm named
+                # with the fixed placeholder "module", indistinguishable from every other
+                # comm-less module in PYOBS_MODULE log tagging (see
+                # specs/steering/finding-module-logs-under-pyobsd.md) and guaranteed to trip the
+                # stem-mismatch check below. Give it the config file's own stem instead.
+                cfg = {**cfg, "comm": {"class": f"{DummyComm.__module__}.{DummyComm.__name__}", "name": config_stem}}
+            log.info("Creating module from class %s...", klass.__name__)
+            self._module = get_object(cfg, Module)
+
+            # a config file whose stem doesn't match its own module's name silently splits
+            # PYOBS_MODULE log tagging in two: logging that falls through both execute()
+            # (module.py) and BackgroundTask (background_task.py) stays on the filename set
+            # above, while logging covered by either of those uses the module's real
+            # Comm-derived name -- refuse to start rather than let that drift run undetected.
+            # MultiModule is exempt: its own .name is always the fixed placeholder "multi"
+            # (module.py), never meant to match a filename -- each child module is already
+            # correctly distinguished via execute()/BackgroundTask.
+            if not isinstance(self._module, MultiModule):
+                if self._module.name != config_stem:
+                    log.warning(
+                        "Config file stem (%s) does not match module's own name "
+                        "(%s). Rename the config file or fix the module's "
+                        "comm configuration so they match.",
+                        config_stem,
+                        self._module.name,
+                    )
+        else:
+            # module_factory path: pick the event loop from the class the caller already knows
+            # it's about to build -- the module itself gets built later, inside the running
+            # loop (see _main()), since only there can the factory await anything.
+            assert loop_module_class is not None  # validated above
+            self._loop = loop_module_class.new_event_loop()
+            asyncio.set_event_loop(self._loop)
 
     def run(self) -> None:
         """Run app."""
 
+        # run main task forever -- created before the signal handlers are registered below, so
+        # a signal arriving the instant it's registered can never find self._main_task unset
+        self._main_task = self._loop.create_task(self._main())
+
         # signals
         for sig in (signal.SIGTERM, signal.SIGINT):
             self._loop.add_signal_handler(sig, self._signal_handler, sig)
 
-        # run main task forever
-        main = self._loop.create_task(self._main())
         self._loop.run_forever()
-        self._loop.run_until_complete(main)
+        try:
+            self._loop.run_until_complete(self._main_task)
+        except asyncio.CancelledError:
+            # _signal_handler() cancelled _main_task directly -- only reachable while
+            # module_factory hadn't resolved yet (e.g. a login dialog still open), since
+            # self._module.quit() is what normally unblocks run_forever()/main otherwise.
+            pass
+        except RuntimeError:
+            # Qt-backed loops (qasync, used by pyobs-gui) can report the underlying Qt event
+            # loop as stopped before _main_task is done -- e.g. when the GUI's native window
+            # close triggers Qt's own quit independently of self._module.quit(). _main_task
+            # keeps running as a plain asyncio task regardless; the cancel/gather below still
+            # drains it, so this is a benign race in loop bookkeeping, not a failed shutdown.
+            log.warning("Event loop reported as stopped before shutdown finished; continuing cleanup.")
 
         # main finished, cancel all tasks
         tasks = asyncio.all_tasks(self._loop)
@@ -229,7 +278,11 @@ class Application:
             log.debug("Task %s still running, cancelling it...", t)
             t.cancel()
         group = asyncio.gather(*tasks, return_exceptions=True)
-        self._loop.run_until_complete(group)
+        try:
+            self._loop.run_until_complete(group)
+        except RuntimeError:
+            # same benign qasync race as above, now on the cancellation gather itself.
+            log.warning("Event loop reported as stopped before task cancellation finished.")
 
         # finished
         log.info("Closing loop...")
@@ -238,7 +291,14 @@ class Application:
     def _signal_handler(self, sig: int) -> None:
         """React to signals and quit the module."""
 
-        self._module.quit()
+        if self._module is not None:
+            self._module.quit()
+        else:
+            # module_factory hasn't resolved yet (e.g. a login dialog still open) -- nothing to
+            # quit, so cancel the pending factory wait directly instead. Module.quit() would
+            # otherwise have called loop.stop() itself (module.py); mirror that here too.
+            self._main_task.cancel()
+            self._loop.stop()
 
         # reset signal handlers
         log.info("Got signal: %s, shutting down.", sig)
@@ -251,6 +311,15 @@ class Application:
 
         # everything in a try/except/finally, so that we can shut down gracefully
         try:
+            # resolve the module from the factory, if we're in that mode and haven't yet --
+            # runs inside the running loop, so the factory can await anything it needs to
+            # (e.g. a login dialog's submit signal) before the module/comm connection exists
+            if self._module is None:
+                assert self._module_factory is not None  # validated in __init__
+                log.info("Waiting for module factory to resolve...")
+                self._module = await self._module_factory()
+                log.info("Module factory resolved.")
+
             # open module
             log.info("Opening module...")
             await self._module.startup()

pyobs_core-2.0.0.dev49/pyobs/comm/xmpp/__init__.py

@@ -0,0 +1,3 @@
+from .xmppcomm import XmppComm, is_valid_jid
+
+__all__ = ["XmppComm", "is_valid_jid"]

{pyobs_core-2.0.0.dev47 → pyobs_core-2.0.0.dev49}/pyobs/comm/xmpp/xmppcomm.py

@@ -48,6 +48,26 @@ def _retry_delay(attempt: int, cap: float = 30.0, base: float = 1.0) -> float:
     return random.uniform(0, min(cap, base * (2**attempt)))
 
 
+# anchored at both ends -- re.match alone doesn't anchor the end, so e.g. "user@domain/res/extra"
+# would otherwise still "match" as a valid prefix
+_JID_RE = re.compile(r"([\w_\-\.]+)@([\w_\-\.]+)/([\w_\-\.]+)$")
+
+
+def is_valid_jid(jid: str, resource: str = "pyobs") -> bool:
+    """Whether jid is a valid user@domain or user@domain/resource JID -- exactly what
+    XmppComm.__init__ requires, so callers taking raw user input (e.g. a login window) can
+    validate it up front instead of finding out via a raised, less specific exception.
+
+    Args:
+        jid: JID to check, with or without a resource part.
+        resource: Resource to assume if jid doesn't already include one -- must match whatever
+            XmppComm itself would be constructed with, since a resource-less jid is only valid
+            if *some* resource ends up attached to it.
+    """
+    candidate = jid if "/" in jid else f"{jid}/{resource}"
+    return bool(_JID_RE.match(candidate))
+
+
 class EventStanza(ElementBase):
     name = "event"
     namespace = "pyobs:event"
@@ -180,10 +200,10 @@ class XmppComm(Comm):
                 jid += "/" + resource
 
             # get user/domain/resource and write it back to config
-            m = re.match(r"([\w_\-\.]+)@([\w_\-\.]+)\/([\w_\-\.]+)", jid)
+            m = _JID_RE.match(jid)
             if not m:
-                log.error("Invalid JID format.")
-                raise ValueError()
+                log.error("Invalid JID format: %r (expected user@domain or user@domain/resource).", jid)
+                raise ValueError(f"Invalid JID format: {jid!r} (expected user@domain or user@domain/resource).")
             self._user = m.group(1)
             self._domain = m.group(2)
             self._resource = m.group(3)
@@ -1161,4 +1181,4 @@ class XmppComm(Comm):
                     pass  # already gone server-side
 
 
-__all__ = ["XmppComm"]
+__all__ = ["XmppComm", "is_valid_jid"]

{pyobs_core-2.0.0.dev47 → pyobs_core-2.0.0.dev49}/pyobs/modules/module.py

@@ -383,11 +383,14 @@ class Module(Object, IModule, IConfig):
         """
         await self.open()
 
-        # warn if any stateful interface hasn't published state yet
+        # a stateful interface with no published state by now isn't a transient, self-healing
+        # condition -- it's a standing defect (missing placeholder publish in open()) that sits
+        # there on every single startup until fixed, so this is an error, not a warning, even
+        # though it doesn't block startup itself (see specs/plans/enforce-state-publishing.md)
         if self._comm is not None:
             missing = self._comm.missing_published_state(self._interfaces)
             for iface in missing:
-                log.warning(
+                log.error(
                     "Module %s implements %s which declares state, but no state has been published for it yet.",
                     self.name,
                     iface.__name__,

{pyobs_core-2.0.0.dev47 → pyobs_core-2.0.0.dev49}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-core"
-version = "2.0.0.dev47"
+version = "2.0.0.dev49"
 description = "robotic telescope software"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"
@@ -27,7 +27,7 @@ dependencies = [
     "influxdb-client>=1.49.0",
     "pydantic>=2.12.5",
     "astropydantic>=0.0.5",
-    "pillow>=11.3.0",
+    "pillow>=12.3.0",
     "tenacity>=9.1.4",
     "psutil>=7.2.2",
     "logging-journald>=0.6.11",

pyobs_core-2.0.0.dev47/pyobs/comm/xmpp/__init__.py

@@ -1,3 +0,0 @@
-from .xmppcomm import XmppComm
-
-__all__ = ["XmppComm"]