remove deprecated dependencies and fixes (#1141)

Author: vincentsarago

CHANGES.md

@@ -12,6 +12,10 @@
 
 ### titiler.core
 
+* remove deprecated `ColorFormulaParams` and `RescalingParams` dependencies **breaking change**
+
+* remove deprecated `DefaultDependency` dict-unpacking feature **breaking change**
+
 * add `min`, `max`, `mean`, `median`, `std` and `var` algorithms
 
 * Fix TerrainRGB algorithm and param user-controlled nodata-height (@jo-chemla, https://github.com/developmentseed/titiler/pull/1116)
@@ -94,6 +98,11 @@
     )
     ```
 
+### titiler.extensions
+
+* update `wms` extension to remove usage of `ColorFormulaParams` and `RescalingParams` dependencies
+* update `render` extension to better validate query-parameters from render expression
+
 ### titiler.xarray
 
 * update `rio-tiler` requirement to `>=7.6.1`

docs/src/examples/code/tiler_with_auth.md

@@ -43,7 +43,7 @@ app/models.py
 
 """
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 from typing import List, Optional
 
 from jose import jwt
@@ -67,7 +67,7 @@ class AccessToken(BaseModel):
     @validator("iat", pre=True, always=True)
     def set_creation_time(cls, v) -> datetime:
         """Set token creation time (iat)."""
-        return datetime.utcnow()
+        return datetime.now(timezone.UTC)
 
     @validator("exp", always=True)
     def set_expiration_time(cls, v, values) -> datetime:

docs/src/user_guide/rendering.md

@@ -130,5 +130,5 @@ giving a possible range of 0 to 255 or 0 to 65,536, so Titiler will use these ra
 For certain datasets (e.g. DEMs) this default behaviour can make the image seem washed out (or even entirely one color),
 so if you see this happen look into rescaling your images to something that makes sense for your data.
 
-It is also possible to add a [rescaling dependency](../api/titiler/core/dependencies/#rescalingparams) to automatically apply
+It is also possible to add a [rescaling dependency](../api/titiler/core/dependencies/#ImageRenderingParams) to automatically apply
 a default rescale.

src/titiler/application/tests/routes/test_stac.py

@@ -3,6 +3,7 @@
 from typing import Dict
 from unittest.mock import patch
 
+import pytest
 from rasterio.io import MemoryFile
 
 from ..conftest import mock_rasterio_open, mock_RequestGet
@@ -36,7 +37,9 @@ def test_info(httpx, rio, app):
     body = response.json()
     assert body["B01"]
 
-    response = app.get("/stac/info?url=https://myurl.com/item.json")
+    # no assets
+    with pytest.warns(UserWarning):
+        response = app.get("/stac/info?url=https://myurl.com/item.json")
     assert response.status_code == 200
     body = response.json()
     assert body["B01"]

src/titiler/core/tests/test_dependencies.py

@@ -2,7 +2,7 @@
 
 import json
 from dataclasses import dataclass
-from typing import Literal
+from typing import Literal, Optional
 
 import pytest
 from fastapi import Depends, FastAPI, Path
@@ -147,10 +147,11 @@ def test_default():
 
     @dataclass
     class dep(dependencies.DefaultDependency):
-        v: int
+        v: Optional[int] = None
 
-    # make sure we can unpack the class
-    assert dict(**dep(v=1)) == {"v": 1}
+    assert dep(v=1).as_dict() == {"v": 1}
+    assert dep().as_dict() == {}
+    assert dep().as_dict(exclude_none=False) == {"v": None}
     assert dep(v=1).v == 1
 
 

src/titiler/core/tests/test_factories.py

@@ -23,7 +23,7 @@
 from rasterio.crs import CRS
 from rasterio.io import MemoryFile
 from rio_tiler.colormap import cmap as default_cmap
-from rio_tiler.errors import NoOverviewWarning
+from rio_tiler.errors import InvalidDatatypeWarning, NoOverviewWarning
 from rio_tiler.io import BaseReader, MultiBandReader, Reader, STACReader
 from starlette.requests import Request
 from starlette.testclient import TestClient
@@ -279,7 +279,7 @@ def test_TilerFactory():
     assert meta["driver"] == "WMTS"
     assert meta["crs"] == "EPSG:3857"
     root = ET.fromstring(response.content)
-    assert root
+    assert root is not None
 
     response = client.get(
         f"/WebMercatorQuad/WMTSCapabilities.xml?url={DATA_DIR}/cog.tif&bdix=1&rescale=0,1000"
@@ -290,7 +290,7 @@ def test_TilerFactory():
     assert meta["driver"] == "WMTS"
     assert meta["crs"] == "EPSG:3857"
     root = ET.fromstring(response.content)
-    assert root
+    assert root is not None
 
     response = client.get(
         f"/WorldCRS84Quad/WMTSCapabilities.xml?url={DATA_DIR}/cog.tif&minzoom=5&maxzoom=12"
@@ -301,7 +301,7 @@ def test_TilerFactory():
     assert meta["driver"] == "WMTS"
     assert str(meta["crs"]) == "OGC:CRS84"
     root = ET.fromstring(response.content)
-    assert root
+    assert root is not None
 
     response = client.get(f"/bounds?url={DATA_DIR}/cog.tif")
     assert response.status_code == 200
@@ -321,7 +321,9 @@ def test_TilerFactory():
     assert "bbox" in response.json()
     assert response.json()["geometry"]["type"] == "Polygon"
 
-    response = client.get(f"/info.geojson?url={DATA_DIR}/cog_dateline.tif")
+    # BBOX crossing the Antimeridian
+    with pytest.warns(UserWarning):
+        response = client.get(f"/info.geojson?url={DATA_DIR}/cog_dateline.tif")
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
     assert response.json()["type"] == "Feature"
@@ -415,9 +417,10 @@ def test_TilerFactory():
     assert meta["dtype"] == "uint16"
     assert meta["count"] == 2
 
-    response = client.post(
-        f"/feature/100x100.jpeg?url={DATA_DIR}/cog.tif", json=feature
-    )
+    with pytest.warns(InvalidDatatypeWarning):
+        response = client.post(
+            f"/feature/100x100.jpeg?url={DATA_DIR}/cog.tif", json=feature
+        )
     assert response.status_code == 200
     assert response.headers["content-type"] == "image/jpeg"
     meta = parse_img(response.content)
@@ -785,9 +788,11 @@ def test_MultiBaseTilerFactory(rio):
     assert len(response.json()["bounds"]) == 4
     assert response.json()["crs"]
 
-    response = client.get(f"/info?url={DATA_DIR}/item.json")
-    assert response.status_code == 200
-    assert len(response.json()) == 2
+    # no assets
+    with pytest.warns(UserWarning):
+        response = client.get(f"/info?url={DATA_DIR}/item.json")
+        assert response.status_code == 200
+        assert len(response.json()) == 2
 
     response = client.get(f"/info?url={DATA_DIR}/item.json&assets=B01&assets=B09")
     assert response.status_code == 200
@@ -1169,7 +1174,9 @@ def test_MultiBandTilerFactory():
     assert response.json() == ["B01", "B09"]
 
     # default bands
-    response = client.get(f"/info?directory={DATA_DIR}")
+    # no bands
+    with pytest.warns(UserWarning):
+        response = client.get(f"/info?directory={DATA_DIR}")
     assert response.json()["band_metadata"] == [["B01", {}], ["B09", {}]]
 
     response = client.get(f"/info?directory={DATA_DIR}&bands=B01")
@@ -1626,7 +1633,8 @@ def test_TilerFactory_WithGdalEnv():
     app.include_router(router)
     client = TestClient(app)
 
-    response = client.get(f"/info?url={DATA_DIR}/non_cog.tif")
+    with pytest.warns(NoOverviewWarning):
+        response = client.get(f"/info?url={DATA_DIR}/non_cog.tif")
     assert not response.json()["overviews"]
 
     router = TilerFactory(

src/titiler/core/tests/test_utils.py

@@ -2,11 +2,13 @@
 
 import pytest
 
-from titiler.core.dependencies import BidxParams
+from titiler.core.dependencies import AssetsBidxExprParams, BidxParams
 from titiler.core.resources.enums import MediaType
 from titiler.core.utils import (
     accept_media_type,
+    check_query_params,
     deserialize_query_params,
+    extract_query_params,
     get_dependency_query_params,
 )
 
@@ -62,7 +64,6 @@ def test_deserialize_query_params():
     res, err = deserialize_query_params(
         dependency=BidxParams, params={"bidx": ["invalid type"]}
     )
-    print(res)
     assert res == BidxParams(indexes=None)
     assert err
 
@@ -74,6 +75,67 @@ def test_deserialize_query_params():
     assert not err
 
 
+def test_extract_query_params():
+    """Test extract_query_params."""
+    # invalid
+    qs, err = extract_query_params(
+        dependencies=[BidxParams],
+        params={"bidx": ["invalid type"]},
+    )
+    assert qs == {}
+    assert len(err)
+
+    qs, err = extract_query_params(
+        dependencies=[BidxParams],
+        params={"bidx": [1]},
+    )
+    assert qs == {"indexes": [1]}
+    assert len(err) == 0
+
+    qs, err = extract_query_params(
+        dependencies=[BidxParams],
+        params={"bidx": 1},
+    )
+    assert qs == {"indexes": [1]}
+    assert len(err) == 0
+
+    qs, err = extract_query_params(
+        dependencies=[BidxParams],
+        params={"not_in_dep": "no error, no value", "bidx": [1]},
+    )
+    assert qs == {"indexes": [1]}
+    assert len(err) == 0
+
+
+def test_check_query_params():
+    """Test check_query_params."""
+    # invalid bidx value
+    assert (
+        check_query_params(
+            dependencies=[BidxParams],
+            params={"bidx": ["invalid type"]},
+        )
+        is False
+    )
+
+    # assets is required
+    assert (
+        check_query_params(
+            dependencies=[AssetsBidxExprParams],
+            params={},
+        )
+        is False
+    )
+
+    assert (
+        check_query_params(
+            dependencies=[AssetsBidxExprParams, BidxParams],
+            params={"assets": "yo", "bidx": 1},
+        )
+        is True
+    )
+
+
 @pytest.mark.parametrize(
     "media,accept,expected",
     [

src/titiler/core/titiler/core/dependencies.py

@@ -67,19 +67,6 @@ def DatasetPathParams(url: Annotated[str, Query(description="Dataset URL")]) ->
 class DefaultDependency:
     """Dataclass with dict unpacking"""
 
-    def keys(self):
-        """Return Keys."""
-        warnings.warn(
-            "Dict unpacking will be removed for `DefaultDependency` in titiler 0.19.0",
-            DeprecationWarning,
-            stacklevel=1,
-        )
-        return self.__dict__.keys()
-
-    def __getitem__(self, key):
-        """Return value."""
-        return self.__dict__[key]
-
     def as_dict(self, exclude_none: bool = True) -> Dict:
         """Transform dataclass to dict."""
         if exclude_none:
@@ -437,7 +424,7 @@ def __post_init__(self):
 
 
 @dataclass
-class ImageRenderingParams(DefaultDependency):
+class RenderingParams(DefaultDependency):
     """Image Rendering options."""
 
     rescale: Annotated[
@@ -457,14 +444,6 @@ class ImageRenderingParams(DefaultDependency):
         ),
     ] = None
 
-    add_mask: Annotated[
-        Optional[bool],
-        Query(
-            alias="return_mask",
-            description="Add mask to the output data. Defaults to `True`",
-        ),
-    ] = None
-
     def __post_init__(self):
         """Post Init."""
         if self.rescale:
@@ -484,40 +463,17 @@ def __post_init__(self):
             self.rescale: RescaleType = rescale_array
 
 
-def RescalingParams(
-    rescale: Annotated[
-        Optional[List[str]],
+@dataclass
+class ImageRenderingParams(RenderingParams):
+    """Image Rendering options."""
+
+    add_mask: Annotated[
+        Optional[bool],
         Query(
-            title="Min/Max data Rescaling",
-            description="comma (',') delimited Min,Max range. Can set multiple time for multiple bands.",
-            examples=["0,2000", "0,1000", "0,10000"],  # band 1  # band 2  # band 3
+            alias="return_mask",
+            description="Add mask to the output data. Defaults to `True`",
         ),
-    ] = None,
-) -> Optional[RescaleType]:
-    """Min/Max data Rescaling"""
-    warnings.warn(
-        "RescalingParams is deprecated and set to be removed in 0.20",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-    if rescale:
-        rescale_array = []
-        for r in rescale:
-            parsed = tuple(
-                map(
-                    float,
-                    r.replace(" ", "").replace("[", "").replace("]", "").split(","),
-                )
-            )
-            assert (
-                len(parsed) == 2
-            ), f"Invalid rescale values: {rescale}, should be of form ['min,max', 'min,max'] or [[min,max], [min, max]]"
-
-            rescale_array.append(parsed)
-
-        return rescale_array
-
-    return None
+    ] = None
 
 
 @dataclass
@@ -685,24 +641,6 @@ def BufferParams(
     return buffer
 
 
-def ColorFormulaParams(
-    color_formula: Annotated[
-        Optional[str],
-        Query(
-            title="Color Formula",
-            description="rio-color formula (info: https://github.com/mapbox/rio-color)",
-        ),
-    ] = None,
-) -> Optional[str]:
-    """ColorFormula Parameter."""
-    warnings.warn(
-        "ColorFormulaParams is deprecated and set to be removed in 0.20",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-    return color_formula
-
-
 @dataclass
 class TileParams(DefaultDependency):
     """Tile options."""