Adopt a common validate_type method across all the models

Author: francbartoli

pygeoapi/models/config.py

@@ -33,6 +33,8 @@
 from dataclasses import dataclass, fields, asdict
 from typing import Any, Dict
 
+from pygeoapi.models.validation import validate_type
+
 
 SEMVER_PATTERN = re.compile(r'^\d+\.\d+\..+$')
 
@@ -74,31 +76,15 @@ class APIRules:
     strict_slashes: bool = False
 
     def __post_init__(self):
-        if not isinstance(self.api_version, str):
-            raise APIRulesValidationError(
-                "api_version must be a string, "
-                f"got {type(self.api_version).__name__}"
-            )
+        try:
+            validate_type(self)
+        except ValueError as e:
+            raise APIRulesValidationError(str(e)) from e
         if not SEMVER_PATTERN.match(self.api_version):
             raise APIRulesValidationError(
                 f"Invalid semantic version: '{self.api_version}'. "
                 f"Expected format: MAJOR.MINOR.PATCH"
             )
-        if not isinstance(self.url_prefix, str):
-            raise APIRulesValidationError(
-                "url_prefix must be a string, "
-                f"got {type(self.url_prefix).__name__}"
-            )
-        if not isinstance(self.version_header, str):
-            raise APIRulesValidationError(
-                "version_header must be a string, "
-                f"got {type(self.version_header).__name__}"
-            )
-        if not isinstance(self.strict_slashes, bool):
-            raise APIRulesValidationError(
-                "strict_slashes must be a bool, "
-                f"got {type(self.strict_slashes).__name__}"
-            )
 
     @classmethod
     def create(cls, **rules_config) -> 'APIRules':

pygeoapi/models/openapi.py

@@ -31,6 +31,8 @@
 from enum import Enum
 from typing import Any, Dict
 
+from pygeoapi.models.validation import validate_type
+
 
 class SupportedFormats(Enum):
     JSON = 'json'
@@ -51,8 +53,7 @@ class OAPIFormat:
     root: SupportedFormats = SupportedFormats.YAML
 
     def __post_init__(self):
-        if isinstance(self.root, SupportedFormats):
-            return
+        # Coerce str to enum before type validation
         if isinstance(self.root, str):
             try:
                 self.root = SupportedFormats(self.root)
@@ -62,11 +63,7 @@ def __post_init__(self):
                     f"Must be one of: "
                     f"{[f.value for f in SupportedFormats]}"
                 )
-        else:
-            raise ValueError(
-                f"root must be a string or SupportedFormats, "
-                f"got {type(self.root).__name__}"
-            )
+        validate_type(self)
 
     def __eq__(self, other):
         if isinstance(other, str):

pygeoapi/models/provider/base.py

@@ -31,90 +31,19 @@
 #
 # =================================================================
 
-from dataclasses import dataclass, field, fields as dc_fields
+from dataclasses import dataclass, field
 from datetime import datetime
 from enum import Enum
 import json
 from pathlib import Path
-from typing import Any, Dict, List, Optional, get_type_hints
+from typing import Any, Dict, List, Optional
 
+from pygeoapi.models.validation import validate_type
 from pygeoapi.util import DEFINITIONSDIR
 
 TMS_DIR = DEFINITIONSDIR / 'tiles'
 
 
