Merge pull request #51 from asfadmin/bbarton/PR-7400

Implement horizontal_spatial_domain factory

Author: benbart

mandible/umm_classes/factory.py

@@ -8,6 +8,7 @@
     ArchiveAndDistributionInformation,
     CollectionReference,
     DataGranule,
+    Geometry,
     HorizontalSpatialDomain,
     Identifier,
     Instrument,
@@ -58,6 +59,32 @@ def data_granule(
     return obj
 
 
+def horizontal_spatial_domain(
+    zone_identifier: Optional[str] = None,
+    geometry: Optional[Geometry] = None,
+    # TODO(reweeden): Implement typing
+    orbit: Optional[dict[str, Any]] = None,
+    # TODO(reweeden): Implement typing
+    track: Optional[dict[str, Any]] = None,
+) -> HorizontalSpatialDomain:
+    obj: HorizontalSpatialDomain = {}
+    if zone_identifier is not None:
+        obj["ZoneIdentifier"] = zone_identifier
+    if geometry is not None:
+        obj["Geometry"] = geometry
+    if orbit is not None:
+        obj["Orbit"] = orbit
+    if track is not None:
+        obj["Track"] = track
+
+    if orbit is None and track is None:
+        raise ValueError(
+            "one of 'orbit' or 'track' is required",
+        )
+
+    return obj
+
+
 def identifier(
     type: str,
     identifier: str,

mandible/umm_classes/types.py

@@ -183,8 +183,7 @@ class HorizontalSpatialDomain(TypedDict):
     https://git.earthdata.nasa.gov/projects/EMFD/repos/unified-metadata-model/browse/granule/v1.6.5/umm-g-json-schema.json#497
     """
 
-    # TODO(reweeden): Implement
-    ZoneIdentifier: NotRequired[dict[str, Any]]
+    ZoneIdentifier: NotRequired[str]
     Geometry: NotRequired[Geometry]
     # TODO(reweeden): Implement
     Orbit: NotRequired[dict[str, Any]]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mandible"
-version = "0.10.3"
+version = "0.10.4"
 description = "A generic framework for writing satellite data ingest systems"
 authors = ["Rohan Weeden <reweeden@alaska.edu>", "Matt Perry <mperry37@alaska.edu>"]
 license = "APACHE-2"