widgets: use a shared _Buttons class for {Radio,Check}Buttons#30997
Merged
timhoffm merged 5 commits intomatplotlib:mainfrom Jan 23, 2026
Merged
widgets: use a shared _Buttons class for {Radio,Check}Buttons#30997timhoffm merged 5 commits intomatplotlib:mainfrom
timhoffm merged 5 commits intomatplotlib:mainfrom
Conversation
For more consistency and similarity with RadioButtons
5 tasks
doronbehar
force-pushed
the
_Buttons
branch
2 times, most recently
from
c5ee840 to
b1eb725
Compare
timhoffm
reviewed
Jan 19, 2026
Member
timhoffm
left a comment
timhoffm
left a comment
There was a problem hiding this comment.
Please add an entry to widget_api.rst
|
|
||
|
|
||
| class CheckButtons(AxesWidget): | ||
| class _Buttons(AxesWidget): |
Member
There was a problem hiding this comment.
Please add a docstring.
The class should be treated analogous to _SelectorWidget, including
The class itself is private and may be changed or removed without prior warning.
However, the public API it provides to subclasses is stable and considered
public on the subclasses.
Contributor
Author
There was a problem hiding this comment.
Please add a docstring.
Done.
story645
approved these changes
Jan 23, 2026
Member
story645
left a comment
story645
left a comment
There was a problem hiding this comment.
I assume that this is just the move things phase and code changes will happen in the follow up? Also thanks for doing this!
Share all the trivial functions which are identical without any further modifications.
doronbehar
commented
Jan 23, 2026
|
|
||
| self._useblit = useblit | ||
|
|
||
| self._buttons_ys = np.linspace(1, 0, len(labels)+2)[1:-1] |
Contributor
Author
There was a problem hiding this comment.
(Answering in a code review in order to explain better)
I assume that this is just the move things phase and code changes will happen in the follow up? Also thanks for doing this!
Correct. In the next PR the _Buttons class will also gain a self._buttons_xs attribute, which will be used when creating the _buttons in _init_props. As for self.labels, they will be created with the algorithm written in the previous PR, but with mtext.Text instanced once etc.
timhoffm
approved these changes
Jan 23, 2026
Member
|
This broke some cross-references, but it was hidden by the docs build being broken; I'll fix it in #31020. |
doronbehar
added a commit
to doronbehar/matplotlib
that referenced
this pull request
Jan 24, 2026
In matplotlib#30997 the classes `RadioButtons` & `CheckButtons` started sharing more code, as they are fundamentally similar. When copy-pasting the methods that were seemingly identical, the `_clicked` method was copied from the original `CheckButtons` class, and there the `self._frames` object was used instead of `self._buttons`. This caused an error when actually using and clicking on buttons created with `RadioButtons`, as the `RadioButtons._frames` doesn't exist - something that unfortunately the tests did not catch. Both `CheckButtons._frames` and `CheckButtons._buttons` are very similar so even before matplotlib#30997 the `CheckButtons._clicked` method could have used `self._checks` and not `self._frames`. Hence this change should be harmless.
1 task
Contributor
Author
|
Another fixup change that I noticed is needed when rewriting #30803 : |
doronbehar
added a commit
to doronbehar/matplotlib
that referenced
this pull request
Jan 28, 2026
In matplotlib#30997 the classes `RadioButtons` & `CheckButtons` started sharing more code, as they are fundamentally similar. When copy-pasting the methods that were seemingly identical, the `_clicked` method was copied from the original `CheckButtons` class, and there the `self._frames` object was used instead of `self._buttons`. This caused an error when actually using and clicking on buttons created with `RadioButtons`, as the `RadioButtons._frames` doesn't exist - something that unfortunately the tests did not catch. Both `CheckButtons._frames` and `CheckButtons._buttons` are very similar so even before matplotlib#30997 the `CheckButtons._clicked` method could have used `self._checks` and not `self._frames`. Hence this change should be harmless.
doronbehar
added a commit
to doronbehar/matplotlib
that referenced
this pull request
Jan 29, 2026
In matplotlib#30997 the classes `RadioButtons` & `CheckButtons` started sharing more code, as they are fundamentally similar. When copy-pasting the methods that were seemingly identical, the `_clicked` method was copied from the original `CheckButtons` class, and there the `self._frames` object was used instead of `self._buttons`. This caused an error when actually using and clicking on buttons created with `RadioButtons`, as the `RadioButtons._frames` doesn't exist - something that unfortunately the tests did not catch. Both `CheckButtons._frames` and `CheckButtons._buttons` are very similar so even before matplotlib#30997 the `CheckButtons._clicked` method could have used `self._checks` and not `self._frames`. Hence this change should be harmless.
doronbehar
added a commit
to doronbehar/matplotlib
that referenced
this pull request
Jan 29, 2026
In matplotlib#30997 the classes `RadioButtons` & `CheckButtons` started sharing more code, as they are fundamentally similar. When copy-pasting the methods that were seemingly identical, the `_clicked` method was copied from the original `CheckButtons` class, and there the `self._frames` object was used instead of `self._buttons`. This caused an error when actually using and clicking on buttons created with `RadioButtons`, as the `RadioButtons._frames` doesn't exist - something that unfortunately the tests did not catch. Both `CheckButtons._frames` and `CheckButtons._buttons` are very similar so even before matplotlib#30997 the `CheckButtons._clicked` method could have used `self._checks` and not `self._frames`. Hence this change should be harmless.
doronbehar
added a commit
to doronbehar/matplotlib
that referenced
this pull request
Jan 29, 2026
In matplotlib#30997 the classes `RadioButtons` & `CheckButtons` started sharing more code, as they are fundamentally similar. When copy-pasting the methods that were seemingly identical, the `_clicked` method was copied from the original `CheckButtons` class, and there the `self._frames` object was used instead of `self._buttons`. This caused an error when actually using and clicking on buttons created with `RadioButtons`, as the `RadioButtons._frames` doesn't exist - something that unfortunately the tests did not catch. Both `CheckButtons._frames` and `CheckButtons._buttons` are very similar so even before matplotlib#30997 the `CheckButtons._clicked` method could have used `self._checks` and not `self._frames`. Hence this change should be harmless.
QuLogic
added a commit
that referenced
this pull request
Jan 30, 2026
RadioButtons: fix self._clicked method (followup to #30997)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
A preparation refactoring commit for #30803 . Changes include:
PR checklist