FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

FIX: Return value instead of enum in get_capstyle/_joinstyle by StefRe · Pull Request #22055 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

FIX: Return value instead of enum in get_capstyle/_joinstyle - #22055

Merged
QuLogic merged 1 commit into
matplotlib:mainfrom
StefRe:fix/get_cap_join_style_return_value
Jan 14, 2022
ConversationCommits (1)ChecksFiles changed
Merged

FIX: Return value instead of enum in get_capstyle/_joinstyle#22055
QuLogic merged 1 commit into
matplotlib:mainfrom
StefRe:fix/get_cap_join_style_return_value

Conversation

StefRe commented Dec 27, 2021

Copy link
Copy Markdown
Contributor

PR Summary

There's an API inconsistency in the return values of get_capstyle / get_joinstyle: For Line2D, Collections and GraphicsContextBase they return a string whereas for MarkerStyle and Patch they return an enum object, see also #21979 (comment).

_enums was introduced in #18544 in mpl 3.4.0 without being mentioned in the release notes. Its documentation states:

The classes in this module are used internally and serve to document these concepts formally.

From this I conclude that the enum should not leak out to the user, i.e. get_capstyle / get_joinstyle should return as string for MarkerStyle and Patch too. 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

  • [N/A ] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A ] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

FIX: Return value instead of enum in get_capstyle/_joinstyle
3f1fbfc 
for MarkerStyle and Patch (as do Line2D, Collections and GraphicsContextBase)

StefRe commented Dec 27, 2021

Copy link
Copy Markdown
Contributor Author

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?

dstansby commented Dec 27, 2021

Copy link
Copy Markdown
Member

It looks like at least some errors were package download related. I've restarted the tests to see if another run works.

QuLogic merged commit 7388222 into matplotlib:main Jan 14, 2022
QuLogic added this to the v3.6.0 milestone Jan 14, 2022
StefRe deleted the fix/get_cap_join_style_return_value branch January 14, 2022 07:11
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request May 6, 2023
Accept strings for {Cap,Join}Style in MarkerStyle
a34ee57 
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
Accept strings for {Cap,Join}Style in MarkerStyle
6bb1f87 
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 mentioned this pull request May 6, 2023
Merged
1 task done
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request May 31, 2023
Accept strings for {Cap,Join}Style in MarkerStyle
f95e9b6 
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
Accept strings for {Cap,Join}Style in MarkerStyle
39f341c 
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
Accept strings for {Cap,Join}Style in MarkerStyle
5e9b66c 
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.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Accept strings for {Cap,Join}Style in MarkerStyle
0ddfa52 
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.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Accept strings for {Cap,Join}Style in MarkerStyle
1a5778d 
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.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Accept strings for {Cap,Join}Style in MarkerStyle
88f07ba 
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.
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
Accept strings for {Cap,Join}Style in MarkerStyle
442f164 
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.
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

QuLogic QuLogic approved these changes
anntzer anntzer approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v3.6.0

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL