Standardize creation of FigureManager from a given FigureCanvas class.#22925
Merged
timhoffm merged 1 commit intomatplotlib:mainfrom May 1, 2022
Merged
Standardize creation of FigureManager from a given FigureCanvas class.#22925timhoffm merged 1 commit intomatplotlib:mainfrom
timhoffm merged 1 commit intomatplotlib:mainfrom
Conversation
12988c3 to
ad1ded4
Compare
tacaswell
approved these changes
Apr 30, 2022
timhoffm
reviewed
May 1, 2022
The `new_manager` classmethod may appear to belong more naturally to the FigureManager class rather than the FigureCanvas class, but putting it on FigureCanvas has multiple advantages: - One may want to create managers at times where all one has is a FigureCanvas instance, which may not even have a corresponding manager (e.g. `subplot_tool`). - A given FigureManager class can be associated with many different FigureCanvas classes (indeed, FigureManagerQT can manage both FigureCanvasQTAgg and FigureCanvasQTCairo and also the mplcairo Qt canvas classes), whereas we don't have multiple FigureManager classes for a given FigureCanvas class. Still, put the *actual* logic in FigureManager.create_with_canvas and access it via some indirection, as suggested by timhoffm.
ad1ded4 to
f29c3e0
Compare
timhoffm
approved these changes
May 1, 2022
This was referenced May 1, 2022
Closed
6 tasks
6 tasks
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
3 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.
The
new_managerclassmethod may appear to belong more naturally to theFigureManager class rather than the FigureCanvas class, but putting it
on FigureCanvas has multiple advantages:
FigureCanvas instance, which may not even have a corresponding manager
(e.g.
subplot_tool).FigureCanvas classes (indeed, FigureManagerQT can manage both
FigureCanvasQTAgg and FigureCanvasQTCairo and also the mplcairo Qt
canvas classes), whereas we don't have multiple FigureManager classes
for a given FigureCanvas class.
Still, put the actual logic in FigureManager.create_with_canvas and
access it via some indirection, as suggested by timhoffm (#22895).
See discussion at #18854 and #22895.
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).