Fix xarray FutureWarning about dims vs sizes

niksirbi commented 4 weeks ago

Description

What is this PR

[x] Bug fix
[ ] Addition of a new feature
[ ] Other

Why is this PR needed?

pytest caught a bunch of FutureWarnings of this type:

FutureWarning: The return type of Dataset.dims will be changed to return a set of dimension names in future, in order to be more consistent with DataArray.dims. To access a mapping from dimension names to lengths, please use Dataset.sizes.

To reproduce, run pytest locally on the main branch.

What does this PR do?

For cases when we actually access a dimensions size, we now switch to using ds.sizes (which returns a dict("dim_name": dims_size)), instead of ds.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:

[x] The code has been tested locally
[n/a] Tests have been added to cover all new functionality
[n/a] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.77%. Comparing base (95965f8) to head (d4ec24d). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #297 +/- ## ======================================= Coverage 99.77% 99.77% ======================================= Files 14 14 Lines 883 883 ======================================= Hits 881 881 Misses 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.