Add Version checks to all relevant models.

hydrolib/core/io/bc/models.py

@@ -12,6 +12,7 @@
 from hydrolib.core.io.ini.parser import Parser, ParserConfig
 from hydrolib.core.io.ini.serializer import SerializerConfig, write_ini
 from hydrolib.core.io.ini.util import get_enum_validator, get_from_subclass_defaults
+from hydrolib.core.utils import FMVersion
 
 logger = logging.getLogger(__name__)
 
@@ -196,7 +197,7 @@ class Constant(ForcingBase):
 
 
 class ForcingGeneral(INIGeneral):
-    fileversion: str = Field("1.01", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("1.1.0"), alias="fileVersion")
     filetype: Literal["boundConds"] = Field("boundConds", alias="fileType")
 
 

hydrolib/core/io/crosssection/models.py

@@ -11,6 +11,7 @@
     make_list_length_root_validator,
     make_list_validator,
 )
+from hydrolib.core.utils import FMVersion
 
 logger = logging.getLogger(__name__)
 
@@ -30,14 +31,14 @@
 class CrossDefGeneral(INIGeneral):
     """The crosssection definition file's `[General]` section with file meta data."""
 
-    fileversion: str = Field("3.00", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("3.0.0"), alias="fileVersion")
     filetype: Literal["crossDef"] = Field("crossDef", alias="fileType")
 
 
 class CrossLocGeneral(INIGeneral):
     """The crosssection location file's `[General]` section with file meta data."""
 
-    fileversion: str = Field("3.00", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("1.1.0"), alias="fileVersion")
     filetype: Literal["crossLoc"] = Field("crossLoc", alias="fileType")
 
 

hydrolib/core/io/dimr/models.py

@@ -4,14 +4,15 @@
 from typing import Callable, List, Literal, Optional, Type, Union
 
 from pydantic import Field, validator
+from semantic_version import Version as SemVersion
 
 from hydrolib.core import __version__
 from hydrolib.core.basemodel import BaseModel, FileModel
 from hydrolib.core.io.dimr.parser import DIMRParser
 from hydrolib.core.io.dimr.serializer import DIMRSerializer
 from hydrolib.core.io.fnm.models import RainfallRunoffModel
 from hydrolib.core.io.mdu.models import FMModel
-from hydrolib.core.utils import to_list
+from hydrolib.core.utils import DIMRVersion, get_version_validator, to_list
 
 
 class KeyValuePair(BaseModel):
@@ -103,10 +104,14 @@ class Documentation(BaseModel):
         creationDate: The creation date of the DIMR file.
     """
 
-    fileVersion: str = "1.3"
+    fileVersion: DIMRVersion = DIMRVersion.coerce("1.2")
     createdBy: str = f"hydrolib-core {__version__}"
     creationDate: datetime = Field(default_factory=datetime.utcnow)
 
+    _version_validator = get_version_validator(
+        "fileVersion",
+    )
+
 
 class GlobalSettings(BaseModel):
     """

hydrolib/core/io/ext/models.py

@@ -10,7 +10,7 @@
     get_split_string_on_delimiter_validator,
     make_list_validator,
 )
-from hydrolib.core.utils import str_is_empty_or_none
+from hydrolib.core.utils import FMVersion, str_is_empty_or_none
 
 
 class Boundary(INIBasedModel):
@@ -234,7 +234,7 @@ class ExtGeneral(INIGeneral):
     """The external forcing file's `[General]` section with file meta data."""
 
     _header: Literal["General"] = "General"
-    fileversion: str = Field("2.01", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("2.1.0"), alias="fileVersion")
     filetype: Literal["extForce"] = Field("extForce", alias="fileType")
 
 

hydrolib/core/io/friction/models.py

@@ -7,6 +7,7 @@
 
 from hydrolib.core.io.ini.models import INIBasedModel, INIGeneral, INIModel
 from hydrolib.core.io.ini.util import get_split_string_on_delimiter_validator
+from hydrolib.core.utils import FMVersion
 
 from ..ini.util import make_list_validator
 
@@ -32,7 +33,7 @@ class Comments(INIBasedModel.Comments):
 
     comments: Comments = Comments()
     _header: Literal["General"] = "General"
-    fileversion: str = Field("3.01", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("3.0.0"), alias="fileVersion")
     filetype: Literal["roughness"] = Field("roughness", alias="fileType")
     frictionvaluesfile: Optional[Path] = Field(alias="frictionValuesFile")
 

hydrolib/core/io/ini/models.py

@@ -7,6 +7,7 @@
 
 from hydrolib.core import __version__ as version
 from hydrolib.core.basemodel import BaseModel, FileModel
+from hydrolib.core.utils import FMVersion, get_version_validator
 
 from .io_models import CommentBlock, Document, Property, Section
 from .parser import Parser
@@ -33,7 +34,6 @@ class INIBasedModel(BaseModel, ABC):
 
     class Config:
         extra = Extra.allow
-        arbitrary_types_allowed = False
 
     @classmethod
     def _supports_comments(cls):
@@ -137,9 +137,13 @@ def _to_section(self) -> Section:
 
 class INIGeneral(INIBasedModel):
     _header: Literal["General"] = "General"
-    fileversion: str = Field("3.00", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("3.0.0"), alias="fileVersion")
     filetype: str = Field(alias="fileType")
 
+    _version_validator = get_version_validator(
+        "fileversion",
+    )
+
     @classmethod
     def _supports_comments(cls):
         return True

hydrolib/core/io/mdu/models.py

