Issue #860: align STAC parsing with "name" not being required in "bands"

Author: soxofaan

CHANGELOG.md

@@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Harden STAC parsing of "bands"/"eo:bands" when "name" field is not present (which is technically not a required field) ([#860](https://github.com/Open-EO/openeo-python-client/issues/860))
+
 ### Removed
 
 ### Fixed

openeo/_version.py

@@ -1 +1 @@
-__version__ = "0.48.0a3"
+__version__ = "0.48.0a4"

openeo/metadata.py

@@ -117,7 +117,10 @@ class Band(NamedTuple):
     and https://github.com/stac-extensions/eo#band-object
     """
 
-    name: str
+    # Note: "name" is strictly speaking not required per spec,
+    # but it's probably assumed to be present in a lot of places.
+    name: Optional[str]
+
     common_name: Optional[str] = None
     # wavelength in micrometer
     wavelength_um: Optional[float] = None
@@ -799,9 +802,9 @@ def _band_from_eo_bands_metadata(self, band: Union[dict, pystac.extensions.eo.Ba
                 common_name=band.common_name,
                 wavelength_um=band.center_wavelength,
             )
-        elif isinstance(band, dict) and "name" in band:
+        elif isinstance(band, dict):
             return Band(
-                name=band["name"],
+                name=band.get("name"),
                 common_name=band.get("common_name"),
                 wavelength_um=band.get("center_wavelength"),
             )
@@ -812,7 +815,7 @@ def _band_from_common_bands_metadata(self, data: dict) -> Band:
         """Construct band from metadata dict in STAC 1.1 + eo v2 style metadata"""
         # TODO: also support pystac wrapper when available (pystac v2?)
         return Band(
-            name=data["name"],
+            name=data.get("name"),
             common_name=data.get("eo:common_name"),
             wavelength_um=data.get("eo:center_wavelength"),
         )

tests/test_metadata.py

@@ -1370,22 +1370,32 @@ def test_cube_metadata_repr_no_bands():
 
 
 class TestStacMetadataParser:
-    def test_band_from_eo_bands_metadata(self):
+    def test_band_from_eo_bands_metadata_basic(self):
         assert _StacMetadataParser()._band_from_eo_bands_metadata(
             {"name": "B04"},
         ) == Band(name="B04")
+
+    def test_band_from_eo_bands_metadata_fields(self):
         assert _StacMetadataParser()._band_from_eo_bands_metadata(
             {"name": "B04", "common_name": "red", "center_wavelength": 0.665}
         ) == Band(name="B04", common_name="red", wavelength_um=0.665)
 
-    def test_band_from_common_bands_metadata(self):
+    def test_band_from_eo_bands_metadata_empty(self):
+        assert _StacMetadataParser()._band_from_eo_bands_metadata({}) == Band(name=None)
+
+    def test_band_from_common_bands_metadata_basic(self):
         assert _StacMetadataParser()._band_from_common_bands_metadata(
             {"name": "B04"},
         ) == Band(name="B04")
+
+    def test_band_from_common_bands_metadata_fields(self):
         assert _StacMetadataParser()._band_from_common_bands_metadata(
             {"name": "B04", "eo:common_name": "red", "eo:center_wavelength": 0.665}
         ) == Band(name="B04", common_name="red", wavelength_um=0.665)
 
+    def test_band_from_common_bands_metadata_emtpy(self):
+        assert _StacMetadataParser()._band_from_common_bands_metadata({}) == Band(name=None)
+
     @pytest.mark.parametrize(
         ["data", "expected", "expected_warnings"],
         [
@@ -1476,6 +1486,25 @@ def test_band_from_common_bands_metadata(self):
                     "bands_from_stac_catalog with summaries.keys()=dict_keys(['bands']) (which is non-standard)",
                 ],
             ),
+            (
+                {
+                    "type": "Catalog",
+                    "id": "catalog123",
+                    "description": "Catalog 123",
+                    "stac_version": "1.1.0",
+                    "summaries": {
+                        "bands": [
+                            {"eo:common_name": "blue"},
+                            {"name": "B03"},
+                        ],
+                    },
+                    "links": [],
+                },
+                [Band(name=None, common_name="blue"), Band("B03")],
+                [
+                    "bands_from_stac_catalog with summaries.keys()=dict_keys(['bands']) (which is non-standard)",
+                ],
+            ),
         ],
     )
     def test_bands_from_stac_catalog(self, data, expected, expected_warnings, caplog):
@@ -1547,6 +1576,23 @@ def test_bands_from_stac_catalog(self, data, expected, expected_warnings, caplog
                 ],
                 [],
             ),
+            (
+                StacDummyBuilder.collection(
+                    stac_version="1.1.0",
+                    stac_extensions=["https://stac-extensions.github.io/eo/v1.1.0/schema.json"],
+                    summaries={
+                        "bands": [
+                            {"eo:common_name": "red"},
+                            {"name": "B03", "eo:common_name": "green", "eo:center_wavelength": 0.560},
+                        ],
+                    },
+                ),
+                [
+                    Band(name=None, common_name="red"),
+                    Band("B03", common_name="green", wavelength_um=0.560),
+                ],
+                [],
+            ),
         ],
     )
     def test_bands_from_stac_collection(self, data, expected, caplog, expected_warnings):
@@ -1768,6 +1814,25 @@ def test_bands_from_stac_collection_consult_items(
                     Band("B03", common_name="green", wavelength_um=0.560),
                 ],
             ),
+            (
+                StacDummyBuilder.item(
+                    stac_version="1.0.0",
+                    stac_extensions=["https://stac-extensions.github.io/eo/v1.1.0/schema.json"],
+                    properties={
+                        "eo:bands": [{"nonane": "nope"}, {"name": "B03"}],
+                    },
+                ),
+                [Band(name=None), Band("B03")],
+            ),
+            (
+                StacDummyBuilder.item(
+                    stac_version="1.1.0",
+                    properties={
+                        "bands": [{"eo:common_name": "blue"}, {"name": "B03"}],
+                    },
+                ),
+                [Band(name=None, common_name="blue"), Band("B03")],
+            ),
         ],
     )
     def test_bands_from_stac_item(self, data, expected):
@@ -1800,6 +1865,15 @@ def test_bands_from_stac_item_no_bands(self):
                 ),
                 ["B04", "B03"],
             ),
+            (
+                StacDummyBuilder.item(
+                    stac_version="1.1.0",
+                    properties={
+                        "bands": [{"eo:common_name": "blue"}, {"name": "B03"}],
+                    },
+                ),
+                [None, "B03"],
+            ),
         ],
     )
     def test_bands_from_stac_item_band_names(self, data, expected):
@@ -2007,6 +2081,26 @@ def test_bands_from_stac_item_consult_assets(self, data, expected, kwargs):
                 },
                 ["B04", "B03"],
             ),
+            (
+                {
+                    "href": "https://stac.test/asset.tif",
+                    "bands": [
+                        {"raster:scale": 3.14},
+                        {"name": "B03"},
+                    ],
+                },
+                [None, "B03"],
+            ),
+            (
+                {
+                    "href": "https://stac.test/asset.tif",
+                    "eo:bands": [
+                        {"center_wavelength": 0.5},
+                        {"name": "B03"},
+                    ],
+                },
+                [None, "B03"],
+            ),
         ],
     )
     def test_bands_from_stac_asset(self, data, expected):
@@ -2077,6 +2171,21 @@ def test_bands_from_stac_asset(self, data, expected):
                 ["B03", "B02", "B04"],
                 ["Deriving band listing from unordered `item_assets`"],
             ),
+            (
+                # STAC 1.1 Collection with "eo" extension based band metadata
+                StacDummyBuilder.collection(
+                    stac_version="1.1.0",
+                    stac_extensions=[
+                        "https://stac-extensions.github.io/eo/v1.1.0/schema.json",
+                    ],
+                    item_assets={
+                        "asset1": {"eo:bands": [{"noname": "noname"}, {"name": "B02"}]},
+                        "asset2": {"eo:bands": [{"name": "B04"}]},
+                    },
+                ),
+                [None, "B02", "B04"],
+                ["Deriving band listing from unordered `item_assets`"],
+            ),
         ],
     )
     def test_bands_from_stac_collection_with_item_assets(