Skip to content

Commit bca60b5

Browse files
authored
feat: add xarray dataset coordinate endpoint (#1504)
* feat: add xarray dataset coordinate endpoint resolves #1503 * feat: add /dataset/dimensions endpoint to show dimension names and sizes
1 parent 9669764 commit bca60b5

4 files changed

Lines changed: 131 additions & 58 deletions

File tree

‎docs/src/advanced/Extensions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class FactoryExtension(metaclass=abc.ABCMeta):
6565

6666
#### titiler.xarray.DatasetMetadataExtension
6767

68-
- Goal: adds `/dataset/`, `/dataset/keys` and `/datasets/dict` endpoints which return metadata about a multidimensional Dataset (not a DataArray)
68+
- Goal: adds `/dataset/`, `/dataset/keys`, `/dataset/dict`, `/dataset/dimensions` and `/dataset/coordinates/{name}` endpoints which return metadata about a multidimensional Dataset (not a DataArray)
6969

7070
#### titiler.mosaic.extensions.wmts.wmtsExtension
7171

‎src/titiler/xarray/tests/test_factory.py‎

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,11 @@ def test_tiler_factory():
4343

4444
md = TilerFactory(
4545
router_prefix="/md",
46-
# /dataset, /dataset/dict, /dataset/keys
46+
# /dataset, /dataset/dict, /dataset/keys, /dataset/dimensions,
47+
# /dataset/coordinates/{name}
4748
extensions=[DatasetMetadataExtension()],
4849
)
49-
assert len(md.router.routes) == 18
50+
assert len(md.router.routes) == 20
5051

5152
app = FastAPI()
5253
app.include_router(md.router, prefix="/md")
@@ -69,7 +70,7 @@ def app():
6970
],
7071
reader=FsReader,
7172
)
72-
assert len(md.router.routes) == 18
73+
assert len(md.router.routes) == 20
7374

7475
app = FastAPI()
7576
app.include_router(md.router, prefix="/md")
@@ -86,7 +87,7 @@ def app_zarr():
8687
DatasetMetadataExtension(),
8788
],
8889
)
89-
assert len(md.router.routes) == 18
90+
assert len(md.router.routes) == 20
9091

9192
app = FastAPI()
9293
app.include_router(md.router, prefix="/md")
@@ -115,6 +116,45 @@ def test_dataset_extension(filename, app):
115116
assert "text/html" in resp.headers["content-type"]
116117

117118

119+
def test_dataset_dimensions(app):
120+
"""Test dimension names and sizes."""
121+
resp = app.get("/md/dataset/dimensions", params={"url": dataset_2d_nc})
122+
assert resp.status_code == 200
123+
assert resp.headers["content-type"] == "application/json"
124+
assert resp.json() == {"y": 1000, "x": 2000}
125+
126+
127+
def test_dataset_coordinate(app):
128+
"""Test coordinate metadata and values."""
129+
resp = app.get(
130+
"/md/dataset/coordinates/x",
131+
params={"url": dataset_2d_nc},
132+
)
133+
assert resp.status_code == 200
134+
assert resp.headers["content-type"] == "application/json"
135+
coordinate = resp.json()
136+
assert coordinate["name"] == "x"
137+
assert coordinate["dims"] == ["x"]
138+
assert coordinate["data"][:2] == [-170.0, -169.83]
139+
140+
resp = app.get(
141+
"/md/dataset/coordinates/time",
142+
params={"url": dataset_3d_nc},
143+
)
144+
assert resp.status_code == 200
145+
assert resp.json()["data"] == [
146+
"2022-01-01T00:00:00",
147+
"2023-01-01T00:00:00",
148+
]
149+
150+
resp = app.get(
151+
"/md/dataset/coordinates/missing",
152+
params={"url": dataset_2d_nc},
153+
)
154+
assert resp.status_code == 404
155+
assert resp.json() == {"detail": "Coordinate 'missing' not found"}
156+
157+
118158
@pytest.mark.parametrize(
119159
"filename",
120160
[dataset_2d_nc, dataset_3d_nc, dataset_3d_zarr],

‎src/titiler/xarray/titiler/xarray/extensions.py‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import xarray
99
from attrs import define
10-
from fastapi import Depends, Query
10+
from fastapi import Depends, HTTPException, Query
1111
from rio_tiler.constants import WGS84_CRS
1212
from starlette.responses import HTMLResponse
1313

@@ -102,6 +102,39 @@ def dataset_metadata_dict(
102102
with self.dataset_opener(src_path, **io_params.as_dict()) as ds:
103103
return ds.to_dict(data=False)
104104

105+
@factory.router.get(
106+
"/dataset/dimensions",
107+
response_model=dict[str, int],
108+
responses={200: {"description": "Returns the Dataset dimension sizes."}},
109+
)
110+
def dataset_dimensions(
111+
src_path=Depends(factory.path_dependency),
112+
io_params=Depends(self.io_dependency),
113+
):
114+
"""Returns the Dataset dimension sizes."""
115+
with self.dataset_opener(src_path, **io_params.as_dict()) as ds:
116+
return dict(ds.sizes)
117+
118+
@factory.router.get(
119+
"/dataset/coordinates/{name}",
120+
responses={
121+
200: {"description": "Returns a Dataset coordinate and its values."}
122+
},
123+
)
124+
def dataset_coordinate(
125+
name: str,
126+
src_path=Depends(factory.path_dependency),
127+
io_params=Depends(self.io_dependency),
128+
):
129+
"""Returns a Dataset coordinate and its values."""
130+
with self.dataset_opener(src_path, **io_params.as_dict()) as ds:
131+
try:
132+
return ds.coords[name].to_dict(data=True)
133+
except KeyError as e:
134+
raise HTTPException(
135+
status_code=404, detail=f"Coordinate '{name}' not found"
136+
) from e
137+
105138
@factory.router.get(
106139
"/dataset/keys",
107140
response_model=list[str],

‎uv.lock‎

Lines changed: 52 additions & 52 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)