Deprecate arg-less calls to subplot_class_factory (and similar factories) #16576
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
timhoffm
reviewed
Feb 28, 2020
| cbook.warn_deprecated( | ||
| "3.3", message="Support for passing None to " | ||
| "parasite_axes_auxtrans_class_factory is deprecated; explicitly " | ||
| "pass the default Axes class instead.") |
There was a problem hiding this comment.
Why not be explicit:
...; explicitly pass ParasiteAxes instead.
Same for the other warnings.
There was a problem hiding this comment.
Done. For the others the default is Axes (well, whatever Axes is in that current module).
e6e1599 to
eb9d28e
Compare
timhoffm
approved these changes
Feb 28, 2020
QuLogic
approved these changes
Mar 11, 2020
| @@ -186,6 +186,9 @@ def subplot_class_factory(axes_class=None): | |||
| not have to be created for every type of Axes. | |||
| """ | |||
| if axes_class is None: | |||
| cbook.warn_deprecated( | |||
| "3.3", message="Support for passing None to subplot_class_factory " | |||
There was a problem hiding this comment.
Same thing about the alignment here (and below) as the other PR.
There was a problem hiding this comment.
at least for deprecations this pattern is common through the codebase, as can be checked with git grep -A2 'message=')
…ies). Explicitly passing the base class is not too onerous; end users should typically not have to handle the arg-less case because we provide these classes at the toplevel anyways (`Subplot`, `ParasiteAxes`, etc.), and this refactor should ultimately help with factoring all these factories together, in particular to make mpl_toolkits Axes picklable (right now they aren't) without duplicating the somewhat heavy machinery that makes Subplots picklable (_picklable_subplot_class_constructor, etc.).
eb9d28e to
479b8f8
Compare
|
rebased, I think that's the last one for now so I'll let either of you do the merge :) |
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.
Explicitly passing the base class is not too onerous; end users should
typically not have to handle the arg-less case because we provide these
classes at the toplevel anyways (
Subplot,ParasiteAxes, etc.), andthis refactor should ultimately help with factoring all these factories
together, in particular to make mpl_toolkits Axes picklable (right now
they aren't) without duplicating the somewhat heavy machinery that makes
Subplots picklable (_picklable_subplot_class_constructor, etc.).
PR Summary
PR Checklist