feat(forms): unified pydantic and scan control adapter for pydantic models

Author: wyzula-jan

bec_widgets/cli/client.py

@@ -33,7 +33,6 @@ class _WidgetsEnumType(str, enum.Enum):
     "BECShell": "BECShell",
     "BECStatusBox": "BECStatusBox",
     "BeamlineStateManager": "BeamlineStateManager",
-    "BeamlineStatePill": "BeamlineStatePill",
     "BecConsole": "BecConsole",
     "DapComboBox": "DapComboBox",
     "DeviceBrowser": "DeviceBrowser",
@@ -737,64 +736,19 @@ def set_idle_card_background(self, enabled: "bool") -> "None":
         Set whether idle collapsed pills keep the status-tinted card background.
         """
 
-    @rpc_call
-    def refresh_states(self) -> "None":
-        """
-        Fetch the latest cached available beamline states and update the list immediately.
-        """
-
     @rpc_call
     def clear_filters(self) -> "None":
         """
         None
         """
 
     @rpc_call
-    def remove(self):
-        """
-        Cleanup the BECConnector
-        """
-
-    @rpc_call
-    def attach(self):
-        """
-        None
-        """
-
-    @rpc_call
-    def detach(self):
-        """
-        Detach the widget from its parent dock widget (if widget is in the dock), making it a floating widget.
-        """
-
-    @rpc_timeout(None)
-    @rpc_call
-    def screenshot(self, file_name: "str | None" = None):
-        """
-        Take a screenshot of the dock area and save it to a file.
-        """
-
-
-class BeamlineStatePill(RPCBase):
-    """Compact widget showing one BEC beamline state."""
-
-    _IMPORT_MODULE = "bec_widgets.widgets.services.beamline_states.beamline_state_pill"
-
-    @property
-    @rpc_call
-    def state_name(self) -> "str | None":
-        """
-        Name of the BEC beamline state displayed by this pill.
-        """
-
-    @rpc_call
-    def set_state_name(self, state_name: "str | None", title: "str | None" = None) -> "None":
+    def state_summary(self) -> "dict[str, dict[str, str]]":
         """
-        Set the BEC beamline state this pill displays.
+        Return the displayed beamline states with their current status and label.
 
-        Args:
-            state_name: State name as published by ``AvailableBeamlineStatesMessage``.
-            title: Optional human-readable title for the state.
+        Returns:
+            dict: Mapping of state name to a dictionary with ``status`` and ``label`` keys.
         """
 
     @rpc_call

bec_widgets/cli/designer_plugins.py

@@ -23,10 +23,6 @@
         "bec_widgets.widgets.services.beamline_states.beamline_state_pill",
         "BeamlineStateManager",
     ),
-    "BeamlineStatePill": (
-        "bec_widgets.widgets.services.beamline_states.beamline_state_pill",
-        "BeamlineStatePill",
-    ),
     "BecConsole": ("bec_widgets.widgets.editors.bec_console.bec_console", "BecConsole"),
     "ColorButton": ("bec_widgets.widgets.utility.visual.color_button.color_button", "ColorButton"),
     "ColorButtonNative": (
@@ -127,7 +123,6 @@
     "BECSpinBox": "123",
     "BECStatusBox": "widgets",
     "BeamlineStateManager": "format_list_bulleted",
-    "BeamlineStatePill": "info",
     "BecConsole": "terminal",
     "ColorButton": "colors",
     "ColorButtonNative": "colors",

bec_widgets/utils/forms_from_types/pydantic_model_info_adapter.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any
+
+from pydantic import BaseModel
+from pydantic_core import PydanticUndefined
+
+from bec_widgets.utils.scan_arg_metadata import ui_config_from_metadata
+
+NUMERIC_BOUND_KEYS = {"gt", "ge", "lt", "le"}
+
+
+def pydantic_model_input_configs(model: type[BaseModel]) -> list[dict[str, Any]]:
+    """Return scan-control-style field items for a Pydantic model."""
+    configs = []
+    for name, info in model.model_fields.items():
+        metadata: dict[str, Any] = {}
+        for entry in info.metadata:
+            for key in NUMERIC_BOUND_KEYS:
+                value = getattr(entry, key, None)
+                if value is not None:
+                    metadata.setdefault(key, value)
+
+        if isinstance(info.json_schema_extra, Mapping):
+            metadata.update(dict(info.json_schema_extra))
+
+        if info.description and metadata.get("description") is None:
+            metadata["description"] = info.description
+
+        default: Any
+        if info.default is not PydanticUndefined:
+            default = info.default
+        elif info.default_factory is not None:
+            default = info.get_default(call_default_factory=True)
+        else:
+            default = None
+
+        display_name = metadata.get("display_name") or info.title
+        if display_name is None:
+            display_name = name.replace("_", " ").capitalize()
+
+        item = ui_config_from_metadata(
+            name=name, metadata=metadata, default=default, display_name=display_name
+        )
+        item.update({key: value for key, value in metadata.items() if key not in item})
+        configs.append(item)
+
+    return configs