modification methods on Coordinates
#10318
Conversation
| @@ -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?
There was a problem hiding this comment.
not really, but it serves as a comment in this case. No need to copy everything, though, so we can remove everything but the first line and add a See Also section to Coordinates.merge
There was a problem hiding this comment.
It looks like we're generating documentation pages for __setitem__ and __getitem__. Not sure if this actually makes sense, but following that I added a page for __or__ so we actually do need the full docstring.
| 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.
|
in 22c89e3 I fixed any complaints |
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