Skip to content

Make sure that VersionRange has VersionIDs rather than strings #1512

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.

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
merged 2 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

### Fixed

- Make sure that `VersionRange` has `VersionID`s rather than strings ([#1512](https://github.com/stac-utils/pystac/pull/1512))

## [v1.12.1]

### Changed
Expand Down
38 changes: 31 additions & 7 deletions pystac/serialization/identify.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@
class STACVersionRange:
"""Defines a range of STAC versions."""

min_version: STACVersionID
max_version: STACVersionID
_min_version: STACVersionID
_max_version: STACVersionID

def __init__(
self,
Expand All @@ -103,21 +103,45 @@
else:
self.max_version = max_version

def set_min(self, v: STACVersionID) -> None:
@property
def min_version(self) -> STACVersionID:
return self._min_version

@min_version.setter
def min_version(self, v: str | STACVersionID) -> None:
if isinstance(v, str):
v = STACVersionID(v)
self._min_version = v

@property
def max_version(self) -> STACVersionID:
return self._max_version

@max_version.setter
def max_version(self, v: str | STACVersionID) -> None:
if isinstance(v, str):
v = STACVersionID(v)
self._max_version = v

def set_min(self, v: str | STACVersionID) -> None:
if isinstance(v, str):
v = STACVersionID(v)
if self.min_version < v:
if v < self.max_version:
self.min_version = v
else:
self.min_version = self.max_version

def set_max(self, v: STACVersionID) -> None:
def set_max(self, v: str | STACVersionID) -> None:
if isinstance(v, str):
v = STACVersionID(v)
if v < self.max_version:
if self.min_version < v:
self.max_version = v
else:
self.max_version = self.min_version

def set_to_single(self, v: STACVersionID) -> None:
def set_to_single(self, v: str | STACVersionID) -> None:
self.set_min(v)
self.set_max(v)

Expand Down Expand Up @@ -263,12 +287,12 @@
stac_extensions = json_dict.get("stac_extensions", None)

if stac_version is None:
version_range.set_min(STACVersionID("0.8.0"))
version_range.set_min("0.8.0")

Check warning on line 290 in pystac/serialization/identify.py

View check run for this annotation

Codecov / codecov/patch

pystac/serialization/identify.py#L290

Added line #L290 was not covered by tests
else:
version_range.set_to_single(stac_version)

if stac_extensions is not None:
version_range.set_min(STACVersionID("0.8.0"))
version_range.set_min("0.8.0")

if stac_extensions is None:
stac_extensions = []
Expand Down
15 changes: 15 additions & 0 deletions tests/extensions/test_eo.py
Original file line number Diff line number Diff line change
Expand Up @@ -516,3 +516,18 @@ def test_required_property_missing(ext_item: pystac.Item) -> None:
assert bands is not None
with pytest.raises(RequiredPropertyMissing):
bands[0].name


def test_unnecessary_migrations_not_performed(ext_item: Item) -> None:
item_as_dict = ext_item.to_dict(include_self_link=False, transform_hrefs=False)
item_as_dict["stac_version"] = "1.0.0"
item_as_dict["properties"]["eo:bands"] = [{"name": "B1", "common_name": "coastal"}]

item = Item.from_dict(item_as_dict)

migrated_item = pystac.Item.from_dict(item_as_dict, migrate=True)

assert item.properties == migrated_item.properties
assert len(item.assets) == len(migrated_item.assets)
for key, value in item.assets.items():
assert value.to_dict() == migrated_item.assets[key].to_dict()
14 changes: 14 additions & 0 deletions tests/serialization/test_identify.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,17 @@ def test_version_range_ordering(self) -> None:

version_range = STACVersionRange(min_version="0.6.0-rc1", max_version="0.9.0")
self.assertTrue(version_range.contains("0.9.0"))

def test_version_range_set_to_single(self) -> None:
version_range = STACVersionRange()
version_range.set_min("1.0.0-beta.1")
version_range.set_to_single("1.0.0")

self.assertTrue(version_range.contains("1.0.0"))

def test_version_range_set_min_and_max_directly(self) -> None:
version_range = STACVersionRange()
version_range.min_version = "1.0.0-beta.1" # type:ignore
version_range.max_version = "1.1.0" # type:ignore
Copy link
Member Author

Choose a reason for hiding this comment

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

Mypy hates this type of coersion apparently. python/mypy#3004 although that got closed in the last few days so maybe we can delete these ignore statements someday?

Copy link
Member

Choose a reason for hiding this comment

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

Yup, and since they're in tests I'm not too worried about adding them now.


self.assertTrue(version_range.contains("1.0.0"))
Loading