GEOPY-2739: Accept BaseUIJson in the start of driver

geoh5py/shared/utils.py

@@ -39,8 +39,6 @@
 from .exceptions import Geoh5FileClosedError
 
 
-UidOrNumeric = UUID | float | int | None
-StringOrNumeric = str | float | int
 # pylint: disable=too-many-lines
 
 if TYPE_CHECKING:
@@ -837,7 +835,9 @@ def map_attributes(object_, **kwargs):
     set_attributes(object_, **values)
 
 
-def stringify(values: dict[str, Any]) -> dict[str, Any]:
+def stringify(
+    values: Any | dict[str, Any],
+) -> dict[str, str] | dict[str, list[str]] | str | list[str]:
     """
     Convert all values in a dictionary to string.
 
@@ -846,11 +846,13 @@ def stringify(values: dict[str, Any]) -> dict[str, Any]:
     :return: Dictionary of string values.
     """
     mappers = [
+        type2uuid,
         entity2uuid,
         nan2str,
         inf2str,
         as_str_if_uuid,
         none2str,
+        enum_name_to_str,
         workspace2path,
         path2str,
     ]
@@ -889,31 +891,6 @@ def to_tuple(value: Any) -> tuple:
     return (value,)
 
 
-class SetDict(dict):
-    def __init__(self, **kwargs):
-        kwargs = {k: self.make_set(v) for k, v in kwargs.items()}
-        super().__init__(kwargs)
-
-    def make_set(self, value):
-        if isinstance(value, (set, tuple, list)):
-            value = set(value)
-        else:
-            value = {value}
-        return value
-
-    def __setitem__(self, key, value):
-        value = self.make_set(value)
-        super().__setitem__(key, value)
-
-    def update(self, value: dict, **kwargs) -> None:  # type: ignore
-        for key, val in value.items():
-            val = self.make_set(val)
-            if key in self:
-                val = self[key].union(val)
-            value[key] = val
-        super().update(value, **kwargs)
-
-
 def inf2str(value):  # map np.inf to "inf"
     if not isinstance(value, (int, float)):
         return value
@@ -944,8 +921,15 @@ def nan2str(value):
     return value
 
 
-def str2none(value):
-    if value == "":
+def str2none(value: Any) -> Any:
+    """
+    Convert an empty string or zero UUID string to None.
+
+    :param value: Value to convert.
+
+    :return: None if value is an empty string or zero UUID, original value otherwise.
+    """
+    if value in ("", "{00000000-0000-0000-0000-000000000000}"):
         return None
     return value
 
