Simplify connection of the default key_press and button_press handlers. #17110
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
tacaswell
approved these changes
Apr 12, 2020
timhoffm
approved these changes
Apr 12, 2020
|
Should this get an "API changes" entry even though it's not breaking? IMHO this is a relevant simplification also for users. |
It likely doesn't make much sense to call `key_press_handler` or
`button_press_handler` with `canvas != event.canvas` or
`toolbar != event.canvas.toolbar` (the default Toolbar constructor sets
itself as this attribute on the canvas), so we can just make these
parameters optional and fill them in from `event`. This means that
connecting these handlers is now just
`canvas.mpl_connect("key_press_event", key_press_handler)`, rather than
having to create an intermediate function to adjust the signature (see
change in embedding_in_tk_sgskip.py).
`canvas` and `toolbar` could probably even be deleted, but I'm not sure
the API change is actually worth it -- plus there may be someone
somewhere who actually has a use case for `toolbar` not matching
`event.canvas.toolbar`...
b3f48a3 to
3e66047
Compare
|
sure, added whatsnew |
7 tasks
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.
It likely doesn't make much sense to call
key_press_handlerorbutton_press_handlerwithcanvas != event.canvasortoolbar != event.canvas.toolbar(the default Toolbar constructor setsitself as this attribute on the canvas), so we can just make these
parameters optional and fill them in from
event. This means thatconnecting these handlers is now just
canvas.mpl_connect("key_press_event", key_press_handler), rather thanhaving to create an intermediate function to adjust the signature (see
change in embedding_in_tk_sgskip.py).
canvasandtoolbarcould probably even be deleted, but I'm not surethe API change is actually worth it -- plus there may be someone
somewhere who actually has a use case for
toolbarnot matchingevent.canvas.toolbar...PR Summary
PR Checklist