Merge branch 'master' into feat/GEOLIB-219-Force-Pydantic-v2

Author: ArdtK

geolib/models/base_model.py

@@ -13,14 +13,12 @@
 from typing import List, Optional, Type, Union
 
 import requests
-from pydantic import DirectoryPath, FilePath, HttpUrl, conlist
+from pydantic import DirectoryPath, FilePath, HttpUrl, ValidationError, conlist
 
 from geolib._compat import IS_PYDANTIC_V2
 
 if IS_PYDANTIC_V2:
-    from pydantic import ValidationError
-else:
-    from pydantic.error_wrappers import ValidationError
+    from pydantic import SerializeAsAny
 
 from requests.auth import HTTPBasicAuth
 
@@ -37,7 +35,18 @@
 
 class BaseModel(BaseDataClass, abc.ABC):
     filename: Optional[Path] = None
-    datastructure: Optional[BaseModelStructure] = None
+    if IS_PYDANTIC_V2:
+        datastructure: Optional[SerializeAsAny[BaseModelStructure]] = None
+    else:
+        datastructure: Optional[BaseModelStructure] = None
+    """
+    This is the base class for all models in GEOLib.
+    
+    Note that `datastructure` is a `SerializeAsAny` type, which means that
+    the inheriting class is serialized according to its own definition (duck-typing).
+    This is needed since Pydantic v2 as the default behavior has changed:
+    https://docs.pydantic.dev/latest/concepts/serialization/#subclass-instances-for-fields-of-basemodel-dataclasses-typeddict
+    """
 
     def execute(self, timeout_in_seconds: int = meta.timeout) -> "BaseModel":
         """Execute a Model and wait for `timeout` seconds.

tests/models/test_base_model.py

@@ -6,6 +6,7 @@
 from fastapi.testclient import TestClient
 from teamcity import is_running_under_teamcity
 
+from geolib._compat import IS_PYDANTIC_V2
 from geolib.models import BaseDataClass, DSettlementModel
 from geolib.models.base_model import BaseModel, BaseModelList, MetaData
 from geolib.models.dfoundations.dfoundations_model import DFoundationsModel
@@ -104,6 +105,27 @@ def test_basemodellist_execute(self, model, filename, modelname):
         assert len(output.errors) == 1
         assert fn in output.errors[-1]
 
+    @pytest.mark.unittest
+    def test_serialize_modellist(self):
+        # 1. Set initial test data.
+        a = DSettlementModel(filename="a.txt")
+        b = DSettlementModel(filename="b.txt")
+        ml = BaseModelList(models=[a, b])
+
+        # 2. Define test action.
+        if IS_PYDANTIC_V2:
+            _dump = ml.model_dump()
+        else:
+            _dump = ml.dict()
+
+        # 3. Verify final expectations.
+        if IS_PYDANTIC_V2:
+            assert _dump.get("models") == [a.model_dump(), b.model_dump()]
+        else:
+            assert _dump.get("models") == [a.dict(), b.dict()]
+        for _model in _dump.get("models"):
+            assert _model["datastructure"]
+
     @pytest.mark.acceptance
     @only_teamcity
     @mock.patch("geolib.models.base_model.requests.post", side_effect=client.post)
@@ -120,7 +142,6 @@ def test_basemodellist_execute(self, model, filename, modelname):
             (DFoundationsModel, "bm1-1a.foi", "dfoundations/benchmarks"),
         ],
     )
-    @pytest.mark.skip(reason="Failing after pydantic 2 update. Cause of failure should be investigated in more detail.")
     def test_basemodellist_execute_remote(self, _, __, model, filename, modelname):
         # Setup models
         a = model()
@@ -170,6 +191,7 @@ def test_basemodel_execute_remote(self, _, __, model, filename, modelname):
         model = modelinstance.execute_remote("/")  # no url is needed with the TestClient
         assert model.output
 
+
 class TestBool:
     @pytest.mark.unittest
     def test_init(self):