-def _validate_type(dc_instance: Any) -> None:
-    """
-    Validate field types on a dataclass instance.
-
-    Checks each field value against its declared type,
-    matching dataclass runtime type.
-    Supports Optional[T], List[T], and plain types.
-
-    :param dc_instance: dataclass instance to validate
-
-    :raises ValueError: if a field value has the wrong type
-    """
-    hints = get_type_hints(dc_instance.__class__)
-    for f in dc_fields(dc_instance):
-        value = getattr(dc_instance, f.name)
-        expected = hints[f.name]
-
-        # Extract inner type from Optional[T]
-        origin = getattr(expected, '__origin__', None)
-        args = getattr(expected, '__args__', ())
-
-        is_optional = (
-            origin is type(None)  # noqa: E721
-            or (origin is not None
-                and type(None) in args)
-        )
-
-        if is_optional and value is None:
-            continue
-
-        # Unwrap Optional to get the inner type
-        if is_optional and args:
-            inner_types = [
-                a for a in args if a is not type(None)
-            ]
-            if len(inner_types) == 1:
-                expected = inner_types[0]
-                origin = getattr(expected, '__origin__', None)
-                args = getattr(expected, '__args__', ())
-
-        # Check List[T]
-        if origin is list:
-            if not isinstance(value, list):
-                raise ValueError(
-                    f"{f.name} must be a list, "
-                    f"got {type(value).__name__}"
-                )
-        # Check plain types (str, int, float, bool, Enum)
-        elif origin is None:
-            if isinstance(expected, type):
-                # bool is subclass of int, check bool first
-                if expected is bool:
-                    if not isinstance(value, bool):
-                        raise ValueError(
-                            f"{f.name} must be a bool, "
-                            f"got {type(value).__name__}"
-                        )
-                elif expected is int:
-                    if isinstance(value, bool) \
-                            or not isinstance(value, int):
-                        raise ValueError(
-                            f"{f.name} must be an int, "
-                            f"got {type(value).__name__}"
-                        )
-                elif not isinstance(value, expected):
-                    raise ValueError(
-                        f"{f.name} must be a "
-                        f"{expected.__name__}, "
-                        f"got {type(value).__name__}"
-                    )
-
-
 class TilesMetadataFormat(str, Enum):
     # Tile Set Metadata
     JSON = "JSON"
@@ -160,7 +89,7 @@ class TileMatrixSetEnumType:
     tileMatrices: List[dict] = field(default_factory=list)
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -244,7 +173,7 @@ class TileMatrixLimitsType:
     maxTileCol: int = 0
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -274,7 +203,7 @@ class TwoDBoundingBoxType:
     crs: Optional[str] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -305,7 +234,7 @@ class LinkType:
     length: Optional[int] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -351,7 +280,7 @@ class GeospatialDataType:
     propertiesSchema: Optional[dict] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -383,7 +312,7 @@ class StyleType:
     links: Optional[LinkType] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -413,7 +342,7 @@ class TilePointType:
     tileMatrix: str = ''
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -463,7 +392,7 @@ class TileSetMetadata:
     links: Optional[List[LinkType]] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False

pygeoapi/models/provider/mvt.py

@@ -29,10 +29,10 @@
 #
 # =================================================================
 
-from dataclasses import dataclass
+from dataclasses import dataclass, fields as dc_fields
 from typing import Any, Dict, List, Optional
 
-from pygeoapi.models.provider.base import _validate_type
+from pygeoapi.models.validation import validate_type
 
 
 @dataclass
@@ -46,7 +46,7 @@ class VectorLayers:
     fields: Optional[dict] = None
 
     def __post_init__(self):
-        _validate_type(self)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False
@@ -63,7 +63,12 @@ def model_dump(
 
 @dataclass
 class MVTTilesJson:
-    """TileJSON 3.0 specification."""
+    """TileJSON 3.0 specification.
+
+    Accepts and silently ignores unknown kwargs to match
+    the validation behaviour when instantiated from arbitrary
+    JSON metadata dicts (e.g. ``MVTTilesJson(**json_data)``).
+    """
 
     tilejson: str = "3.0.0"
     name: Optional[str] = None
@@ -76,8 +81,19 @@ class MVTTilesJson:
     description: Optional[str] = None
     vector_layers: Optional[List[VectorLayers]] = None
 
-    def __post_init__(self):
-        _validate_type(self)
+    def __init__(self, **kwargs):
+        for f in dc_fields(self):
+            value = kwargs.get(f.name, getattr(self, f.name))
+            # Coerce str to int for Optional[int] fields
+            if (value is not None
+                    and isinstance(value, str)
+                    and 'int' in str(f.type)):
+                try:
+                    value = int(value)
+                except (ValueError, TypeError):
+                    pass
+            setattr(self, f.name, value)
+        validate_type(self)
 
     def model_dump(
         self, exclude_none: bool = False