@@ -12,14 +12,15 @@
 from hydrolib.core.io.polyfile.models import PolyFile
 from hydrolib.core.io.structure.models import StructureModel
 from hydrolib.core.io.xyz.models import XYZModel
+from hydrolib.core.utils import FMVersion
 
 
 class General(INIGeneral):
     _header: Literal["General"] = "General"
     program: str = Field("D-Flow FM", alias="program")
     version: str = Field("1.2.94.66079M", alias="version")
     filetype: Literal["modelDef"] = Field("modelDef", alias="fileType")
-    fileversion: str = Field("1.09", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("1.9.0"), alias="fileVersion")
     autostart: bool = Field(False, alias="autoStart")
     pathsrelativetoparent: bool = Field(False, alias="pathsRelativeToParent")
 

hydrolib/core/io/structure/models.py

@@ -19,7 +19,7 @@
     get_from_subclass_defaults,
     get_split_string_on_delimiter_validator,
 )
-from hydrolib.core.utils import str_is_empty_or_none
+from hydrolib.core.utils import FMVersion, str_is_empty_or_none
 
 logger = logging.getLogger(__name__)
 
@@ -855,7 +855,7 @@ class StructureGeneral(INIGeneral):
     """`[General]` section with structure file metadata."""
 
     _header: Literal["General"] = "General"
-    fileversion: str = Field("3.00", alias="fileVersion")
+    fileversion: FMVersion = Field(FMVersion("2.0.0"), alias="fileVersion")
     filetype: Literal["structure"] = Field("structure", alias="fileType")
 
 

hydrolib/core/utils.py

@@ -1,5 +1,8 @@
 from typing import Any, List, Optional
 
+from pydantic import Field, validator
+from semantic_version import Version as SemVer
+
 
 def example(a: float, b: float = 1.0) -> float:
     """[summary]
@@ -69,3 +72,55 @@ def get_substring_between(source: str, start: str, end: str) -> Optional[str]:
         return None
 
     return source[index_start:index_end]
+
+
+class HVersion(SemVer):
+    @classmethod
+    def coerce(cls, *args, **kwargs):
+        version = super().coerce(*args, **kwargs)
+        return cls(**version.__dict__)
+
+
+class FMVersion(HVersion):
+    def __str__(self) -> str:
+        """Add zero to minor version if it is less than 10."""
+        version = f"{self.major}"
+        if self.minor is not None:
+            version = f"{version}.{self.minor:02d}"
+
+        return version
+
+
+class DIMRVersion(HVersion):
+    def __str__(self) -> str:
+        """Strip patch version."""
+        version = f"{self.major}"
+        if self.minor is not None:
+            version = f"{version}.{self.minor}"
+
+        return version
+
+
+def get_version_validator(*field_name: str):
+    """Get a validator to check the Version number."""
+
+    def check_version(cls, v: Any, field: Field):
+        """Validate (semantic) version numbers."""
+
+        if isinstance(v, str):
+            version = field.default.__class__.coerce(v)
+        elif isinstance(v, (FMVersion, DIMRVersion)):
+            version = v
+        elif v is None:
+            return field.default
+        else:
+            raise ValueError(f"Invalid version specified: {v}")
+
+        if version < field.default or version >= field.default.next_major():
+            raise ValueError(
+                f"Input with version {v} isn't a version support by HYDROLIB-core, which supports >={field.default}"
+            )
+
+        return version
+
+    return validator(*field_name, allow_reuse=True, pre=True)(check_version)

pyproject.toml

@@ -14,6 +14,7 @@ numpy = "^1.21"
 pydantic = {extras = ["dotenv"], version = "^1.8"}
 lxml = "^4.6"
 meshkernel = "^1.0.0"
+semantic-version = "^2.8.5"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2"

tests/data/reference/dimr/test_serialize.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <dimrConfig xmlns="http://schemas.deltares.nl/dimr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.deltares.nl/dimr http://content.oss.deltares.nl/schemas/dimr-1.3.xsd">
   <documentation>
-    <fileVersion>1.3</fileVersion>
+    <fileVersion>1.2</fileVersion>
     <createdBy>hydrolib-core 0.1.5</createdBy>
     <creationDate>2020-03-17T10:02:49.4520672Z</creationDate>
   </documentation>

tests/data/reference/model/test_dimr_model_save.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <dimrConfig xmlns="http://schemas.deltares.nl/dimr" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.deltares.nl/dimr http://content.oss.deltares.nl/schemas/dimr-1.3.xsd">
   <documentation>
-    <fileVersion>1.3</fileVersion>
+    <fileVersion>1.2</fileVersion>
     <createdBy>hydrolib-core 0.1.5</createdBy>
     <creationDate>2021-07-29 12:45:00</creationDate>
   </documentation>

tests/io/test_dimr.py

@@ -25,7 +25,7 @@ def test_parse_returns_correct_data():
     result = DIMRParser.parse(test_file)
 
     documentation = result["documentation"]
-    assert documentation["fileVersion"] == "1.2"
+    assert str(documentation["fileVersion"]) == "1.2"
     assert documentation["createdBy"] == "Deltares, Coupling Team"
     assert documentation["creationDate"] == "2020-03-17T10:02:49.4520672Z"
 
@@ -75,7 +75,7 @@ def test_serialize():
 
     data = {
         "documentation": {
-            "fileVersion": "1.3",
+            "fileVersion": "1.2",
             "createdBy": f"hydrolib-core {__version__}",
             "creationDate": "2020-03-17T10:02:49.4520672Z",
         },