pyobs-gui 2.6.3__tar.gz → 2.7.0__tar.gz

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Entries for releases before this file existed were generated from commit subjects.
 
+## [2.7.0] - 2026-10-15
+
+### Added
+
+- Display structured-configuration choice labels while retaining the original typed
+  values; preserve unknown stored choices for explicit correction (#211, #218).
+
+### Fixed
+
+- Distinguish boolean and numeric choices when tracking configuration edits (#218).
+
+### Changed
+
+- Require pyobs-core 2.18.0 or newer for typed configuration-choice capabilities.
+
 ## [2.6.1] - 2026-10-04
 
 - Require pyobs-core 2.14.0, which has the slimmed base dependencies

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyobs-gui
-Version: 2.6.3
+Version: 2.7.0
 Summary: A remote GUI for pyobs
 Project-URL: Homepage, https://www.pyobs.org
 Project-URL: Documentation, https://docs.pyobs.org
@@ -19,7 +19,7 @@ Requires-Dist: keyring<26,>=25.7.0
 Requires-Dist: matplotlib<4,>=3.10.1
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: pydantic<3,>=2.12.5
-Requires-Dist: pyobs-core<3,>=2.14.0
+Requires-Dist: pyobs-core<3,>=2.18.0
 Requires-Dist: pyside6-essentials>=6.10.1
 Requires-Dist: pywin32>=312; sys_platform == 'win32'
 Requires-Dist: pyyaml<7,>=6.0.2

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/pyobs_gui/structuredconfigwidget.py

@@ -85,6 +85,53 @@ def _nested_set(children: Dict[str, _FieldEditor], value: ConfigValue) -> None:
             child.set_value(value[name])
 
 
+def _choice_equal(left: ConfigValue, right: ConfigValue) -> bool:
+    if isinstance(left, dict) and isinstance(right, dict):
+        return left.keys() == right.keys() and all(_choice_equal(value, right[key]) for key, value in left.items())
+    if isinstance(left, list) and isinstance(right, list):
+        return len(left) == len(right) and all(_choice_equal(a, b) for a, b in zip(left, right, strict=True))
+    if type(left) in (int, float) and type(right) in (int, float):
+        return left == right
+    return type(left) is type(right) and left == right
+
+
+def _build_enum_editor(schema: ConfigFieldSchema, on_change: Callable[[], None]) -> _FieldEditor:
+    combo = QtWidgets.QComboBox()
+    # Feature detection keeps older string-only core installations usable.
+    choices = getattr(schema, "choices", None)
+    values: list[ConfigValue] = (
+        [choice.value for choice in choices] if choices is not None else list(schema.options or [])
+    )
+    labels = [choice.label for choice in choices] if choices is not None else [str(value) for value in values]
+    combo.addItems(labels)
+    raw: list[ConfigValue] = [cast("ConfigValue", None)]
+
+    def set_value(value: ConfigValue) -> None:
+        raw[0] = value
+        if combo.count() > len(values):
+            combo.removeItem(len(values))
+        index = next((i for i, allowed in enumerate(values) if _choice_equal(value, allowed)), None)
+        if index is None:
+            index = len(values)
+            combo.addItem(f"(unknown value: {value!r})")
+        combo.setCurrentIndex(index)
+
+    def get_value() -> ConfigValue:
+        index = combo.currentIndex()
+        return values[index] if 0 <= index < len(values) else raw[0]
+
+    if schema.default is not None or not values:
+        set_value(cast("ConfigValue", schema.default))
+    combo.currentIndexChanged.connect(lambda _: on_change())
+    return _FieldEditor(
+        combo,
+        get_value,
+        set_value,
+        level=schema.level,
+        row_widget=_wrap_with_description(combo, schema.description),
+    )
+
+
 def _build_editor(name: str, schema: ConfigFieldSchema, on_change: Callable[[], None]) -> _FieldEditor:
     """Build one field's editor from its schema (recursively, for a nested object)."""
 
@@ -146,19 +193,7 @@ def _build_editor(name: str, schema: ConfigFieldSchema, on_change: Callable[[],
         )
 
     if schema.type == "enum":
-        combo_box = QtWidgets.QComboBox()
-        options = schema.options or []
-        combo_box.addItems(options)
-        if schema.default is not None and str(schema.default) in options:
-            combo_box.setCurrentText(str(schema.default))
-        combo_box.currentTextChanged.connect(lambda _: on_change())
-        return _FieldEditor(
-            combo_box,
-            combo_box.currentText,
-            lambda value: combo_box.setCurrentText(str(value)),
-            level=schema.level,
-            row_widget=_wrap_with_description(combo_box, schema.description),
-        )
+        return _build_enum_editor(schema, on_change)
 
     if schema.type == "object" and schema.nested is not None:
         group_box = QtWidgets.QGroupBox(name)
@@ -325,7 +360,7 @@ class StructuredConfigWidget(BaseWidget):
     def _is_dirty(self) -> bool:
         if self._root is None or self._last_applied is None:
             return False
-        return self._root.get_value() != self._last_applied
+        return not _choice_equal(self._root.get_value(), self._last_applied)
 
     def _update_buttons(self) -> None:
         dirty = self._is_dirty()

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyobs-gui"
-version = "2.6.3"
+version = "2.7.0"
 description = "A remote GUI for pyobs"
 authors = [{ name = "Tim-Oliver Husser", email = "thusser@uni-goettingen.de" }]
 requires-python = ">=3.11"
@@ -15,7 +15,7 @@ dependencies = [
     "astroquery>=0.4.10,<0.5",
     "QtAwesome>=1.4.0,<2",
     "qfitswidget>=1.2.0",
-    "pyobs-core>=2.14.0,<3",
+    "pyobs-core>=2.18.0,<3",
     "pyside6-essentials>=6.10.1",
     "astroplan>=0.10.1",
     "astropy>=7.0.1,<8",

pyobs_gui-2.7.0/specs/2026-10-14-typed-config-choices.md

@@ -0,0 +1,92 @@
+# Plan: preserve typed structured-config choices and show their labels
+
+Status: implemented; release and deployment pending.
+Repos: pyobs-gui, pyobs-core.
+Issue: [#211](https://github.com/pyobs/pyobs-gui/issues/211).
+Shared contract and rollout: [core plan](../../pyobs-core/specs/plans/2026-10-14-typed-config-choices.md).
+Companion: [portal plan](../../pyobs-portal/specs/plans/2026-10-14-typed-config-choices.md).
+
+## Verified cause and intended behavior
+
+`pyobs_gui/structuredconfigwidget.py::_build_editor` uses `QComboBox.addItems`,
+`currentText`, and `setCurrentText` for enum choices. Its numeric spin boxes already
+return numbers. Core currently stringifies Pydantic Literal values before the GUI
+sees them, so a GUI-only cast is not sufficient.
+
+With the coordinated core change, a synthetic choice `16416` can display
+`Detector A` and submit integer `16416`. Labels come from capability metadata;
+the widget remains generic and consumes no provider-specific label tables.
+
+## Implementation checklist
+
+- [x] Feature-detect optional typed `choices` records on `ConfigFieldSchema`,
+      retaining compatibility with existing core versions and legacy string `options`.
+- [x] Prefer `schema.choices` when present. Populate each combo entry with its display
+      label and keep its original scalar value in an authoritative Python-side list
+      indexed by combo index. Qt user data is also viable if tests establish exact
+      scalar preservation; do not rely on QVariant's implicit conversions.
+- [x] Get the selected value from that typed collection, never `currentText`. Use
+      index-based change notifications so entries with identical labels remain distinct.
+- [x] Set defaults/state/reset selection by scalar identity: bool differs from number,
+      strings differ from numbers, and numerical int/float equality follows the shared
+      JSON contract. Never match by display label or use `str(value)` as identity.
+- [x] Preserve duplicate labels, `"1"` versus `1`, `True` versus `1`, and string codes
+      such as `"001"`. Do not globally parse numeric-looking strings.
+- [x] Define invalid/missing selection behavior explicitly: if a received value is not
+      in the domain, preserve it with a visibly marked synthetic entry until the user
+      chooses a legal value. Never silently retain the previous selection or choose the
+      first entry. An empty domain needs a preserved raw value or a disabled editor;
+      getting index -1 must not accidentally return the last allowed option.
+- [x] Keep default fallback only for genuinely absent values. A received `None` for a
+      non-null choice is a preserved invalid value, not a first-choice substitution.
+      General nullable editor support is outside this fix.
+- [x] With `choices=None`, render legacy `options` as string-valued choices as before.
+      A numeric state value against a string-only legacy domain must remain visible
+      as unsupported/unknown rather than being guessed into a type. Document that
+      upgrading the producer is necessary for the numeric Literal fix.
+- [x] Preserve descriptions, expert visibility, permissions, nested editors, apply/reset
+      flow and incoming-state dirty suppression. Test payloads through the existing
+      `_apply_config` proxy path. Avoid broad dirty-state or hidden-field refactoring.
+
+## Tests and acceptance
+
+Extend `tests/test_structuredconfigwidget.py` (confirm existing test helpers before
+adding fixtures), exercising real Qt widgets with the existing headless test setup:
+
+- [x] Typed integer/float/bool/string choices retain exact Python types on initial
+      render, selection, state refresh, reset and apply. An unchanged numeric state
+      must not become dirty solely because a combo returns text.
+- [x] Labels render correctly, including the Unicode choice label. Duplicate labels and
+      mixed typed values select by identity and trigger change handling by index.
+- [x] Nested `main.detector` payload reaches the mocked `IStructuredConfig.set_config` as
+      an integer; rejection/server validation behavior remains intact.
+- [x] Plain integer/float editors still return numbers; old string-only capabilities
+      still work. Partial/missing labels use raw display fallbacks from core.
+- [x] Unknown value, None, empty options, invalid default, and invalid current index
+      do not silently overwrite configuration with the first or last option.
+- [ ] Run the affected Qt suite and repository lint/type checks. Against candidate
+      installed core and model-provider versions, load a real representative configuration,
+      change a numeric choice and a numeric scalar, Apply, observe published state, then Reset.
+      Confirm no hardware operation beyond the explicitly authorized test environment.
+
+## Deployment constraints
+
+For the full typed-choice fix, the new core must be installed in the GUI environment and in the module's environment;
+update standalone bundles as well as normal Python installations. Old core decoders ignore
+unknown `choices`, and old `options: list[str]` decoding cannot recover numerical types.
+New GUI + old producer is therefore only legacy-compatible, not a complete fix. Old
+GUI + new producer continues to render string options and retains its old bug.
+
+Readable labels additionally require the model provider to publish the shared
+`x-pyobs-choices` metadata and the module to republish capabilities after restart.
+Test typed choices without labels too, so the numeric fix can ship independently of
+label deployment. Implementation and automated regression checks are complete; release and deployment remain pending.
+
+## Implementation verification (2026-10-15)
+
+- Full GUI suite: 311 passed. Structured-config regressions pass with both the
+  installed legacy core and the candidate typed-choice core.
+- Ruff and Pyrefly pass; changed Python files pass Black. Repository-wide Black
+  reports existing differences in generated UI files and unrelated widgets.
+- Candidate provider → core XML → Qt checks preserve numeric values and labels,
+  including unlabeled bitmask combinations. No hardware operation was performed.

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/specs/index.md

@@ -74,6 +74,9 @@ ADRs that concern `pyobs-gui` live in `pyobs-core`'s `specs/` tree instead (`spe
   single compiled binary that works across sites with no rebuild. **rejected 2026-09-14** — the
   real build came out several GB, not viable as a one-file download. The two pieces below shipped
   independently and aren't affected.
+- `pyobs-core/specs/design/gui-install-size-and-standalone-build.md` — slimmed install (1506 to
+  716 MB) and the experimental Nuitka binary (764 MB) with its open astropy unit-format issue.
+  **dependency split implemented** (`pyobs-gui` 2.6.1, `pyobs-core` 2.14.0), binary experimental.
 - `pyobs-core/specs/plans/2026-07-26-gui-interactive-login.md` — interactive login/settings
   dialog to replace the current YAML-config-file requirement (pyobs-core side).
   **implemented, closed** (landed 2026-07-27)
@@ -107,3 +110,6 @@ ADRs that concern `pyobs-gui` live in `pyobs-core`'s `specs/` tree instead (`spe
   live view in `VideoWidget`: MJPEG with server-side stretch for slow links, or `/video.raw` with
   client-side stretch/cuts and crop on zoom. Plan: `pyobs-core/specs/plans/2026-09-29-basevideo-frame-buffer-redesign.md`
   (phase 6).
+
+- [2026-10-14-typed-config-choices.md](2026-10-14-typed-config-choices.md) — **implemented; release pending** (#211). Typed structured-config combo values and
+  readable labels; coordinated core capability and provider metadata dependencies.

{pyobs_gui-2.6.3 → pyobs_gui-2.7.0}/tests/test_structuredconfigwidget.py

@@ -1,3 +1,4 @@
+from types import SimpleNamespace
 from unittest.mock import AsyncMock, patch
 
 import pytest
@@ -376,3 +377,119 @@ async def test_apply_failure_surfaces_through_show_remote_error(qapp) -> None:
 
     mock_show_error.assert_awaited_once()
     widget.close()
+
+
+@pytest.mark.parametrize("value", [16416, 1.5, True, False, "001"])
+def test_typed_choice_preserves_value_and_label(value) -> None:
+    schema = _typed_schema(type="enum", choices=[SimpleNamespace(value=value, label="Detector α")], default=value)
+    editor = _build_editor("detector", schema, lambda: None)
+    assert isinstance(editor.widget, QtWidgets.QComboBox)
+    assert editor.widget.itemText(0) == "Detector α"
+    assert editor.get_value() == value
+    assert type(editor.get_value()) is type(value)
+    editor.set_value(value)
+    assert type(editor.get_value()) is type(value)
+
+
+def test_typed_choice_identity_duplicate_labels_and_unknown_values() -> None:
+    values = [1, "1", True, "001"]
+    changes = []
+    editor = _build_editor(
+        "choice",
+        _typed_schema(
+            type="enum",
+            choices=[SimpleNamespace(value=value, label="same") for value in values],
+            default=1,
+        ),
+        lambda: changes.append(True),
+    )
+    combo = editor.widget
+    assert isinstance(combo, QtWidgets.QComboBox)
+    for index, value in enumerate(values):
+        editor.set_value(value)
+        assert combo.currentIndex() == index
+        assert type(editor.get_value()) is type(value)
+    assert changes  # index changes fire even when every display label is the same
+    for unknown in [999, None, "missing"]:
+        editor.set_value(unknown)  # pyrefly: ignore [bad-argument-type] -- intentionally invalid None
+        assert editor.get_value() == unknown
+        assert combo.count() == len(values) + 1
+        assert "unknown" in combo.currentText()
+    editor.set_value(1)
+    assert combo.count() == len(values)
+    combo.setCurrentIndex(-1)
+    assert editor.get_value() == 1
+
+
+def test_empty_choice_domain_preserves_received_value() -> None:
+    editor = _build_editor("choice", _typed_schema(type="enum", options=["legacy"], choices=[]), lambda: None)
+    editor.set_value(999)
+    assert editor.get_value() == 999
+    assert isinstance(editor.widget, QtWidgets.QComboBox)
+    assert "legacy" not in editor.widget.currentText()
+
+
+@pytest.mark.asyncio
+async def test_typed_choice_state_reset_and_apply() -> None:
+    widget = StructuredConfigWidget()
+    widget.modules = ["module"]
+    widget._build_form(
+        ConfigSchema(
+            fields={
+                "main": _typed_schema(
+                    type="object",
+                    nested={
+                        "detector": _typed_schema(
+                            type="enum",
+                            choices=[SimpleNamespace(value=1, label="A"), SimpleNamespace(value=2, label="B")],
+                        )
+                    },
+                )
+            }
+        )
+    )
+    widget._on_state(ConfigAppliedState(config={"main": {"detector": 1}}))
+    widget.update_gui()
+    assert not widget._is_dirty()
+    assert widget._root is not None and widget._root.children is not None
+    main = widget._root.children["main"]
+    assert main.children is not None
+    editor = main.children["detector"]
+    editor.set_value(2)
+    assert widget._is_dirty()
+    widget.reset_clicked()
+    assert editor.get_value() == 1
+    assert not widget._is_dirty()
+    editor.set_value(2)
+    proxy = AsyncMock()
+    widget._comm = FakeComm(proxy)  # pyrefly: ignore [bad-assignment]
+    await widget._apply_config(_nested_get(widget._root.children))
+    proxy.set_config.assert_awaited_once_with({"main": {"detector": 2}})
+    assert type(proxy.set_config.call_args.args[0]["main"]["detector"]) is int
+
+
+def _typed_schema(*, choices=None, **kwargs):
+    # Build the additive capability shape without requiring an unreleased core in CI.
+    schema = ConfigFieldSchema(**kwargs)
+    vars(schema)["choices"] = choices
+    return schema
+
+
+def test_numeric_and_boolean_choices_have_distinct_dirty_state() -> None:
+    widget = StructuredConfigWidget()
+    widget.modules = ["module"]
+    widget._build_form(
+        ConfigSchema(
+            fields={
+                "choice": _typed_schema(
+                    type="enum",
+                    choices=[SimpleNamespace(value=1, label="Number"), SimpleNamespace(value=True, label="Boolean")],
+                )
+            }
+        )
+    )
+    widget._on_state(ConfigAppliedState(config={"choice": 1}))
+    widget.update_gui()
+    assert widget._root is not None and widget._root.children is not None
+    widget._root.children["choice"].set_value(True)
+    assert widget._is_dirty()