Skip to content

[MNT] Typing: correct typing overloads for Figure.subfigures #30314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
+14 −1
Merged

[MNT] Typing: correct typing overloads for Figure.subfigures #30314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion lib/matplotlib/figure.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,11 +191,24 @@ class FigureBase(Artist):
def align_labels(self, axs: Iterable[Axes] | None = ...) -> None: ...
def add_gridspec(self, nrows: int = ..., ncols: int = ..., **kwargs) -> GridSpec: ...
@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 = ...,
Comment on lines 193 to 214
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 squeeze is passed positionally
  • when squeeze is passed by name

Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy