Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow NaN attributes in datasets #152

Merged
merged 4 commits into from
Feb 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
def airtemp_ds():
ds = xr.tutorial.open_dataset('air_temperature')
ds['air'].encoding['_FillValue'] = -9999
ds['air'].attrs['nan_attribute'] = np.nan
ds['air'].attrs['none_attribute'] = None
return ds


Expand Down
2 changes: 1 addition & 1 deletion tests/test_fsspec_compat.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def test_get_zmetadata_key(airtemp_ds):
mapper = TestMapper(SingleDatasetRest(airtemp_ds).app)
actual = json.loads(mapper['.zmetadata'].decode())
expected = jsonify_zmetadata(airtemp_ds, create_zmetadata(airtemp_ds))
assert actual == expected
assert json.dumps(actual, allow_nan=True) == json.dumps(expected, allow_nan=True)


def test_missing_key_raises_keyerror(airtemp_ds):
Expand Down
6 changes: 5 additions & 1 deletion tests/test_rest_api.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import json

import pytest
import uvicorn
import xarray as xr
Expand Down Expand Up @@ -281,7 +283,9 @@ def test_repr(airtemp_ds, airtemp_app_client):
def test_zmetadata(airtemp_ds, airtemp_app_client):
response = airtemp_app_client.get('/.zmetadata')
assert response.status_code == 200
assert response.json() == jsonify_zmetadata(airtemp_ds, create_zmetadata(airtemp_ds))
assert json.dumps(response.json()) == json.dumps(
jsonify_zmetadata(airtemp_ds, create_zmetadata(airtemp_ds))
)


def test_bad_key(airtemp_app_client):
Expand Down
8 changes: 5 additions & 3 deletions xpublish/plugins/included/dataset_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
from starlette.responses import HTMLResponse # type: ignore
from zarr.storage import attrs_key # type: ignore

from xpublish.utils.api import JSONResponse

from ...dependencies import get_zmetadata, get_zvariables
from .. import Dependencies, Plugin, hookimpl

Expand Down Expand Up @@ -32,13 +34,13 @@ def html_representation(
def list_keys(
dataset=Depends(deps.dataset),
):
return list(dataset.variables)
return JSONResponse(list(dataset.variables))

@router.get('/dict')
def to_dict(
dataset=Depends(deps.dataset),
):
return dataset.to_dict(data=False)
return JSONResponse(dataset.to_dict(data=False))

@router.get('/info')
def info(
Expand Down Expand Up @@ -67,6 +69,6 @@ def info(

info['global_attributes'] = meta[attrs_key]

return info
return JSONResponse(info)

return router
11 changes: 6 additions & 5 deletions xpublish/plugins/included/zarr.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import json
import logging
from typing import Sequence

Expand All @@ -8,6 +7,8 @@
from starlette.responses import Response # type: ignore
from zarr.storage import array_meta_key, attrs_key, group_meta_key # type: ignore

from xpublish.utils.api import JSONResponse

from ...dependencies import get_zmetadata, get_zvariables
from ...utils.api import DATASET_ID_ATTR_KEY
from ...utils.cache import CostTimer
Expand Down Expand Up @@ -39,7 +40,7 @@ def get_zarr_metadata(

zjson = jsonify_zmetadata(dataset, zmetadata)

return Response(json.dumps(zjson).encode('ascii'), media_type='application/json')
return JSONResponse(zjson)

@router.get(f'/{group_meta_key}')
def get_zarr_group(
Expand All @@ -49,7 +50,7 @@ def get_zarr_group(
zvariables = get_zvariables(dataset, cache)
zmetadata = get_zmetadata(dataset, cache, zvariables)

return zmetadata['metadata'][group_meta_key]
return JSONResponse(zmetadata['metadata'][group_meta_key])

@router.get(f'/{attrs_key}')
def get_zarr_attrs(
Expand All @@ -59,7 +60,7 @@ def get_zarr_attrs(
zvariables = get_zvariables(dataset, cache)
zmetadata = get_zmetadata(dataset, cache, zvariables)

return zmetadata['metadata'][attrs_key]
return JSONResponse(zmetadata['metadata'][attrs_key])

@router.get('/{var}/{chunk}')
def get_variable_chunk(
Expand All @@ -80,7 +81,7 @@ def get_variable_chunk(
if array_meta_key in chunk:
return zmetadata['metadata'][f'{var}/{array_meta_key}']
elif attrs_key in chunk:
return zmetadata['metadata'][f'{var}/{attrs_key}']
return JSONResponse(zmetadata['metadata'][f'{var}/{attrs_key}'])
elif group_meta_key in chunk:
raise HTTPException(status_code=404, detail='No subgroups')
else:
Expand Down
16 changes: 15 additions & 1 deletion xpublish/utils/api.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import json
from collections.abc import Mapping
from typing import Dict, List, Tuple
from typing import Any, Dict, List, Tuple

import xarray as xr
from fastapi import APIRouter
from fastapi.openapi.utils import get_openapi
from starlette.responses import JSONResponse as StarletteJSONResponse # type: ignore

DATASET_ID_ATTR_KEY = '_xpublish_id'

Expand Down Expand Up @@ -118,3 +120,15 @@ def openapi(self):
self._app.openapi_schema = openapi_schema

return self._app.openapi_schema


class JSONResponse(StarletteJSONResponse):
def __init__(self, *args, **kwargs):
self._render_kwargs = dict(
ensure_ascii=True, allow_nan=True, indent=None, separators=(',', ':')
)
self._render_kwargs.update(kwargs.pop('render_kwargs', {}))
super().__init__(*args, **kwargs)

def render(self, content: Any) -> bytes:
return json.dumps(content, **self._render_kwargs).encode('utf-8')