Dataset.dims should return a set, not a dict of sizes
Open
Nobody has claimed this yet.
API design
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
This is inconsistent:
In [25]: ds
Out[25]:
<xarray.Dataset>
Dimensions: (x: 1, y: 2)
Dimensions without coordinates: x, y
Data variables:
a (x, y) int64 0 1
In [26]: ds['a'].dims
Out[26]: ('x', 'y')
In [27]: ds['a'].sizes
Out[27]: Frozen({'x': 1, 'y': 2})
In [28]: ds.dims
Out[28]: Frozen({'x': 1, 'y': 2})
In [29]: ds.sizes
Out[29]: Frozen({'x': 1, 'y': 2})
Surely ds.dims should return something like a Frozenset({'x', 'y'})? (because dimension order is meaningless when you have multiple arrays underneath - see https://github.com/pydata/xarray/issues/8498)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Dataset.dims, DataArray.dims, and sizes entry points shown in the issue, then read the related discussion in issue #8498. Done means Dataset.dims consistently returns a set-like collection of dimension names rather than dimension sizes, with the resulting API behavior covered by the project's tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100