ENH: Type the possible str legend locs as Literals #29465
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
f608a46 to
92eba37
Compare
timhoffm
commented
Jan 12, 2025
| @@ -60,13 +60,16 @@ class Axes(_AxesBase): | ||
| @overload | ||
| def legend(self) -> Legend: ... | ||
| @overload | ||
| def legend(self, handles: Iterable[Artist | tuple[Artist, ...]], labels: Iterable[str], **kwargs) -> Legend: ... | ||
| def legend(self, handles: Iterable[Artist | tuple[Artist, ...]], labels: Iterable[str], | ||
| *, loc: LegendLocType | None = ..., **kwargs) -> Legend: ... |
There was a problem hiding this comment.
I hope this works. I've pulled loc out of kwargs only for the stub; the method signature still does not contain it and handles it via kwargs instead. At least mypy doesn't complain, but I don't understand typing well enough whether that's guaranteed to work.
There was a problem hiding this comment.
It should be fine since we haven't typed kwargs, I think.
QuLogic
reviewed
Jan 17, 2025
Instead of accepting any str, we only accept as set of predefined literals. For simplicity, we don't distinguish the between allowed positions for Axes legend and figure legend. It's still better to limit the allowed range to the union of both rather than to accept abitrary strings.
92eba37 to
631e38f
Compare
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.
Instead of accepting any str, we only accept as set of predefined literals. For simplicity, we don't distinguish the between allowed positions for Axes legend and figure legend. It's still better to limit the allowed range to the union of both rather than to accept abitrary strings.
This is a bit cumbersome, but since loc names are hard to remember and easy to misspell, I believe it's a real benefit if in-editor type checkers could notify on an invalid loc name.