[MNT] Typing: correct typing overloads for Figure.subfigures
#30314
+14
−1
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
MarcoGorelli
commented
Jul 15, 2025
Comment on lines
193
to
214
| @overload | ||
| def subfigures( | ||
| self, | ||
| nrows: int, | ||
| ncols: int, | ||
| squeeze: Literal[False], | ||
| wspace: float | None = ..., | ||
| hspace: float | None = ..., | ||
| width_ratios: ArrayLike | None = ..., | ||
| height_ratios: ArrayLike | None = ..., | ||
| **kwargs | ||
| ) -> np.ndarray: ... | ||
| @overload | ||
| def subfigures( | ||
| self, | ||
| nrows: int = ..., | ||
| ncols: int = ..., | ||
| squeeze: Literal[False] = ..., | ||
| *, | ||
| squeeze: Literal[False], | ||
| wspace: float | None = ..., | ||
| hspace: float | None = ..., | ||
| width_ratios: ArrayLike | None = ..., |
There was a problem hiding this comment.
the previous overloads had squeeze: Literal[False] = ..., indicating that False is the default, even though the default is True
We can't just remove the = ... part, because Python doesn't allow default arguments (nrows, ncols) to be followed by non-default ones
So, we need two extra overloads:
- when
squeezeis passed positionally - when
squeezeis passed by name
Figure.subfiguresFigure.subfigures
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
closes #30313
PR checklist