Skip to content

Widen return type of pyplot.subplot_tool to object | None #31997

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

Open
karlhillx wants to merge 6 commits into
base: main
Choose a base branch
from
+6 −4
Open

Widen return type of pyplot.subplot_tool to object | None #31997

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ed03cea
Widen return type of pyplot.subplot_tool / NavigationToolbar2.configu…
karlhillx Jul 4, 2026
709e9f2
Fix ruff F811: remove Any from inner TYPE_CHECKING block
karlhillx Jul 4, 2026
f4fe5a7
Potential fix for pull request finding
karlhillx Jul 4, 2026
d2b90f0
Format subplot_tool Returns section per numpydoc
karlhillx Jul 4, 2026
e1e96ec
Use object return type for subplot_tool; generalize docstring
karlhillx Jul 6, 2026
f6d07a7
Apply timhoffm suggestion: configure_subplots returns object | None
karlhillx Jul 9, 2026
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
2 changes: 1 addition & 1 deletion lib/matplotlib/backend_bases.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ class NavigationToolbar2:
def release_zoom(self, event: Event) -> None: ...
def push_current(self) -> None: ...
subplot_tool: widgets.SubplotTool
def configure_subplots(self, *args: Any) -> widgets.SubplotTool: ...
def configure_subplots(self, *args: Any) -> Any: ...
Comment thread
karlhillx marked this conversation as resolved.
Outdated
def save_figure(self, *args) -> str | None | object: ...
def update(self) -> None: ...
def set_history_buttons(self) -> None: ...
Expand Down
9 changes: 5 additions & 4 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
import sys
import threading
import time
from typing import IO, TYPE_CHECKING, cast, overload
from typing import Any, IO, TYPE_CHECKING, cast, overload

from cycler import cycler # noqa: F401
import matplotlib
Expand Down Expand Up @@ -92,7 +92,7 @@
from collections.abc import Callable, Hashable, Iterable, Sequence
import pathlib
import os
from typing import Any, BinaryIO, Literal

Check warning on line 95 in lib/matplotlib/pyplot.py

View workflow job for this annotation

GitHub Actions / ruff 

[rdjson] reported by reviewdog 🐶
Redefinition of unused `Any` from line 57: `Any` redefined here

Raw Output:
message:"Redefinition of unused `Any` from line 57: `Any` redefined here"  location:{path:"/home/runner/work/matplotlib/matplotlib/lib/matplotlib/pyplot.py"  range:{start:{line:95  column:24}  end:{line:95  column:27}}}  severity:WARNING  source:{name:"ruff"  url:"https://docs.astral.sh/ruff"}  code:{value:"redefined-while-unused"  url:"https://docs.astral.sh/ruff/rules/redefined-while-unused"}  suggestions:{range:{start:{line:95  column:5}  end:{line:95  column:46}}  text:"from typing import BinaryIO, Literal"}

Check warning on line 95 in lib/matplotlib/pyplot.py

View workflow job for this annotation

GitHub Actions / ruff 

[rdjson] reported by reviewdog 🐶
Redefinition of unused `Any` from line 57: `Any` redefined here

Raw Output:
message:"Redefinition of unused `Any` from line 57: `Any` redefined here"  location:{path:"/home/runner/work/matplotlib/matplotlib/lib/matplotlib/pyplot.py"  range:{start:{line:95  column:24}  end:{line:95  column:27}}}  severity:WARNING  source:{name:"ruff"  url:"https://docs.astral.sh/ruff"}  code:{value:"redefined-while-unused"  url:"https://docs.astral.sh/ruff/rules/redefined-while-unused"}  suggestions:{range:{start:{line:95  column:5}  end:{line:95  column:46}}  text:"from typing import BinaryIO, Literal"}

import PIL.Image
from numpy.typing import ArrayLike
Expand Down Expand Up @@ -153,7 +153,6 @@
ResizeEventType,
LogLevel
)
from matplotlib.widgets import SubplotTool
from matplotlib._api import _Unset


Expand Down Expand Up @@ -2152,13 +2151,15 @@
return ax1


def subplot_tool(targetfig: Figure | None = None) -> SubplotTool | None:
def subplot_tool(targetfig: Figure | None = None) -> Any:
Comment thread
karlhillx marked this conversation as resolved.
Outdated
"""
Launch a subplot tool window for a figure.

Returns
-------
`matplotlib.widgets.SubplotTool`
The subplot tool window. May be a `~matplotlib.widgets.SubplotTool`
(widgets backend), a backend-native dialog (e.g. Qt), or `None` for
backends that use the toolmanager.
Comment thread
karlhillx marked this conversation as resolved.
Outdated
"""
if targetfig is None:
targetfig = gcf()
Expand Down
Loading