made ensure_band_dimension private

Author: VictorVerhaert

openeo/metadata.py

@@ -421,7 +421,7 @@ def add_dimension(self, name: str, label: Union[str, float], type: Optional[str]
             dim = Dimension(type=type or "other", name=name)
         return self._clone_and_update(dimensions=self._dimensions + [dim])
 
-    def ensure_band_dimension(
+    def _ensure_band_dimension(
         self, *, name: Optional[str] = None, bands: List[Union[Band, str]], warning: str
     ) -> CubeMetadata:
         """

openeo/rest/datacube.py

@@ -450,12 +450,12 @@ def load_stac(
                         # Ideal case: bands requested by user correspond with bands extracted from metadata.
                         metadata = metadata.filter_bands(band_names=bands)
                     else:
-                        metadata = metadata.ensure_band_dimension(
+                        metadata = metadata._ensure_band_dimension(
                             bands=bands,
                             warning=f"The specified bands {bands} in `load_stac` are not a subset of the bands {metadata.band_dimension.band_names} found in the STAC metadata (unknown bands: {unknown_bands}). Working with specified bands as is.",
                         )
                 else:
-                    metadata = metadata.ensure_band_dimension(
+                    metadata = metadata._ensure_band_dimension(
                         name="bands",
                         bands=bands,
                         warning=f"Bands {bands} were specified in `load_stac`, but no band dimension was detected in the STAC metadata. Working with band dimension and specified bands.",

tests/test_metadata.py

@@ -834,7 +834,7 @@ def test_cubemetadata_ensure_band_dimension_add_bands():
             TemporalDimension(name="t", extent=None),
         ]
     )
-    new = metadata.ensure_band_dimension(bands=["red", "green"], warning="ensure_band_dimension at work")
+    new = metadata._ensure_band_dimension(bands=["red", "green"], warning="ensure_band_dimension at work")
     assert new.has_band_dimension()
     assert new.dimension_names() == ["t", "bands"]
     assert new.band_names == ["red", "green"]
@@ -846,7 +846,9 @@ def test_cubemetadata_ensure_band_dimension_add_name_and_bands():
             TemporalDimension(name="t", extent=None),
         ]
     )
-    new = metadata.ensure_band_dimension(name="bandzz", bands=["red", "green"], warning="ensure_band_dimension at work")
+    new = metadata._ensure_band_dimension(
+        name="bandzz", bands=["red", "green"], warning="ensure_band_dimension at work"
+    )
     assert new.has_band_dimension()
     assert new.dimension_names() == ["t", "bandzz"]
     assert new.band_names == ["red", "green"]
@@ -859,7 +861,7 @@ def test_cubemetadata_ensure_band_dimension_override_bands():
             BandDimension(name="bands", bands=[Band("red"), Band("green")]),
         ]
     )
-    new = metadata.ensure_band_dimension(bands=["tomato", "lettuce"], warning="ensure_band_dimension at work")
+    new = metadata._ensure_band_dimension(bands=["tomato", "lettuce"], warning="ensure_band_dimension at work")
     assert new.has_band_dimension()
     assert new.dimension_names() == ["t", "bands"]
     assert new.band_names == ["tomato", "lettuce"]
@@ -872,7 +874,7 @@ def test_cubemetadata_ensure_band_dimension_override_name_and_bands():
             BandDimension(name="bands", bands=[Band("red"), Band("green")]),
         ]
     )
-    new = metadata.ensure_band_dimension(
+    new = metadata._ensure_band_dimension(
         name="bandzz", bands=["tomato", "lettuce"], warning="ensure_band_dimension at work"
     )
     assert new.has_band_dimension()