modification methods on Coordinates
#10318
Open
Conversation
This file contains hidden or 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
benbovy
approved these changes
May 14, 2025
Comment on lines
+814
to
+815
| renamed : Dataset | ||
| Dataset with renamed variables including coordinates |
There was a problem hiding this comment.
Suggested change
| renamed : Dataset | |
| Dataset with renamed variables including coordinates | |
| renamed : Coordinates | |
| Coordinates object with renamed variables |
| name_dict: Mapping[Any, Hashable] | None = None, | ||
| **names: Hashable, | ||
| ) -> Self: | ||
| """Returns a new object with renamed variables including coordinates |
There was a problem hiding this comment.
Suggested change
| """Returns a new object with renamed variables including coordinates | |
| """Returns a new object with renamed variables. |
| @@ -561,6 +561,31 @@ def merge(self, other: Mapping[Any, Any] | None) -> Dataset: | |||
| variables=coords, coord_names=coord_names, indexes=indexes | |||
| ) | |||
|
|
|||
| def __or__(self, other: Self) -> Self: | |||
| """Merge two sets of coordinates to create a new Coordinates object | |||
There was a problem hiding this comment.
Do we need such docstrings for an operator?
| renamed : Coordinates | ||
| Coordinates object with renamed dimensions. | ||
| """ | ||
| return self.to_dataset().rename_dims(dims_dict, **dims).coords |
There was a problem hiding this comment.
self._data would have prevented duplicated copy of the wrapped Dataset, but it won't work with the DataArrayCoordinates subclass so I guess self.to_dataset() is fine.
| dims_dict : dict-like, optional | ||
| Dictionary whose keys are current dimension names and | ||
| whose values are the desired names. The desired names must | ||
| not be the name of an existing dimension or Variable in the Dataset. |
There was a problem hiding this comment.
Suggested change
| not be the name of an existing dimension or Variable in the Dataset. | |
| not be the name of an existing dimension or Variable in the Coordinates. |
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.
For ease of use, this implements a few additional methods on
Coordinates:rename_dimsrename_varsdrop_varscoords1 | coords2as an alias ofcoords1.merge(coords2)These currently forward to the implementation in
Dataset, but will be the natural place after refactoringCoordinatesto not wrap aDataset.Coordinatesoperations #10314whats-new.rstapi.rstcc @benbovy, @scottyhq