Skip to content

add_bounds uses keys rather than dims #221

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 3, 2021
Merged

add_bounds uses keys rather than dims #221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc78afa
uses rather than
malmans2 May 1, 2021
2f74c30
use update and add what's new
malmans2 May 3, 2021
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
20 changes: 12 additions & 8 deletions cf_xarray/accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1586,15 +1586,15 @@ def get_bounds_dim_name(self, key: str) -> str:
assert self._obj.sizes[bounds_dim] in [2, 4]
return bounds_dim

def add_bounds(self, dims: Union[Hashable, Iterable[Hashable]]):
def add_bounds(self, keys: Union[str, Iterable[str]]):
"""
Returns a new object with bounds variables. The bounds values are guessed assuming
equal spacing on either side of a coordinate label.

Parameters
----------
dims : Hashable or Iterable[Hashable]
Either a single dimension name or a list of dimension names.
keys : str or Iterable[str]
Either a single key or a list of keys corresponding to dimensions.

Returns
-------
Expand All @@ -1609,12 +1609,16 @@ def add_bounds(self, dims: Union[Hashable, Iterable[Hashable]]):
The bounds variables are automatically named f"{dim}_bounds" where ``dim``
is a dimension name.
"""
if isinstance(dims, Hashable):
dimensions = (dims,)
else:
dimensions = dims
if isinstance(keys, str):
keys = [keys]

dimensions = set()
for key in keys:
dimensions |= set(
apply_mapper(_get_dims, self._obj, key, error=False, default=[key])
)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A set comprehension is cleaner here

Suggested change
dimensions = set()
for key in keys:
dimensions |= set(
apply_mapper(_get_dims, self._obj, key, error=False, default=[key])
)
dimensions = {
apply_mapper(_get_dims, self._obj, key, error=False, default=[key])
for key in keys
)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually shouldn't the default be key instead of [key] given that you're doing set subttraction later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

apply_mapper returns a list of dimension names, shouldn't default do the same?

Regarding the set comprehension, this wouldn't work: {["dim1", "dim2"], ["dim3"]}.

How about this?

dimensions = {dim for key in keys for dim in apply_mapper(_get_dims, self._obj, key, error=False, default=[key])}

Or we could use update:

dimensions = set()
for key in keys:
    dimensions.update(apply_mapper(_get_dims, self._obj, key, error=False, default=[key]))

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like update


bad_dims: Set[Hashable] = set(dimensions) - set(self._obj.dims)
bad_dims: Set[str] = dimensions - set(self._obj.dims)
if bad_dims:
raise ValueError(
f"{bad_dims!r} are not dimensions in the underlying object."
Expand Down
4 changes: 4 additions & 0 deletions cf_xarray/tests/test_accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,10 @@ def test_add_bounds(obj, dims):
assert added[dim].attrs["bounds"] == name
assert_allclose(added[name].reset_coords(drop=True), expected[dim])

# Test multiple dimensions
assert not {"x1_bounds", "x2_bounds"} <= set(multiple.variables)
assert {"x1_bounds", "x2_bounds"} <= set(multiple.cf.add_bounds("X").variables)


def test_bounds():
ds = airds.copy(deep=True).cf.add_bounds("lat")
Expand Down