Add inherit=False option to DataTree.copy() #9628
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds a inherit=False option to DataTree.copy, so users can decide if they want to inherit coordinates from parents or not when creating a subtree. The default behavior is `inherit=True`, which is a breaking change from the current behavior where parent coordinates are dropped (which I believe should be considered a bug).
TomNicholas
added
the
topic-DataTree
TomNicholas
approved these changes
Oct 15, 2024
There was a problem hiding this comment.
👍
I'm about to merge #9598, so it would be great if any further behaviour changes could get a corresponding small entry in the API Changes section of that doc.
headtr1ck
reviewed
Oct 15, 2024
| also be copied onto the new tree. Only relevant if the `parent` of | ||
| this node is not yet, and "Inherited coordinates" appear in its | ||
| repr. | ||
| deep : bool |
There was a problem hiding this comment.
Suggested change
| deep : bool | |
| deep : bool, default: False |
| def __deepcopy__(self: Tree, memo: dict[int, Any] | None = None) -> Tree: | ||
| return self._copy_subtree(deep=True, memo=memo) | ||
| def __deepcopy__(self, memo: dict[int, Any] | None = None) -> Self: | ||
| del memo # nodes cannot be reused in a DataTree |
There was a problem hiding this comment.
Not sure what this has to do with the memo. The memo is a kind of cache of deeply-copied objects that prevents recursion issues.
Not sure if our DataTree model allows recursive subtrees... (I guess your comment is trying to say, that the answer is no?)
But we had issues in the past where people were using recursively linked attributes.
|
Wow, again too slow with my review, haha! |
shoyer
added a commit
to shoyer/xarray
that referenced
this pull request
Oct 15, 2024
as suggested by @headtr1ck in pydata#9628 (comment)
shoyer
added a commit
that referenced
this pull request
Oct 15, 2024
as suggested by @headtr1ck in #9628 (comment)
|
Sorry @headtr1ck - we appreciate the reviews nonetheless. Normally we would leave ~1 day before merging PRs but for various reasons we're in a bit of a rush with this right now 🙃 |
dcherian
added a commit
to TomAugspurger/xarray
that referenced
this pull request
Oct 21, 2024
* main: Fix multiple grouping with missing groups (pydata#9650) flox: Properly propagate multiindex (pydata#9649) Update Datatree html repr to indicate inheritance (pydata#9633) Re-implement map_over_datasets using group_subtrees (pydata#9636) fix zarr intersphinx (pydata#9652) Replace black and blackdoc with ruff-format (pydata#9506) Fix error and missing code cell in io.rst (pydata#9641) Support alternative names for the root node in DataTree.from_dict (pydata#9638) Updates to DataTree.equals and DataTree.identical (pydata#9627) DOC: Clarify error message in open_dataarray (pydata#9637) Add zip_subtrees for paired iteration over DataTrees (pydata#9623) Type check datatree tests (pydata#9632) Add missing `memo` argument to DataTree.__deepcopy__ (pydata#9631) Bug fixes for DataTree indexing and aggregation (pydata#9626) Add inherit=False option to DataTree.copy() (pydata#9628) docs(groupby): mention deprecation of `squeeze` kwarg (pydata#9625) Migration guide for users of old datatree repo (pydata#9598) Reimplement Datatree typed ops (pydata#9619)
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Oct 22, 2024
* main: (63 commits) Add close() method to DataTree and use it to clean-up open files in tests (pydata#9651) Change URL for pydap test (pydata#9655) Fix multiple grouping with missing groups (pydata#9650) flox: Properly propagate multiindex (pydata#9649) Update Datatree html repr to indicate inheritance (pydata#9633) Re-implement map_over_datasets using group_subtrees (pydata#9636) fix zarr intersphinx (pydata#9652) Replace black and blackdoc with ruff-format (pydata#9506) Fix error and missing code cell in io.rst (pydata#9641) Support alternative names for the root node in DataTree.from_dict (pydata#9638) Updates to DataTree.equals and DataTree.identical (pydata#9627) DOC: Clarify error message in open_dataarray (pydata#9637) Add zip_subtrees for paired iteration over DataTrees (pydata#9623) Type check datatree tests (pydata#9632) Add missing `memo` argument to DataTree.__deepcopy__ (pydata#9631) Bug fixes for DataTree indexing and aggregation (pydata#9626) Add inherit=False option to DataTree.copy() (pydata#9628) docs(groupby): mention deprecation of `squeeze` kwarg (pydata#9625) Migration guide for users of old datatree repo (pydata#9598) Reimplement Datatree typed ops (pydata#9619) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a inherit=False option to DataTree.copy, so users can decide if they want to inherit coordinates from parents or not when creating a subtree.
The default behavior is
inherit=True, which is a breaking change from the current behavior where parent coordinates are dropped (which I believe should be considered a bug).