Merge pull request #264 from volaya/summaries

Added support for summaries

Author: Jon Duckworth

CHANGELOG.md

@@ -8,6 +8,7 @@
 - solar_illumination field in eo extension ([#356](https://github.com/stac-utils/pystac/issues/356))
 - Added `Link.canonical` static method for creating links with "canonical" rel type ([#351](https://github.com/stac-utils/pystac/pull/351))
 - Added `RelType` enum containing common `rel` values ([#351](https://github.com/stac-utils/pystac/pull/351))
+- Added support for summaries ([#264](https://github.com/stac-utils/pystac/pull/264))
 
 ### Changed
 

pystac/__init__.py

@@ -31,8 +31,8 @@
     TemporalExtent,  # type:ignore
     Provider,  # type:ignore
     Summaries,  # type:ignore
-    RangeSummary,  # type:ignore
 )
+from pystac.summaries import RangeSummary  # type:ignore
 from pystac.item import Item, Asset, CommonMetadata  # type:ignore
 
 import pystac.validation

pystac/collection.py

@@ -3,13 +3,11 @@
 from typing import (
     Any,
     Dict,
-    Generic,
     Iterable,
     List,
     Optional,
     TYPE_CHECKING,
     Tuple,
-    Type,
     TypeVar,
     Union,
     cast,
@@ -24,7 +22,8 @@
 from pystac.catalog import Catalog
 from pystac.layout import HrefLayoutStrategy
 from pystac.link import Link
-from pystac.utils import datetime_to_str, get_required
+from pystac.utils import datetime_to_str
+from pystac.summaries import Summaries
 
 if TYPE_CHECKING:
     from pystac.item import Item as Item_Type
@@ -422,85 +421,6 @@ def from_dict(d: Dict[str, Any]) -> "Provider":
         )
 
 
-class RangeSummary(Generic[T]):
-    def __init__(self, minimum: T, maximum: T):
-        self.minimum = minimum
-        self.maximum = maximum
-
-    def to_dict(self) -> Dict[str, Any]:
-        return {"minimum": self.minimum, "maximum": self.maximum}
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> "RangeSummary[T]":
-        minimum: T = get_required(d.get("minimum"), "RangeSummary", "minimum")
-        maximum: T = get_required(d.get("maximum"), "RangeSummary", "maximum")
-        return cls(minimum=minimum, maximum=maximum)
-
-
-class Summaries:
-    def __init__(self, summaries: Dict[str, Any]) -> None:
-        self._summaries = summaries
-
-        self.lists: Dict[str, List[Any]] = {}
-        self.ranges: Dict[str, RangeSummary[Any]] = {}
-        self.schemas: Dict[str, Dict[str, Any]] = {}
-        self.other: Dict[str, Any] = {}
-
-        for prop_key, summary in summaries.items():
-            self.add(prop_key, summary)
-
-    def get_list(self, prop: str, typ: Type[T]) -> Optional[List[T]]:
-        return self.lists.get(prop)
-
-    def get_range(self, prop: str, typ: Type[T]) -> Optional[RangeSummary[T]]:
-        return self.ranges.get(prop)
-
-    def get_schema(self, prop: str) -> Optional[Dict[str, Any]]:
-        return self.schemas.get(prop)
-
-    def add(
-        self,
-        prop_key: str,
-        summary: Union[List[Any], RangeSummary[Any], Dict[str, Any]],
-    ) -> None:
-        if isinstance(summary, list):
-            self.lists[prop_key] = summary
-        elif isinstance(summary, dict):
-            if "minimum" in summary:
-                self.ranges[prop_key] = RangeSummary[Any].from_dict(
-                    cast(Dict[str, Any], summary)
-                )
-            else:
-                self.schemas[prop_key] = summary
-        elif isinstance(summary, RangeSummary):
-            self.ranges[prop_key] = summary
-        else:
-            self.other[prop_key] = summary
-
-    def remove(self, prop_key: str) -> None:
-        self.lists.pop(prop_key, None)
-        self.ranges.pop(prop_key, None)
-        self.schemas.pop(prop_key, None)
-        self.other.pop(prop_key, None)
-
-    def is_empty(self) -> bool:
-        return not (
-            any(self.lists) or any(self.ranges) or any(self.schemas) or any(self.other)
-        )
-
-    def to_dict(self) -> Dict[str, Any]:
-        return {
-            **self.lists,
-            **{k: v.to_dict() for k, v in self.ranges.items()},
-            **self.schemas,
-            **self.other,
-        }
-
-    @classmethod
-    def empty(cls) -> "Summaries":
-        return Summaries({})
-
-
 class Collection(Catalog):
     """A Collection extends the Catalog spec with additional metadata that helps
     enable discovery.

pystac/extensions/eo.py

@@ -18,7 +18,7 @@
 )
 
 import pystac
-from pystac.collection import RangeSummary
+from pystac.summaries import RangeSummary
 from pystac.extensions.base import (
     ExtensionManagementMixin,
     PropertiesExtension,
@@ -453,7 +453,7 @@ def bands(self) -> Optional[List[Band]]:
 
         return map_opt(
             lambda bands: [Band(b) for b in bands],
-            self.summaries.get_list(BANDS_PROP, Dict[str, Any]),
+            self.summaries.get_list(BANDS_PROP),
         )
 
     @bands.setter
@@ -463,7 +463,7 @@ def bands(self, v: Optional[List[Band]]) -> None:
     @property
     def cloud_cover(self) -> Optional[RangeSummary[float]]:
         """Get or sets the range of cloud cover from the summary."""
-        return self.summaries.get_range(CLOUD_COVER_PROP, float)
+        return self.summaries.get_range(CLOUD_COVER_PROP)
 
     @cloud_cover.setter
     def cloud_cover(self, v: Optional[RangeSummary[float]]) -> None:

pystac/extensions/file.py

@@ -191,7 +191,7 @@ def data_type(self) -> Optional[List[FileDataType]]:
 
         return map_opt(
             lambda x: [FileDataType(t) for t in x],
-            self.summaries.get_list(DATA_TYPE_PROP, str),
+            self.summaries.get_list(DATA_TYPE_PROP),
         )
 
     @data_type.setter
@@ -205,7 +205,7 @@ def size(self) -> Optional[pystac.RangeSummary[int]]:
         Returns:
             int or None
         """
-        return self.summaries.get_range(SIZE_PROP, int)
+        return self.summaries.get_range(SIZE_PROP)
 
     @size.setter
     def size(self, v: Optional[pystac.RangeSummary[int]]) -> None:
@@ -214,7 +214,7 @@ def size(self, v: Optional[pystac.RangeSummary[int]]) -> None:
     @property
     def nodata(self) -> Optional[List[Any]]:
         """Get or sets the list of no data values"""
-        return self.summaries.get_list(NODATA_PROP, List[Any])
+        return self.summaries.get_list(NODATA_PROP)
 
     @nodata.setter
     def nodata(self, v: Optional[List[Any]]) -> None:

pystac/extensions/raster.py

@@ -729,7 +729,7 @@ def bands(self) -> Optional[List[RasterBand]]:
         """
         return map_opt(
             lambda bands: [RasterBand(b) for b in bands],
-            self.summaries.get_list(BANDS_PROP, Dict[str, Any]),
+            self.summaries.get_list(BANDS_PROP),
         )
 
     @bands.setter