In the new/simplified backend API, don't customize draw_if_interactive. #23291
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
9ff890b to
2db643e
Compare
QuLogic
approved these changes
Jul 6, 2022
tacaswell
reviewed
Jul 7, 2022
lib/matplotlib/pyplot.py
Outdated
| @@ -303,6 +302,7 @@ def new_figure_manager(num, *args, FigureClass=Figure, **kwargs): | |||
| backend_mod.new_figure_manager_given_figure = \ | |||
| new_figure_manager_given_figure | |||
| backend_mod.new_figure_manager = new_figure_manager | |||
| backend_mod.draw_if_interactive = matplotlib.backend_bases._Backend | |||
There was a problem hiding this comment.
Actually this should just use a local reimplementation (to avoid the check on _Backend.mainloop, which is wrong here as third-parties will not have overridden that), fixed.
The customization point is not really needed (it can go into the canvas constructor or manager.show or a few other places), but removing support for it would be a bit tricky if not coupled with the introduction of a new API (manager_class). This way, we can simply say "if you want to use the new API, then you cannot customize draw_if_interactive". backend_template gets updated without deprecation as the point of that backend is really to be documentation for what a backend module is; moreover, putting a deprecation on new_figure_manager (for example) would actually be counter-productive as pyplot would still try to call that function (and thus emit a warning, even though the backend itself is not deprecated).
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.
The customization point is not really needed (it can go into the canvas
constructor or manager.show or a few other places), but removing support
for it would be a bit tricky if not coupled with the introduction of a
new API (manager_class). This way, we can simply say "if you want to
use the new API, then you cannot customize draw_if_interactive".
backend_template gets updated without deprecation as the point of that
backend is really to be documentation for what a backend module is;
moreover, putting a deprecation on new_figure_manager (for example)
would actually be counter-productive as pyplot would still try to call
that function (and thus emit a warning, even though the backend itself
is not deprecated).
Closes #23105. See that PR for a more detailed discussion.
Once merged, the documentation added at #23101 will need a slight tweak as well.
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).