Add BBox Validation to the Type.

Author: eseglem

geojson_pydantic/features.py

@@ -22,28 +22,6 @@ class Feature(GenericModel, Generic[Geom, Props], GeoInterfaceMixin):
     id: Optional[Union[StrictInt, StrictStr]] = None
     bbox: Optional[BBox] = None
 
-    class Config:
-        """Model configuration."""
-
-        use_enum_values = True
-
-    @validator("bbox", pre=True)
-    def check_bbox(cls, bbox: BBox) -> BBox:
-        """Check that bbox is valid."""
-        if len(bbox) == 6:
-            if bbox[0] > bbox[3] or bbox[1] > bbox[4] or bbox[2] > bbox[5]:  # type: ignore
-                raise ValueError(
-                    "BBox must be in the form [west, south, bottom, east, north, top]"
-                )
-        elif len(bbox) == 4:
-            if bbox[0] > bbox[2] or bbox[1] > bbox[3]:
-                raise ValueError("BBox must be in the form [west, south, east, north]")
-        else:
-            raise ValueError(
-                "BBox must be in the form [west, south, east, north] or [west, south, bottom, east, north, top]"
-            )
-        return bbox
-
     @validator("geometry", pre=True, always=True)
     def set_geometry(cls, geometry: Any) -> Any:
         """set geometry from geo interface or input"""

geojson_pydantic/types.py

@@ -1,13 +1,63 @@
 """Types for geojson_pydantic models"""
 
-from typing import TYPE_CHECKING, List, Tuple, Union
+from typing import TYPE_CHECKING, Any, Callable, Generator, List, Tuple, Union
 
-from pydantic import conlist
+from pydantic import ConstrainedList, conlist
 
-BBox = Union[
-    Tuple[float, float, float, float],  # 2D bbox
-    Tuple[float, float, float, float, float, float],  # 3D bbox
-]
+
+class _BBoxBase(ConstrainedList):
+    """Base Class with additional Validation for order."""
+
+    # This is needed because pydantic checks it rather than `item_type`
+    __args__ = (float,)
+
+    item_type = float
+
+    @classmethod
+    def __get_validators__(cls) -> Generator[Callable[..., Any], None, None]:
+        """Yield the validators."""
+        yield from super().__get_validators__()
+        yield cls.validate_bbox
+
+    @classmethod
+    def validate_bbox(cls, bbox: List[float]) -> List[float]:
+        """Validate BBox values are ordered correctly."""
+        if not bbox:
+            return bbox
+
+        offset = len(bbox) // 2
+        errors: List[str] = []
+        # Check X
+        if bbox[0] > bbox[offset]:
+            errors.append(f"Min X ({bbox[0]}) must be <= Max X ({bbox[offset]}).")
+        # Check Y
+        if bbox[1] > bbox[1 + offset]:
+            errors.append(f"Min Y ({bbox[1]}) must be <= Max Y ({bbox[1 + offset]}).")
+        # If 3D, check Z values.
+        if offset > 2 and bbox[2] > bbox[2 + offset]:
+            errors.append(f"Min Z ({bbox[2]}) must be <= Max Z ({bbox[2 + offset]}).")
+
+        if errors:
+            raise ValueError("Invalid BBox. Error(s): " + " ".join(errors))
+
+        return bbox
+
+
+class BBox2D(_BBoxBase):
+    """2D Bounding Box"""
+
+    min_items = 4
+    max_items = 4
+
+
+class BBox3D(_BBoxBase):
+    """3D Bounding Box"""
+
+    min_items = 6
+    max_items = 6
+
+
+BBox = Union[BBox3D, BBox2D]
 Position = Union[Tuple[float, float], Tuple[float, float, float]]
 
 # Coordinate arrays