Merge branch 'main' of https://github.com/developmentseed/titiler

Author: vincentsarago

CHANGES.md

@@ -8,6 +8,10 @@
 
 * add point value query on right-click to map viewer (@hrodmn, https://github.com/developmentseed/titiler/pull/1100)
 
+### titiler.xarray
+
+* change `get_variable.drop_dim` parameter type from `str` to `List[str]` **breaking change**
+
 ## 0.21.1 (2025-01-29)
 
 ### titiler.core

src/titiler/xarray/tests/test_dependencies.py

@@ -44,3 +44,24 @@ def tiles(
         response = client.get("/tiles/1/2/3", params={"variable": "yo"})
         params = response.json()
         assert params == {"variable": "yo"}
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": "yo=yo"})
+        params = response.json()
+        assert params == {"drop_dim": ["yo=yo"]}
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": "yo=1.0"})
+        params = response.json()
+        assert params == {"drop_dim": ["yo=1.0"]}
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": ["yo=yo", "ye=ye"]})
+        params = response.json()
+        assert params == {"drop_dim": ["yo=yo", "ye=ye"]}
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": "yo"})
+        assert response.status_code == 422
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": "=yo"})
+        assert response.status_code == 422
+
+        response = client.get("/tiles/1/2/3", params={"drop_dim": "yo="})
+        assert response.status_code == 422

src/titiler/xarray/tests/test_io_tools.py

@@ -87,7 +87,27 @@ def test_get_variable():
     with pytest.raises(AssertionError):
         get_variable(ds, "dataset")
 
-    da = get_variable(ds, "dataset", drop_dim="universe=somewhere")
+    da = get_variable(ds, "dataset", drop_dim=["universe=somewhere"])
+    assert da.rio.crs
+    assert da.dims == ("z", "y", "x")
+
+    # 5D dataset - drop time dim
+    arr = numpy.arange(0, 33 * 35 * 2).reshape(2, 1, 1, 33, 35)
+    data = xarray.DataArray(
+        arr,
+        dims=("time", "universe", "z", "y", "x"),
+        coords={
+            "x": numpy.arange(-170, 180, 10),
+            "y": numpy.arange(-80, 85, 5),
+            "z": [0],
+            "universe": ["somewhere"],
+            "time": [datetime(2022, 1, 1), datetime(2023, 1, 1)],
+        },
+    )
+
+    da = get_variable(
+        ds, "dataset", drop_dim=["universe=somewhere", "time=2022-01-01T00:00:00"]
+    )
     assert da.rio.crs
     assert da.dims == ("z", "y", "x")
 

src/titiler/xarray/titiler/xarray/dependencies.py

@@ -1,10 +1,11 @@
 """titiler.xarray dependencies."""
 
 from dataclasses import dataclass
-from typing import Optional, Union
+from typing import List, Optional, Union
 
 import numpy
 from fastapi import Query
+from pydantic.types import StringConstraints
 from rio_tiler.types import RIOResampling, WarpResampling
 from typing_extensions import Annotated
 
@@ -33,15 +34,20 @@ class XarrayIOParams(DefaultDependency):
     # cache_client
 
 
+DropDimStr = Annotated[str, StringConstraints(pattern=r"^[^=]+=[^=]+$")]
+
+
 @dataclass
 class XarrayDsParams(DefaultDependency):
     """Xarray Dataset Options."""
 
     variable: Annotated[str, Query(description="Xarray Variable name")]
 
     drop_dim: Annotated[
-        Optional[str],
-        Query(description="Dimension to drop"),
+        Optional[List[DropDimStr]],
+        Query(
+            description="Dimensions to drop in form of `{dimension}={value}`",
+        ),
     ] = None
 
     datetime: Annotated[
@@ -68,8 +74,10 @@ class CompatXarrayParams(XarrayIOParams):
     variable: Annotated[Optional[str], Query(description="Xarray Variable name")] = None
 
     drop_dim: Annotated[
-        Optional[str],
-        Query(description="Dimension to drop"),
+        Optional[List[DropDimStr]],
+        Query(
+            description="Dimensions to drop in form of `{dimension}={value}`",
+        ),
     ] = None
 
     datetime: Annotated[

src/titiler/xarray/titiler/xarray/io.py

@@ -139,15 +139,15 @@ def get_variable(
     ds: xarray.Dataset,
     variable: str,
     datetime: Optional[str] = None,
-    drop_dim: Optional[str] = None,
+    drop_dim: Optional[List[str]] = None,
 ) -> xarray.DataArray:
     """Get Xarray variable as DataArray.
 
     Args:
         ds (xarray.Dataset): Xarray Dataset.
         variable (str): Variable to extract from the Dataset.
         datetime (str, optional): datetime to select from the DataArray.
-        drop_dim (str, optional): DataArray dimension to drop in form of `{dimension}={value}`.
+        drop_dim (list of str, optional): DataArray dimension to drop in form of `[{dimension}={value}],`.
 
     Returns:
         xarray.DataArray: 2D or 3D DataArray.
@@ -156,8 +156,9 @@ def get_variable(
     da = ds[variable]
 
     if drop_dim:
-        dim_to_drop, dim_val = drop_dim.split("=")
-        da = da.sel({dim_to_drop: dim_val}).drop_vars(dim_to_drop)
+        for dim in drop_dim:
+            dim_to_drop, dim_val = dim.split("=")
+            da = da.sel({dim_to_drop: dim_val}).drop_vars(dim_to_drop)
 
     da = _arrange_dims(da)