FIX: Return value instead of enum in get_capstyle/_joinstyle #22055
Conversation
This file contains 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
for MarkerStyle and Patch (as do Line2D, Collections and GraphicsContextBase)
|
The errors in setting up the test environment
appear to be unrelated to the PR itself. What should I do in such a case - just force push once more? |
|
It looks like at least some errors were package download related. I've restarted the tests to see if another run works. |
anntzer
approved these changes
Jan 13, 2022
QuLogic
approved these changes
Jan 14, 2022
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
There's an API inconsistency in the return values of
get_capstyle/get_joinstyle: ForLine2D,CollectionsandGraphicsContextBasethey return a string whereas forMarkerStyleandPatchthey return an enum object, see also #21979 (comment)._enumswas introduced in #18544 in mpl 3.4.0 without being mentioned in the release notes. Its documentation states:From this I conclude that the enum should not leak out to the user, i.e.
get_capstyle/get_joinstyleshould return as string forMarkerStyleandPatchtoo. As the change from string to enum as not mentioned in the release note I guess changing it back is not an API change but a bug fix and it doesn't need not be documented (see Checklist below).PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).