Fix xarray FutureWarning about dims vs sizes #297
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is this PR
Why is this PR needed?
pytest
caught a bunch of FutureWarnings of this type:To reproduce, run
pytest
locally on themain
branch.What does this PR do?
For cases when we actually access a dimensions size, we now switch to using
ds.sizes
(which returns adict("dim_name": dims_size)
), instead ofds.dims
(which will return a set of dimensions names in future).For cases when we just need the dim names (e.g. for checking if a given dimension exists), we keep using
ds.dims
, which works now (because it returns the dict keys) and should continue working in the future (will return a set).References
I think some of the "offending" uses of
ds.dims
where introduced in #267 and I hadn't caught them during review.How has this PR been tested?
All test pass without warnings.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
No.
Checklist: