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

MNT: Update enum parsing #68

Merged
merged 2 commits into from
Feb 7, 2024
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: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
**Breaking changes**
- Nested group handling:
Before this version, all groups were read, but conflicting variable names in-between groups would shadow data. Now, similarly to xarray ``open_dataset``, ``open_ncml`` accepts an optional ``group`` argument to specify which group should be read. When ``group`` is not specified, it defaults to the root group. Additionally ``group`` can be set to ``'*'`` so that every group is read and the hierarchy is flattened. In the event of conflicting variable/dimension names across groups, the conflicting name will be modified by appending ``'__n'`` where n is incremented.

- Enums are no longer transformed into CF flag_values and flag_meanings attributes, instead they are stored in the ``encoding["dtype"].metadata`` of their respective variable. This is aligned with what is done on xarray v2024.01.0

0.4.0 (2024-01-08)
==================
Expand Down
4 changes: 2 additions & 2 deletions tests/test_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,8 @@ def test_multiple_values_for_scalar():
def test_read_enum():
"""A enum should be turned into CF flag_values and flag_meanings attributes."""
ds = xncml.open_ncml(data / 'testEnums.xml')
assert ds['be_or_not_to_be'].attrs['flag_values'] == [0, 1]
assert ds['be_or_not_to_be'].attrs['flag_meanings'] == ['false', 'true']
assert ds.be_or_not_to_be.dtype.metadata['enum'] == {'false': 0, 'true': 1}
assert ds.be_or_not_to_be.dtype.metadata['enum_name'] == 'boolean'


def test_empty_attr():
Expand Down
17 changes: 7 additions & 10 deletions xncml/parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -459,20 +459,17 @@ def read_enum(obj: EnumTypedef) -> dict[str, list]:
Returns
-------
dict:
A dictionary with CF flag_values and flag_meanings that describe the Enum.
A dictionary describing the Enum.
"""
return {
'flag_values': list(map(lambda e: e.key, obj.content)),
'flag_meanings': list(map(lambda e: e.content[0], obj.content)),
}
return {e.content[0]: e.key for e in obj.content}


def read_variable(
target: xr.Dataset,
ref: xr.Dataset,
obj: Variable,
dimensions: dict,
enums: dict,
enums: dict[str, dict[str, int]],
group_path: str,
) -> xr.Dataset:
"""
Expand Down Expand Up @@ -576,10 +573,10 @@ def read_variable(
raise NotImplementedError

if obj.typedef in enums.keys():
# TODO (@bzah): Update this once Enums are merged in xarray
# https://github.com/pydata/xarray/pull/8147
out.attrs['flag_values'] = enums[obj.typedef]['flag_values']
out.attrs['flag_meanings'] = enums[obj.typedef]['flag_meanings']
dtype = out.dtype
new_dtype = np.dtype(dtype, metadata={'enum': enums[obj.typedef], 'enum_name': obj.typedef})
out.encoding['dtype'] = new_dtype
out = out.astype(new_dtype)
elif obj.typedef is not None:
raise NotImplementedError
import re
Expand Down
Loading