Validate domains for area_of_interest

Author: VeckoTheGecko

src/virtualship/expedition/area_of_interest.py

@@ -1,31 +1,51 @@
 """AreaOfInterest class."""
 
-from dataclasses import dataclass
 from datetime import datetime
+from typing import Annotated
 
+from pydantic import BaseModel, Field, model_validator
+from typing_extensions import Self
 
-@dataclass
-class SpatialRange:
-    """Defines the geographic boundaries for an area of interest."""
+Longitude = Annotated[float, Field(..., ge=-180, le=180)]
+Latitude = Annotated[float, Field(..., ge=-90, le=90)]
+Depth = float  # TODO: insert a minimum depth here? e.g., `Annotated[float, Field(..., ge=0)]`
 
-    minimum_longitude: float
-    maximum_longitude: float
-    minimum_latitude: float
-    maximum_latitude: float
-    minimum_depth: float
-    maximum_depth: float
 
+class SpatialRange(BaseModel):
+    """Defines the geographic boundaries for an area of interest."""
 
-@dataclass
-class TimeRange:
+    minimum_longitude: Longitude
+    maximum_longitude: Longitude
+    minimum_latitude: Latitude
+    maximum_latitude: Latitude
+    minimum_depth: Depth
+    maximum_depth: Depth
+
+    @model_validator(mode="after")
+    def _check_spatial_domain(self) -> Self:
+        if not self.minimum_longitude < self.maximum_longitude:
+            raise ValueError("minimum_longitude must be less than maximum_longitude")
+        if not self.minimum_latitude < self.maximum_latitude:
+            raise ValueError("minimum_latitude must be less than maximum_latitude")
+        if not self.minimum_depth < self.maximum_depth:
+            raise ValueError("minimum_depth must be less than maximum_depth")
+        return self
+
+
+class TimeRange(BaseModel):
     """Defines the temporal boundaries for an area of interest."""
 
     start_time: datetime
     end_time: datetime
 
+    @model_validator(mode="after")
+    def _check_time_range(self) -> Self:
+        if not self.start_time < self.end_time:
+            raise ValueError("start_time must be before end_time")
+        return self
+
 
-@dataclass
-class AreaOfInterest:
+class AreaOfInterest(BaseModel):
     """An area of interest with spatial and temporal boundaries."""
 
     spatial_range: SpatialRange