MNT: make signature of GridSpec.update explicit #29956
Merged
+40
−17
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
4 tasks
QuLogic
reviewed
Apr 22, 2025
Comment on lines
20
to
+21
| from matplotlib import _api, _pylab_helpers, _tight_layout | ||
| from matplotlib._api import UNSET as _UNSET |
There was a problem hiding this comment.
We already have _api imported above, though I guess it makes the signature too long?
There was a problem hiding this comment.
Yes, the idea is to make the signature more readable, but no strong preference.
Previously, it used **kwargs, because it needs to distinguish between "value not given" and given value is None. A while ago, we have introduced the UNSET sentinel for these cases (in the context of Artist .set()). The PR moves this sentinel to `matplotlib._api` to make it usable also for gridspec. Technically, there's an API change here, because the old code raised an AttibuteError for invalid keys. This is now a TypeError by the standards when an invalid keyword argument is used. I consider the old behavior suboptimal as it was not adhereing to standards. I will let the change go without notice because I assume nobody will explicitly catch the exception of an invalid parameter name passed to `GridSpec.update()`.
25983bd to
b8673bd
Compare
QuLogic
approved these changes
Apr 22, 2025
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.
Previously, it used **kwargs, because it needs to distinguish between "value not given" and given value is None. A while ago, we have introduced the UNSET sentinel for these cases (in the context of Artist .set()). The PR moves this sentinel to
matplotlib._apito make it usable also for gridspec.Technically, there's an API change here, because the old code raised an AttibuteError for invalid keys. This is now a TypeError by the standards when an invalid keyword argument is used. I consider the old behavior suboptimal as it was not adhereing to standards. I will let the change go without notice because I assume nobody will explicitly catch the exception of an invalid parameter name passed to
GridSpec.update().