TYP: Clean up CapStyle/FillStyle type hints #25719
Merged
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
Inputs generally accept either the enum or the raw string (literal), outputs are only the string literals plotnine passes string literals, which are accepted, but did not previously type check
QuLogic
reviewed
Apr 18, 2023
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
QuLogic
reviewed
Apr 18, 2023
QuLogic
approved these changes
Apr 18, 2023
QuLogic
added a commit
to QuLogic/matplotlib
that referenced
this pull request
May 6, 2023
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
QuLogic
added a commit
to QuLogic/matplotlib
that referenced
this pull request
May 6, 2023
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
QuLogic
added a commit
to QuLogic/matplotlib
that referenced
this pull request
May 31, 2023
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
devRD
pushed a commit
to devRD/matplotlib
that referenced
this pull request
Jun 5, 2023
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
melissawm
pushed a commit
to melissawm/matplotlib
that referenced
this pull request
Jun 15, 2023
When these Enum classes were added in matplotlib#18544, they were supposed to be for documentation only. To that end, matplotlib#22055 was a followup that ensured that only the strings were exposed from the getter side. However, when user-supplied cap/join style were added in matplotlib#20914, they were only for the Enum type instead of the string, so correctly allow strings here as well. Also, specifically type hint the return values as literals, as was done in matplotlib#25719.
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.
PR Summary
Inputs generally accept either the enum or the raw string (literal), outputs are only the string literals
plotnine passes string literals, which are accepted, but did not previously type check
This ensures for instance that
obj.set_capstyle(obj.get_capstyle())type checks, while also not misrepresenting the return type.Enums are a bit odd, as they do inherit from
str(for these cases), and so it kind of works, but we actually return[Cap|Join]Style.name, not the instance itself.We know this to be a limited set of literals, so type hint it as such.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst