Fix sortby raising KeyError when passed a tuple of dimension names#11297
Open
thodson-usgs wants to merge 1 commit intopydata:mainfrom
Open
Fix sortby raising KeyError when passed a tuple of dimension names#11297thodson-usgs wants to merge 1 commit intopydata:mainfrom
thodson-usgs wants to merge 1 commit intopydata:mainfrom
Conversation
419f4ac to
0de98c3
Compare
Closes pydata#4821 Co-authored-by: Claude <noreply@anthropic.com>
ce5537d to
8e362ee
Compare
headtr1ck
reviewed
Apr 15, 2026
| def sortby( | ||
| self, | ||
| variables: ( | ||
| Hashable |
Collaborator
There was a problem hiding this comment.
Could you update the type hints as well?
Should probably be
str | DataArray | Iterable[Hashable | DataArray] | Callable[[Self], str | DataArray | Iterable[Hashable | DataArray]]
Same with the docstring and the DataArray method.
Thanks!
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
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.
Summary
da.sortby(da.dims)raisingKeyErrorwhenda.dimsis a tuple (e.g.('x', 'y'))str | Iterable[Hashable]convention established in dimensions: type asstr | Iterable[Hashable]? #6142Closes #4821
Usage example
Test plan
da.sortby(da.dims)works whenda.dimsis a tuple of dimension namesds.sortby(("x", "y"))sorts by both dimensions[This is Claude Code on behalf of Timothy Hodson]