Skip to content

Implement horizontal_spatial_domain factory #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benbart merged 3 commits into from
Apr 21, 2026
Merged

Implement horizontal_spatial_domain factory #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d290d85
Implement horizontal_spatial_domain factory
benbart Apr 21, 2026
89062b3
Update mandible/umm_classes/factory.py
benbart Apr 21, 2026
c26b180
Remove whitespace
benbart Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions mandible/umm_classes/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
ArchiveAndDistributionInformation,
CollectionReference,
DataGranule,
Geometry,
HorizontalSpatialDomain,
Identifier,
Instrument,
Expand Down Expand Up @@ -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

@reweeden reweeden Apr 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason to hold off on adding the orbit and track params and adding the oneOf validation? As it stands now this factory function can produce an empty dict which is invalid as far as the jsonschema goes. I would say if you're not going to add orbit then at least I'd make geometry required / raise a ValueError if geometry is not provided. But I think it would be just cleaner to implement the whole thing, it should be an additional like 10 lines of code.

Comment on lines +62 to +85

@reweeden reweeden Apr 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also keep the params in the order they are defined in the schema and build the resulting dict in that order when possible, and in this case it is! And I'd keep the formatting consistent with the implementations (empty line before the return statement).

All said and done if I was doing this PR I would commit this:

Suggested change
def horizontal_spatial_domain(
geometry: Optional[Geometry] = None,
zone_identifier: Optional[str] = None,
) -> HorizontalSpatialDomain:
obj: HorizontalSpatialDomain = {}
if geometry is not None:
obj["Geometry"] = geometry
if zone_identifier is not None:
obj["ZoneIdentifier"] = zone_identifier
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,
Expand Down
3 changes: 1 addition & 2 deletions mandible/umm_classes/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
Loading