@@ -1443,12 +1427,26 @@ def map_to_class(
     return class_map
 
 
-def enum_name_to_str(value: Enum) -> str:
+def enum_name_to_str(value: Any | Enum) -> Any | str:
     """
     Convert enum name to capitalized string.
 
     :param value: Enum value to convert.
 
     :return: Capitalized string.
     """
-    return value.name.capitalize()
+    if isinstance(value, Enum):
+        return value.name.capitalize()
+
+    return value
+
+
+def type2uuid(value: Any) -> Any | UUID:
+    """
+    Convert an Entity type to its default uuid.
+
+    :param value: An entity type or any.
+    """
+    if isinstance(value, type) and hasattr(value, "default_type_uid"):
+        return value.default_type_uid()
+    return value

geoh5py/shared/validators.py

@@ -145,12 +145,6 @@ def to_class(
     return out
 
 
-def types_to_string(types: list) -> list[str] | str:
-    if len(types) > 1:
-        return [f"{{{k.default_type_uid()!s}}}" for k in types]
-    return f"{{{types[0].default_type_uid()!s}}}"
-
-
 class BaseValidator(ABC):
     """Concrete base class for validators."""
 

geoh5py/ui_json/__init__.py

@@ -27,4 +27,4 @@
 from .utils import monitored_directory_copy
 from .validation import InputValidation
 from .forms import BaseForm
-from .ui_json import BaseUIJson
+from .ui_json import UIJson

geoh5py/ui_json/annotations.py

@@ -27,13 +27,18 @@
 from geoh5py.data import DataAssociationEnum, DataTypeEnum
 from geoh5py.groups import Group
 from geoh5py.objects import ObjectBase
-from geoh5py.shared.utils import enum_name_to_str, none2str, str2none, stringify
+from geoh5py.shared.utils import (
+    enum_name_to_str,
+    none2str,
+    str2none,
+    stringify,
+    workspace2path,
+)
 from geoh5py.shared.validators import (
     to_class,
     to_list,
     to_path,
     to_type_uid_or_class,
-    types_to_string,
 )
 from geoh5py.ui_json.utils import optional_uuid_mapper
 
@@ -47,55 +52,61 @@ def deprecate(value, info):
     return value
 
 
+Deprecated = Annotated[
+    Any,
+    Field(exclude=True),
+    BeforeValidator(deprecate),
+]
+
 AssociationOptions = Annotated[
     DataAssociationEnum,
-    PlainSerializer(enum_name_to_str),
+    PlainSerializer(enum_name_to_str, when_used="json"),
 ]
 
 DataTypeOptions = Annotated[
     DataTypeEnum,
-    PlainSerializer(enum_name_to_str),
-]
-
-
-Deprecated = Annotated[
-    Any,
-    Field(exclude=True),
-    BeforeValidator(deprecate),
+    PlainSerializer(enum_name_to_str, when_used="json"),
 ]
 
 GroupTypes = Annotated[
     list[type[Group]],
     BeforeValidator(to_class),
     BeforeValidator(to_type_uid_or_class),
     BeforeValidator(to_list),
-    PlainSerializer(types_to_string, when_used="json"),
+    PlainSerializer(stringify, when_used="json"),
 ]
 
 MeshTypes = Annotated[
     list[type[ObjectBase]],
     BeforeValidator(to_class),
     BeforeValidator(to_type_uid_or_class),
     BeforeValidator(to_list),
-    PlainSerializer(types_to_string, when_used="json"),
+    PlainSerializer(stringify, when_used="json"),
 ]
 
 OptionalPath = Annotated[
     Path | None,
     BeforeValidator(str2none),
-    PlainSerializer(none2str),
+    BeforeValidator(workspace2path),
+    PlainSerializer(none2str, when_used="json"),
+]
+
+OptionalString = Annotated[
+    str | None,
+    BeforeValidator(str2none),
+    PlainSerializer(none2str, when_used="json"),
 ]
 
 OptionalUUID = Annotated[
     UUID | None,
     BeforeValidator(optional_uuid_mapper),
-    PlainSerializer(stringify),
+    PlainSerializer(stringify, when_used="json"),
 ]
 
 OptionalUUIDList = Annotated[
-    list[UUID] | None,
+    list[UUID] | UUID | None,
     BeforeValidator(optional_uuid_mapper),
-    PlainSerializer(stringify),
+    PlainSerializer(stringify, when_used="json"),
 ]
 
 OptionalValueList = Annotated[
@@ -107,4 +118,5 @@ def deprecate(value, info):
     list[Path],
     BeforeValidator(to_path),
     BeforeValidator(to_list),
+    PlainSerializer(stringify, when_used="json"),
 ]

geoh5py/ui_json/forms.py

@@ -149,15 +149,18 @@ def flatten(self):
         """Returns the data for the form."""
         return self.value
 
-    def validate_data(self, params: dict[str, Any]):
-        """Validate the form data."""
-
     def set_value(self, value: Any):
-        """Set the form value."""
+        """
+        Set the form value.
+        """
         self.value = value
 
-        if "optional" in self.model_fields_set:
-            self.enabled = self.value is not None
+    @property
+    def is_optional(self) -> bool:
+        """
+        Whether the field is optional or not.
+        """
+        return self.optional or self.group_optional or len(self.dependency) > 0
 
 
 class StringForm(BaseForm):
@@ -472,9 +475,12 @@ class DataForm(DataFormMixin, BaseForm):
     Geoh5py uijson form for data associated with an object.
 
     Shares documented attributes with the BaseForm and DataFormMixin.
+
+    When ``multiselect`` is ``True`` the value may be a list of UUIDs; otherwise
+    a single UUID or ``None`` is expected.
     """
 
-    value: OptionalUUID
+    value: OptionalUUIDList
 
 
 class DataGroupForm(DataForm):
@@ -536,6 +542,27 @@ def to_list(cls, value: str | list[str]) -> str | list[str]:
             raise TypeError(f"'value' must be a list of strings; got '{type(value)}'")
         return value
 
+    def flatten(self) -> dict:
+        """Returns the property, data and is_complement values for the form."""
+        return {
+            "group_value": self.group_value,
+            "value": self.value,
+        }
+
+    def set_value(self, value: Any):
+        """
+        Set the form value.
+        """
+        if isinstance(value, dict):
+            for key, val in value.items():
+                setattr(self, key, val)
+
+        if isinstance(value, list | str):
+            self.value = value
+
+        if isinstance(value, UUID | None):
+            self.group_value = value
+
 
 class DataOrValueForm(DataFormMixin, BaseForm):
     """
@@ -571,20 +598,22 @@ def flatten(self) -> UUID | float | int | None:
         return self.value
 
     def set_value(self, value: Any):
-        """Set the form value."""
+        """
+        Set the form value.
+
+        Either a Numeric value or a UUID, in which case it will be assigned
+        to the `property` field and the `is_value` field will be set to False.
+        """
         try:
             self.value = value
             self.is_value = True
         except ValidationError:
-            if value is not None:
+            if value is None:
+                self.is_value = True
                 self.property = value
-                self.is_value = False
             else:
-                self.is_value = True
-                self.property = None
-
-        if "optional" in self.model_fields_set:
-            self.enabled = value is not None
+                self.property = value
+                self.is_value = False
 
 
 class MultiSelectDataForm(DataFormMixin, BaseForm):
@@ -607,20 +636,6 @@ def only_multi_select(cls, value: bool) -> bool:
             raise ValueError("MultiSelectForm must have multi_select: True.")
         return value
 
-    @field_validator("value", mode="before")
-    @classmethod
-    def to_list(cls, value: str | list[str]) -> list[str]:
-        """
-        Validate that value is a list, converting it if it's a string.
-
-        :param value: The value to validate.
-
-        :return: A list of strings representing the value.
-        """
-        if not isinstance(value, list):
-            value = [value]
-        return value
-
 
 class DataRangeForm(DataFormMixin, BaseForm):
     """
@@ -645,6 +660,28 @@ class DataRangeForm(DataFormMixin, BaseForm):
     allow_complement: bool = False
     is_complement: bool = False
 
+    def flatten(self) -> dict:
+        """Returns the property, data and is_complement values for the form."""
+        return {
+            "is_complement": self.is_complement,
+            "property": self.property,
+            "value": self.value,
+        }
+
+    def set_value(self, value: Any):
+        """
+        Set the form value.
+        """
+        if isinstance(value, dict):
+            for key, val in value.items():
+                setattr(self, key, val)
+
+        if isinstance(value, list):
+            self.value = value
+
+        if isinstance(value, UUID | None):
+            self.property = value
+
 
 def all_subclasses(type_object: type[BaseForm]) -> list[type[BaseForm]]:
     """Recursively find all subclasses of input type object."""