Add tests for deprecation warnings

Author: remi-braun

CI/SCRIPTS/test_others.py

@@ -13,11 +13,13 @@
 
 from eoreader import utils
 from eoreader.bands import (
+    AFRI_1_6,
     BLUE,
     CA,
     CLOUDS,
     DEM,
     GREEN,
+    GREEN1,
     HH,
     HILLSHADE,
     HV,
@@ -419,3 +421,33 @@ def test_windowed_reading():
     # The arrays shouldn't be equal (some cleaning is done)
     with pytest.raises(AssertionError):
         np.testing.assert_array_equal(red_raw.data, red_clean.data)
+
+
+def test_deprecation():
+    """Test deprecation warning"""
+
+    opt_stack = others_path() / "20200310T030415_WV02_Ortho_BGRN_STK.tif"
+    prod_green1 = READER.open(
+        opt_stack,
+        custom=True,
+        sensor_type=SensorType.OPTICAL,
+        pixel_size=2.0,
+        band_map={GREEN1: 1, RED: 2, BLUE: 3, NIR: 4, SWIR_1: 5},
+    )
+    window = Window(200, 500, 200, 500)
+
+    # Check deprecation for GREEN1
+    with pytest.deprecated_call():
+        to_band("GREEN1")
+    with pytest.deprecated_call():
+        prod_green1.load("GREEN1", window=window)
+    with pytest.deprecated_call():
+        prod_green1.load(GREEN1, window=window)
+
+    # Check deprecation for deprecated spectral indices
+    with pytest.deprecated_call():
+        prod_green1.load(AFRI_1_6, window=window)
+
+    # Check deprecation for resolution keyword
+    with pytest.deprecated_call():
+        prod_green1.load(SWIR_1, resolution=2.0, window=window)

eoreader/bands/__init__.py

@@ -449,7 +449,15 @@ def to_band(to_convert: Union[list, BandNames, str]) -> list:
         if band_or_idx:
             band_list.append(band_or_idx)
         else:
-            raise _ite(f"Unknown band or index: {tc}")
+            if tc == "GREEN1":
+                from sertit import logs
+
+                logs.deprecation_warning(
+                    "`GREEN1` is deprecated in favor of `GREEN_1`. `GREEN1` will be removed in a future release."
+                )
+                band_list.append(GREEN_1)
+            else:
+                raise _ite(f"Unknown band or index: {tc}")
 
     return band_list
 

eoreader/utils.py

@@ -182,7 +182,9 @@ def read(
                 size=size,
                 window=window,
                 chunks=chunks,
-                **_prune_keywords(additional_keywords=["window", "chunks"], **kwargs),
+                **_prune_keywords(
+                    additional_keywords=["window", "chunks", "resolution"], **kwargs
+                ),
             )
 
             # In EOReader, we don't care about the band coordinate of a band loaded from a stack.

requirements.txt

@@ -40,7 +40,7 @@ spyndex>=0.3.0
 pystac[validation]
 
 # SERTIT libs
-sertit[full]>=1.27.0
+sertit[full]>=1.27.3
 
 # Optimizations
 dask[complete]>=2021.10.0

setup.py

@@ -33,7 +33,7 @@
         "xarray>=0.18.0",
         "rioxarray>=0.10.0",
         "geopandas>=0.11.0",
-        "sertit[full]>=1.27.0",
+        "sertit[full]>=1.27.3",
         "spyndex>=0.3.0",
         "pyresample",
         "zarr",