fix(pydantic): adoption to new ScanArgument refactor from bec

Author: wyzula-jan

bec_widgets/cli/client.py

@@ -738,7 +738,7 @@ def collapse_all(self) -> "None":
     @rpc_call
     def state_summary(self) -> "dict[str, dict[str, str]]":
         """
-        Return the displayed beamline states with their current status and label.
+        Return all beamline states (including filtered ones) with their current status and label.
 
         Returns:
             dict: Mapping of state name to a dictionary with ``status`` and ``label`` keys.

bec_widgets/utils/forms_from_types/pydantic_model_info_adapter.py

@@ -3,6 +3,7 @@
 from collections.abc import Mapping
 from typing import Any
 
+from bec_lib.scan_args import ScanArgument
 from pydantic import BaseModel
 from pydantic_core import PydanticUndefined
 
@@ -17,6 +18,9 @@ def pydantic_model_input_configs(model: type[BaseModel]) -> list[dict[str, Any]]
     for name, info in model.model_fields.items():
         metadata: dict[str, Any] = {}
         for entry in info.metadata:
+            if isinstance(entry, ScanArgument):
+                metadata.update(entry.model_dump(exclude_none=True))
+                continue
             for key in NUMERIC_BOUND_KEYS:
                 value = getattr(entry, key, None)
                 if value is not None:

tests/unit_tests/test_generated_form_form.py

@@ -214,6 +214,28 @@ def test_pydantic_widget_form_plain_field_has_generated_label_and_no_tooltip(qtb
     assert form.field_widget("sample_name").toolTip() == ""
 
 
+def test_pydantic_model_input_configs_reads_bl_states_annotated_scan_arguments():
+    """Contract test: ScanArgument metadata attached via ``Annotated`` in bec_lib's beamline
+    state configs must reach the generated-form configuration."""
+    from bec_lib import bl_states
+
+    from bec_widgets.utils.forms_from_types.pydantic_model_info_adapter import (
+        pydantic_model_input_configs,
+    )
+
+    items = {
+        item["name"]: item
+        for item in pydantic_model_input_configs(bl_states.DeviceWithinLimitsState.CONFIG_CLASS)
+    }
+
+    assert items["name"]["display_name"] == "State name"
+    assert items["name"]["tooltip"]
+    assert items["device"]["display_name"] == "Device"
+    assert items["low_limit"]["reference_units"] == "device"
+    assert items["high_limit"]["reference_units"] == "device"
+    assert items["tolerance"]["reference_units"] == "device"
+
+
 def test_pydantic_widget_form_uses_scan_argument_metadata(qtbot, mocked_client):
     form = PydanticWidgetForm(GeneratedScanArgumentSchema, client=mocked_client)
     qtbot.addWidget(form)