pyobs-core 2.7.2__tar.gz → 2.8.0__tar.gz

{pyobs_core-2.7.2 → pyobs_core-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyobs-core
-Version: 2.7.2
+Version: 2.8.0
 Summary: robotic telescope software
 Author-email: Tim-Oliver Husser <thusser@uni-goettingen.de>
 License-Expression: MIT

{pyobs_core-2.7.2 → pyobs_core-2.8.0}/pyobs/robotic/instruments.py

@@ -10,12 +10,29 @@ from __future__ import annotations
 
 from typing import Any
 
-from pydantic import Field
+from pydantic import ConfigDict, Field
 
 from pyobs.utils.serialization import BaseModel
 
 
-class Filter(BaseModel):
+class _ForwardCompatibleModel(BaseModel):
+    """Base for the capability models below, relaxing `BaseModel`'s `extra="forbid"` to
+    `extra="ignore"`.
+
+    A running process (e.g. `mastermind`) can be on an older pyobs-core release than whatever
+    portal it polls -- the portal gaining a field (as it will over time; `model`/`sensor_type`
+    already did once) must not turn into a hard parse failure that starves it of every other
+    field in the response. `extra="forbid"` is a deliberate, useful default elsewhere in pyobs
+    (catching config typos, `2026-08-15-pydantic-extra-validation.md`) but wrong here: this
+    module only ever consumes portal-controlled data, not user-authored config, and the two
+    sides (portal, and every fleet site's own pyobs-core version) are never guaranteed to be on
+    the same release.
+    """
+
+    model_config = ConfigDict(extra="ignore")
+
+
+class Filter(_ForwardCompatibleModel):
     """A single filter position in a filter wheel."""
 
     name: str
@@ -23,7 +40,7 @@ class Filter(BaseModel):
     updated_at: str | None = None
 
 
-class BinningOption(BaseModel):
+class BinningOption(_ForwardCompatibleModel):
     """Readout time for one binning mode of a camera."""
 
     x: int
@@ -32,25 +49,35 @@ class BinningOption(BaseModel):
     updated_at: str | None = None
 
 
-class FilterWheelCapability(BaseModel):
-    """Planning-time capability data for one filter wheel.
+class FilterWheelCapability(_ForwardCompatibleModel):
+    """Planning-time capability data for one filter wheel, keyed by `module_name`.
 
-    `module_name` is nullable -- not every filter wheel is its own addressable module (some
-    cameras expose filter selection through the camera module itself), per pyobs-portal#142.
+    `module_name` is required and non-empty, same as every other device here -- a wheel with
+    filter selection exposed through the camera's own module (no independent XMPP identity)
+    should be entered with the *camera's* module_name, not left blank. It used to be nullable
+    (pyobs-portal#142) but a blank value made the row permanently unreachable via
+    `InstrumentCapabilities.filter_wheel()`, which indexes by module_name -- there was no valid
+    case for it in practice. `min_length=1` closes the same gap for `""`, which `str` alone
+    wouldn't catch (only non-`None`, not non-empty) and which the portal side's `blank=False`
+    can't fully guarantee either (pre-#142 `blank=True` rows, or a direct ORM write bypassing
+    `full_clean()`).
     """
 
     name: str = ""
-    module_name: str | None = None
+    module_name: str = Field(min_length=1)
+    model: str = ""
     filter_change_time_s: float | None = None
     updated_at: str | None = None
     filters: list[Filter] = Field(default_factory=list)
 
 
-class CameraCapability(BaseModel):
+class CameraCapability(_ForwardCompatibleModel):
     """Planning-time capability data for one camera, keyed by `module_name`."""
 
-    module_name: str
+    module_name: str = Field(min_length=1)
     code: str
+    model: str = ""
+    sensor_type: str = ""
     pixel_size_um: float | None = None
     sensor_width_px: int | None = None
     sensor_height_px: int | None = None
@@ -79,10 +106,10 @@ class CameraCapability(BaseModel):
 DEFAULT_SLEW_DISTANCE_DEG = 90.0
 
 
-class TelescopeCapability(BaseModel):
+class TelescopeCapability(_ForwardCompatibleModel):
     """Planning-time capability data for one telescope, keyed by `module_name`."""
 
-    module_name: str
+    module_name: str = Field(min_length=1)
     aperture_mm: float | None = None
     focal_length_mm: float | None = None
     mount_type: str = ""
@@ -103,10 +130,10 @@ class TelescopeCapability(BaseModel):
         return distance_deg / self.slew_rate_deg_per_s
 
 
-class DomeCapability(BaseModel):
+class DomeCapability(_ForwardCompatibleModel):
     """Planning-time capability data for one dome, keyed by `module_name`."""
 
-    module_name: str
+    module_name: str = Field(min_length=1)
     rotate_rate_deg_per_s: float | None = None
     updated_at: str | None = None
 
@@ -120,7 +147,7 @@ class DomeCapability(BaseModel):
         return distance_deg / self.rotate_rate_deg_per_s
 
 
-class RoofCapability(BaseModel):
+class RoofCapability(_ForwardCompatibleModel):
     """Planning-time capability data for one plain open/close roof, keyed by `module_name`.
 
     A plain roof (`IRoof`, no `IPointingAltAz`) has no rate/distance concept -- nothing to rotate
@@ -131,12 +158,12 @@ class RoofCapability(BaseModel):
     directly.
     """
 
-    module_name: str
+    module_name: str = Field(min_length=1)
     open_close_time_s: float | None = None
     updated_at: str | None = None
 
 
-class Instrument(BaseModel):
+class Instrument(_ForwardCompatibleModel):
     """One telescope + dome/roof + camera(s) grouping, as returned by `GET /api/instruments/`.
 
     Purely an organizational grouping on the portal side -- it carries no module identity of its
@@ -176,8 +203,7 @@ class InstrumentCapabilities:
                 self._cameras[camera.module_name] = camera
                 self._cameras_by_code[camera.code] = camera
                 for wheel in camera.filter_wheels:
-                    if wheel.module_name is not None:
-                        self._filter_wheels[wheel.module_name] = wheel
+                    self._filter_wheels[wheel.module_name] = wheel
             if instrument.telescope is not None:
                 self._telescopes[instrument.telescope.module_name] = instrument.telescope
             if instrument.dome is not None:

{pyobs_core-2.7.2 → pyobs_core-2.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-core"
-version = "2.7.2"
+version = "2.8.0"
 description = "robotic telescope software"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"