Don't assume product._md exists (#171)

* handle missing _md product attr; update use of DatasetType
* lower bound datacube version

---------

Co-authored-by: Ariana Barzinpour <[email protected]>

Author: Ariana-B

docs/stac-vs-odc.rst

@@ -13,7 +13,7 @@ similar concepts.
      - ODC
      - Description
    * - :py:class:`~pystac.Collection`
-     - Product or :py:class:`~datacube.model.DatasetType`
+     - :py:class:`~datacube.model.Product`
      - Collection of observations across space and time
    * - :py:class:`~pystac.Item`
      - :py:class:`~datacube.model.Dataset`

odc/stac/eo3/_eo3converter.py

@@ -20,7 +20,7 @@
 except ImportError:
     from datacube.index.abstract import default_metadata_type_docs  # type: ignore
 
-from datacube.model import Dataset, DatasetType, metadata_from_doc
+from datacube.model import Dataset, Product, metadata_from_doc
 from odc.geo import CRS
 from odc.geo.geobox import GeoBox
 from toolz import dicttoolz
@@ -60,7 +60,7 @@
 )
 
 
-def _to_product(md: RasterCollectionMetadata) -> DatasetType:
+def _to_product(md: RasterCollectionMetadata) -> Product:
     def make_band(
         band_key: BandKey,
         band: RasterBandMetadata,
@@ -95,11 +95,11 @@ def make_band(
             for band_key, band in md.meta.bands.items()
         ],
     }
-    return DatasetType(_eo3, doc)
+    return Product(_eo3, doc)
 
 
 @singledispatch
-def infer_dc_product(x: Any, cfg: Optional[ConversionConfig] = None) -> DatasetType:
+def infer_dc_product(x: Any, cfg: Optional[ConversionConfig] = None) -> Product:
     """Overloaded function."""
     raise TypeError(
         "Invalid type, must be one of: pystac.item.Item, pystac.collection.Collection"
@@ -109,7 +109,7 @@ def infer_dc_product(x: Any, cfg: Optional[ConversionConfig] = None) -> DatasetT
 @infer_dc_product.register(pystac.item.Item)
 def infer_dc_product_from_item(
     item: pystac.item.Item, cfg: Optional[ConversionConfig] = None
-) -> DatasetType:
+) -> Product:
     """
     Infer Datacube product object from a STAC Item.
 
@@ -164,7 +164,7 @@ def _to_dataset(
     item: ParsedItem,
     properties: Dict[str, Any],
     ds_uuid: uuid.UUID,
-    product: DatasetType,
+    product: Product,
 ) -> Dataset:
     # pylint: disable=too-many-locals
 
@@ -228,7 +228,7 @@ def _to_dataset(
 
 
 def _item_to_ds(
-    item: pystac.item.Item, product: DatasetType, cfg: Optional[ConversionConfig] = None
+    item: pystac.item.Item, product: Product, cfg: Optional[ConversionConfig] = None
 ) -> Dataset:
     """
     Construct Dataset object from STAC Item and previously constructed Product.
@@ -239,7 +239,7 @@ def _item_to_ds(
     if cfg is None:
         cfg = {}
 
-    md: RasterCollectionMetadata = getattr(product, "_md")
+    md: Optional[RasterCollectionMetadata] = getattr(product, "_md", None)
     uuid_cfg = cfg.get("uuid", {})
     ds_uuid = _compute_uuid(
         item, mode=uuid_cfg.get("mode", "auto"), extras=uuid_cfg.get("extras", [])
@@ -252,7 +252,7 @@ def _item_to_ds(
 def stac2ds(
     items: Iterable[pystac.item.Item],
     cfg: Optional[ConversionConfig] = None,
-    product_cache: Optional[Dict[str, DatasetType]] = None,
+    product_cache: Optional[Dict[str, Product]] = None,
 ) -> Iterator[Dataset]:
     """
     STAC :class:`~pystac.item.Item` to :class:`~datacube.model.Dataset` stream converter.
@@ -277,7 +277,7 @@ def stac2ds(
 
     :param product_cache:
        Input/Output parameter, contains mapping from collection name to deduced product definition,
-       i.e. :py:class:`datacube.model.DatasetType` object.
+       i.e. :py:class:`datacube.model.Product` object.
 
     .. rubric: Sample Configuration
 
@@ -313,7 +313,7 @@ def stac2ds(
          warnings: ignore
 
     """
-    products: Dict[str, DatasetType] = {} if product_cache is None else product_cache
+    products: Dict[str, Product] = {} if product_cache is None else product_cache
     for item in items:
         collection_id = _collection_id(item)
         product = products.get(collection_id)
@@ -329,7 +329,7 @@ def stac2ds(
 @infer_dc_product.register(pystac.collection.Collection)
 def infer_dc_product_from_collection(
     collection: pystac.collection.Collection, cfg: Optional[ConversionConfig] = None
-) -> DatasetType:
+) -> Product:
     """
     Construct Datacube Product definition from STAC Collection.
 

setup.cfg

@@ -58,7 +58,7 @@ docs =
   matplotlib-inline
   pandas
   distributed
-  datacube
+  datacube>=1.8.8
   ipython
   ipykernel
 

tests/test_eo3converter.py

@@ -234,3 +234,14 @@ def test_old_imports():
 
     with pytest.raises(AttributeError):
         _ = odc.stac.no_such_thing
+
+
+def test_product_cache(sentinel_stac_ms: pystac.item.Item):
+    item = sentinel_stac_ms
+    # simulate a product that was not created via infer_dc_product
+    # (and therefore did not have the _md attr set)
+    product = infer_dc_product(item, STAC_CFG)
+    delattr(product, "_md")
+    # make sure it doesn't error when product_cache is provided
+    (ds,) = stac2ds([item], STAC_CFG, {product.name: product})
+    assert ds.id