Deprecate accepting arbitrary parameters in some get_window_extent() methods #22123
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
2478913 to
22bb527
Compare
anntzer
reviewed
Jan 6, 2022
lib/matplotlib/axes/_base.py
Outdated
| "3.6", | ||
| message="Passing any argument except 'renderer' to " | ||
| "Axes.get_window_extent is deprecated in Matplotlib " | ||
| "%(since)s and will be removed %(removal)s") |
There was a problem hiding this comment.
I think(?) that's basically
@_api.deprecated("3.6", "args")
@_api.deprecated("3.6", "kwargs")
def get_window_extend(self, *args, renderer=None, **kwargs): ...There was a problem hiding this comment.
That would warn for get_window_extent(renderer) and get_window_extent(renderer=r), which we should still support to be consistent with Artist.get_window_extent.
There was a problem hiding this comment.
Sorry, I think the correct invocation is
@_api.delete_parameter("3.6", "args")
@_api.delete_parameter("3.6", "kwargs")
def gwe(self, renderer=None, *args, **kwargs): ...?
tacaswell
approved these changes
Jan 6, 2022
|
Missed @anntzer 's comment while reviewing. Slight preference to go with the tooling, but OK with it going in either way. |
22bb527 to
56b1ccb
Compare
anntzer
approved these changes
Jan 6, 2022
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.
PR Summary
This will align the API with the general
.Artist.get_window_extentAPI.All parameters were ignored anyway.
After the deprecation, we'll use
get_window_extent(renderer=None).