NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

backend_bases.pyi:`@overloadFigureCanvasBase.mpl_connect()` for different event types#29898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

oscargus merged 1 commit intomatplotlib:mainfromanabelle2001:my_revision

Apr 10, 2025

Merged

backend_bases.pyi:`@overloadFigureCanvasBase.mpl_connect()` for different event types#29898

oscargus merged 1 commit intomatplotlib:mainfromanabelle2001:my_revision

Apr 10, 2025

Conversation

Copy link

Contributor

anabelle2001 commentedApr 10, 2025

PR summary

What problem does it solve?

I've found it a bit annoying that my type checker complains when i pass in a functionf: Callable[[PickEvent],Any] tompl_connect("pick_event",f). This PR adds@overloads to tell type checkers like pyright that you can do that.

What is the reasoning for this implementation?

I thought about putting the strings inside a underscored variable, but wasn't sure if it made more sense than just listing them out. I also thought about using ruff, but i didn't want to mess with L509,511.

PR checklist

[N/A] "closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
[N/A]Plotting related features are demonstrated in anexample
[N/A]New Features andAPI Changes are noted with adirective and release note
[N/A] Documentation complies withgeneral anddocstring guidelines

backend_bases.pyi: narrow mpl_connect using overloads

e879919

github-actionsbot added the topic: canvas and figure manager label

Apr 10, 2025

github-actionsbot reviewed

Apr 10, 2025

View reviewed changes

Copy link

github-actionsbot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join uson gitter for real-time discussion.

For details on testing, writing docs, and our review process, please seethe developer guide

We strive to be a welcoming and open project. Please follow ourCode of Conduct.