Skip to content

Comments

Rename DataTree's "ds" and "data" to "dataset"#9476

Merged
shoyer merged 3 commits intopydata:mainfrom
shoyer:data-ds-to-dataset
Sep 11, 2024
Merged

Rename DataTree's "ds" and "data" to "dataset"#9476
shoyer merged 3 commits intopydata:mainfrom
shoyer:data-ds-to-dataset

Conversation

@shoyer
Copy link
Member

@shoyer shoyer commented Sep 11, 2024

.ds is kept around as a soft-deprecated alias to facilitate the transition from xarray-contrib/datatree, though I verified that all tests pass without it.

@shoyer
Rename DataTree's "ds" and "data" to "dataset"
43171ee 
.ds is kept around as a soft-deprecated alias to facilitate the
transition from xarray-contrib/datatree, though I verified that all
tests pass without it.
@shoyer shoyer requested a review from TomNicholas September 11, 2024 00:13
@TomNicholas TomNicholas added the topic-DataTree Related to the implementation of a DataTree class label Sep 11, 2024
TomNicholas
TomNicholas approved these changes Sep 11, 2024
View reviewed changes
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Looks like there are some real failures to fix, but otherwise 👍

@shoyer shoyer merged commit fac2c89 into pydata:main Sep 11, 2024
@shoyer shoyer deleted the data-ds-to-dataset branch September 11, 2024 01:30
@TomNicholas
Copy link
Member

TomNicholas commented Sep 11, 2024

@flamingbear this one is going to mess up your docs too 😅

@TomNicholas
Copy link
Member

TomNicholas commented Sep 11, 2024

@shoyer perhaps we should have left ds as a valid argument to DataTree, otherwise that's also a breaking change.

@shoyer
Copy link
Member Author

shoyer commented Sep 11, 2024

@shoyer perhaps we should have left ds as a valid argument to DataTree, otherwise that's also a breaking change.

You mean data?

I could add that back in, though I guess that will break much less code than the .ds rename. If we do that, we'll definitely want to add a FutureWarning.

@TomNicholas
Copy link
Member

TomNicholas commented Sep 11, 2024

You mean data?

Yes data, sorry.

I guess that will break much less code than the .ds rename.

Hmm yeah fair point - most users will probably be constructing using from_dict or open_datatree.

@TomNicholas TomNicholas mentioned this pull request Sep 11, 2024
Closed
@slevang slevang mentioned this pull request Sep 12, 2024
Merged
TomNicholas added a commit to etienneschalk/xarray that referenced this pull request Sep 12, 2024
@TomNicholas
Merge changes from pydata#9476
95384ac
TomNicholas added a commit that referenced this pull request Sep 12, 2024
@etienneschalk @TomNicholas
Make illegal path-like variable names when constructing a DataTree fr…
8bd456c 
…om a Dataset (#9378)

* Make illegal path-like variable names when constructing a DataTree from a Dataset

* Updated whats-new.rst

* PR comments

* Revert diff

* Update xarray/core/datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update xarray/core/datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update xarray/tests/test_datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update expected Exception message in test

* Merge changes from #9476

* Fix

---------

Co-authored-by: Tom Nicholas <tom@cworthy.org>
dcherian added a commit to dcherian/xarray that referenced this pull request Sep 17, 2024
@dcherian
Merge branch 'main' into flox-preserve-dtype
5c9f291 
* main: (26 commits)
  Forbid modifying names of DataTree objects with parents (pydata#9494)
  DAS-2155 - Merge datatree documentation into main docs. (pydata#9033)
  Make illegal path-like variable names when constructing a DataTree from a Dataset (pydata#9378)
  Ensure TreeNode doesn't copy in-place (pydata#9482)
  `open_groups` for zarr backends (pydata#9469)
  Update pyproject.toml (pydata#9484)
  New whatsnew section (pydata#9483)
  Release notes for v2024.09.0 (pydata#9480)
  Fix `DataTree.coords.__setitem__` by adding `DataTreeCoordinates` class (pydata#9451)
  Rename DataTree's "ds" and "data" to "dataset" (pydata#9476)
  Update DataTree repr to indicate inheritance (pydata#9470)
  Bump pypa/gh-action-pypi-publish in the actions group (pydata#9460)
  Repo checker (pydata#9450)
  Add days_in_year and decimal_year to dt accessor (pydata#9105)
  remove parent argument from DataTree.__init__ (pydata#9465)
  Fix inheritance in DataTree.copy() (pydata#9457)
  Implement `DataTree.__delitem__` (pydata#9453)
  Add ASV for datatree.from_dict (pydata#9459)
  Make the first argument in DataTree.from_dict positional only (pydata#9446)
  Fix typos across the code, doc and comments (pydata#9443)
  ...
dcherian added a commit to dcherian/xarray that referenced this pull request Sep 17, 2024
@dcherian
Merge branch 'main' into groupby-shuffle
0679d2b 
* main: (29 commits)
  Release notes for v2024.09.0 (pydata#9480)
  Fix `DataTree.coords.__setitem__` by adding `DataTreeCoordinates` class (pydata#9451)
  Rename DataTree's "ds" and "data" to "dataset" (pydata#9476)
  Update DataTree repr to indicate inheritance (pydata#9470)
  Bump pypa/gh-action-pypi-publish in the actions group (pydata#9460)
  Repo checker (pydata#9450)
  Add days_in_year and decimal_year to dt accessor (pydata#9105)
  remove parent argument from DataTree.__init__ (pydata#9465)
  Fix inheritance in DataTree.copy() (pydata#9457)
  Implement `DataTree.__delitem__` (pydata#9453)
  Add ASV for datatree.from_dict (pydata#9459)
  Make the first argument in DataTree.from_dict positional only (pydata#9446)
  Fix typos across the code, doc and comments (pydata#9443)
  DataTree should not be "Generic" (pydata#9445)
  Disallow passing a DataArray as data into the DataTree constructor (pydata#9444)
  Support additional dtypes in `resample` (pydata#9413)
  Shallow copy parent and children in DataTree constructor (pydata#9297)
  Bump minimum versions for dependencies (pydata#9434)
  Always include at least one category in random test data (pydata#9436)
  Avoid deep-copy when constructing groupby codes (pydata#9429)
  ...
hollymandel pushed a commit to hollymandel/xarray that referenced this pull request Sep 23, 2024
@shoyer @hollymandel
Rename DataTree's "ds" and "data" to "dataset" (pydata#9476)
96f2282 
* Rename DataTree's "ds" and "data" to "dataset"

.ds is kept around as a soft-deprecated alias to facilitate the
transition from xarray-contrib/datatree, though I verified that all
tests pass without it.

* fix data= usage in test_formatting_html.py

* fix formatting test
hollymandel pushed a commit to hollymandel/xarray that referenced this pull request Sep 23, 2024
@etienneschalk @TomNicholas @hollymandel
Make illegal path-like variable names when constructing a DataTree fr…
32f9813 
…om a Dataset (pydata#9378)

* Make illegal path-like variable names when constructing a DataTree from a Dataset

* Updated whats-new.rst

* PR comments

* Revert diff

* Update xarray/core/datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update xarray/core/datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update xarray/tests/test_datatree.py

Co-authored-by: Tom Nicholas <tom@cworthy.org>

* Update expected Exception message in test

* Merge changes from pydata#9476

* Fix

---------

Co-authored-by: Tom Nicholas <tom@cworthy.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TomNicholas TomNicholas TomNicholas approved these changes

Assignees

No one assigned

Labels

topic-DataTree Related to the implementation of a DataTree class

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@shoyer @TomNicholas