Fix MarkerStyle types #25825
Merged
Fix MarkerStyle types #25825
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
ksunden
approved these changes
May 10, 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.
It is not possible for `get_marker` to return another `MarkerStyle`; the `__init__` only takes one to make a full copy of it. And `get_alt_path` is only available for e.g., half-filled markers, but not all.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
When the {Cap,Join}Style Enum classes were added in #18544, they were supposed to be for documentation only. To that end, #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 #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 #25719.
It is not possible for
get_markerto return anotherMarkerStyle; the__init__only takes one to make a full copy of it. Andget_alt_pathis only available for e.g., half-filled markers, but not all.PR checklist