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

TYP: Clean up CapStyle/FillStyle type hints by ksunden · Pull Request #25719 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

TYP: Clean up CapStyle/FillStyle type hints - #25719

Merged
oscargus merged 2 commits into
matplotlib:mainfrom
ksunden:style_str
Apr 19, 2023
ConversationCommits (2)ChecksFiles changed
Merged

TYP: Clean up CapStyle/FillStyle type hints#25719
oscargus merged 2 commits into
matplotlib:mainfrom
ksunden:style_str

Conversation

ksunden commented Apr 18, 2023

Copy link
Copy Markdown
Member

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

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

TYP: Clean up CapStyle/FillStyle type hints
41c530e 
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
View reviewed changes
Comment thread lib/matplotlib/typing.py Outdated
py39 compatibility in typing.py
83b71d0 
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
QuLogic reviewed Apr 18, 2023
View reviewed changes
Comment thread lib/matplotlib/collections.pyi
oscargus added this to the v3.8.0 milestone Apr 19, 2023
oscargus merged commit 5dca030 into matplotlib:main Apr 19, 2023
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

Assignees

No one assigned

Labels

topic: typing

Projects

None yet

Milestone

v3.8.0

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL