[WIP/ENH/CLN] Improved the pattern to deserialize properties

Author: Leguark

gempy/core/data/encoders/converters.py

@@ -17,6 +17,30 @@ def validate_numpy_array(v):
     return np.array(v) if v is not None else None
 
 
+def instantiate_if_necessary(data: dict, key: str, type: type) -> None:
+    """
+    Creates instances of the specified type for a dictionary key if the key exists and its
+    current type does not match the specified type. This function modifies the dictionary
+    in place by converting the value associated with the key into an instance of the given
+    type.
+
+    This is typically used when a dictionary contains data that needs to be represented as
+    objects of a specific class type.
+
+    Args:
+        data (dict): The dictionary containing the key-value pair to inspect and possibly
+            convert.
+        key (str): The key in the dictionary whose value should be inspected and converted
+            if necessary.
+        type (type): The type to which the value of `key` should be converted, if it is not
+            already an instance of the type.
+
+    Returns:
+        None
+    """
+    if key in data and not isinstance(data[key], type):
+        data[key] = type(**data[key])
+
 numpy_array_short_validator = BeforeValidator(validate_numpy_array)
 
 # First, create a context variable

gempy/core/data/geo_model.py

@@ -1,27 +1,26 @@
 import datetime
-
+import numpy as np
 import pprint
 import warnings
-from dataclasses import dataclass, field
-from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, computed_field, model_validator, field_validator
-from typing import Sequence, Optional
-
-import numpy as np
+from dataclasses import dataclass
+from pydantic import BaseModel, ConfigDict, Field, PrivateAttr, computed_field, model_validator, ValidationError
+from pydantic.functional_validators import ModelWrapValidatorHandler
+from typing import Sequence, Optional, Union
 
+from gempy_engine.core.data import InterpolationOptions
 from gempy_engine.core.data import Solutions
 from gempy_engine.core.data.engine_grid import EngineGrid
 from gempy_engine.core.data.geophysics_input import GeophysicsInput
-from gempy_engine.core.data.raw_arrays_solution import RawArraysSolution
-from gempy_engine.core.data import InterpolationOptions
 from gempy_engine.core.data.input_data_descriptor import InputDataDescriptor
 from gempy_engine.core.data.interpolation_input import InterpolationInput
+from gempy_engine.core.data.raw_arrays_solution import RawArraysSolution
 from gempy_engine.core.data.transforms import Transform, GlobalAnisotropy
+from .encoders.converters import instantiate_if_necessary
 from .encoders.json_geomodel_encoder import encode_numpy_array
-
+from .grid import Grid
 from .orientations import OrientationsTable
-from .surface_points import SurfacePointsTable
 from .structural_frame import StructuralFrame
-from .grid import Grid
+from .surface_points import SurfacePointsTable
 from ...modules.data_manipulation.engine_factory import interpolation_input_from_structural_frame
 
 """
@@ -66,14 +65,15 @@ class GeoModel(BaseModel):
     )
 
     meta: GeoModelMeta | None = Field(exclude=False)  #: Meta-information about the geological model, like its name, creation and modification dates, and owner.
-    
+
     # BUG: Remove None option for structural frame and meta
     structural_frame: Optional[StructuralFrame] | None = Field(exclude=False, default=None)  #: The structural information of the geological model.
-    grid: Grid  = Field(exclude=False, default=None)  #: The general grid used in the geological model.
+    grid: Grid = Field(exclude=False, default=None)  #: The general grid used in the geological model.
 
     # region GemPy engine data types
     _interpolation_options: InterpolationOptions  #: The interpolation options provided by the user.
-    # @computed_field(alias="_interpolation_options")
+
+    @computed_field(alias="_interpolation_options")
     @property
     def interpolation_options(self) -> InterpolationOptions:
         self._infer_dense_grid_solution()
@@ -94,13 +94,26 @@ def interpolation_options(self, value):
     # endregion
     _solutions: Solutions = PrivateAttr(init=False, default=None)  #: The computed solutions of the geological model. 
 
-    def __init__(self, **data):
-        super().__init__(**data)
-
-        key = "_interpolation_options"
-        if key in data and not isinstance(data[key], InterpolationOptions):
-            data[key] = InterpolationOptions(**data[key])
-        self._interpolation_options = data.get("_interpolation_options")
+    @model_validator(mode='wrap')
+    @classmethod
+    def deserialize_properties(cls, data: Union["GeoModel", dict], constructor: ModelWrapValidatorHandler["GeoModel"]) -> "GeoModel":
+        try:
+            match data:
+                case GeoModel():
+                    return data
+                case dict():
+                    instance: GeoModel = constructor(data)
+                    instantiate_if_necessary(
+                        data=data,
+                        key="_interpolation_options",
+                        type=InterpolationOptions
+                    )
+                    instance._interpolation_options = data.get("_interpolation_options")
+                    return instance
+                case _:
+                    raise ValidationError
+        except ValidationError:
+            raise
 
     @classmethod
     def from_args(cls, name: str, structural_frame: StructuralFrame, grid: Grid, interpolation_options: InterpolationOptions):

gempy/core/data/grid.py

@@ -58,15 +58,15 @@ def deserialize_properties(cls, data: Union["Grid", dict], constructor: ModelWra
                     return data
                 case dict():
                     grid: Grid = constructor(data)
-                    grid._active_grids = Grid.GridTypes(data["_active_grids"])
+                    grid._active_grids = Grid.GridTypes(data["active_grids"])
                     grid._update_values()
                     return grid
                 case _:
                     raise ValidationError
         except ValidationError:
             raise
 
-    @computed_field(alias="_active_grids")
+    @computed_field(alias="active_grids")
     @property
     def active_grids(self) -> GridTypes:
         return self._active_grids