Skip to content

Add explicit overloads for pyplot.{show,subplot} #30202

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 7 commits into from
Jun 27, 2025
+20 −1
Merged

Add explicit overloads for pyplot.{show,subplot} #30202

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
162cc97
Create show overloads on pyplot.py
CorenthinZ Jun 19, 2025
36299b6
Create subplot overloads on pyplot.py
CorenthinZ Jun 19, 2025
ad14a98
Removed subplot(Axes) on overloads and docstring
ZPyrolink Jun 24, 2025
603c082
Update show overloads
ZPyrolink Jun 24, 2025
1061d2a
Correct mypy error
ZPyrolink Jun 24, 2025
12c5811
Add typing to overloaded copy of show
ZPyrolink Jun 24, 2025
768e69b
Revert superfluous changes
ZPyrolink Jun 24, 2025
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
21 changes: 20 additions & 1 deletion lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,14 @@ def draw_if_interactive(*args, **kwargs):
return _get_backend_mod().draw_if_interactive(*args, **kwargs)


@overload
def show(*, block: bool, **kwargs) -> None: ...


@overload
def show(*args: Any, **kwargs: Any) -> None: ...


# This function's signature is rewritten upon backend-load by switch_backend.
def show(*args, **kwargs) -> None:
"""
Expand Down Expand Up @@ -1393,6 +1401,18 @@ def cla() -> None:

## More ways of creating Axes ##

@overload
def subplot(nrows: int, ncols: int, index: int, /, **kwargs): ...


@overload
def subplot(pos: int | SubplotSpec, /, **kwargs): ...


@overload
def subplot(**kwargs): ...


@_docstring.interpd
def subplot(*args, **kwargs) -> Axes:
"""
Expand All @@ -1406,7 +1426,6 @@ def subplot(*args, **kwargs) -> Axes:
subplot(nrows, ncols, index, **kwargs)
subplot(pos, **kwargs)
subplot(**kwargs)
subplot(ax)

Parameters
----------
Expand Down