Widen return type of pyplot.subplot_tool to Any#31997
Conversation
…re_subplots to Any Per timhoffm on matplotlib#31979. The Qt backends return QDialog subclasses and the toolmanager branch already returns None, so the prior annotation was misleading. Update docstring to describe the backend-dependent return value. Also drop the now-unused TYPE_CHECKING import of SubplotTool and alphabetize the typing import. Closes matplotlib#31979
There was a problem hiding this comment.
Pull request overview
This PR updates Matplotlib’s typing/doc surface to reflect that pyplot.subplot_tool() / NavigationToolbar2.configure_subplots() return backend-dependent objects (e.g., a SubplotTool on classic backends vs a native dialog on Qt), rather than always returning a SubplotTool.
Changes:
- Widened the return annotation of
pyplot.subplot_toolto a backend-agnostic type. - Widened the return annotation of
NavigationToolbar2.configure_subplotsin the type stubs. - Updated the
subplot_tooldocstring to describe backend-dependent return values.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| lib/matplotlib/pyplot.py | Adjusts subplot_tool() return annotation and updates its docstring to describe backend-dependent returns. |
| lib/matplotlib/backend_bases.pyi | Updates the stubbed return type of NavigationToolbar2.configure_subplots. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
I'm new here, so take my comment with a grain of salt :)
The return value might still be too specific since "SubplotTool or None" doesn't include the Qt dialog case.
In the case of my work on the macosx backend, there's no way to return a "backend-native dialog", since that would be the raw NSWindowController.
Perhaps the Return type should include Any and the statement be something similar to:
Returns a
~matplotlib.widgets.SubplotTool,Nonefor backends using the toolmanager, or an implementation-specific value.
Widen the return annotation of
pyplot.subplot_toolandNavigationToolbar2.configure_subplotsfromSubplotTool | NonetoAny. The Qt backends return aQDialogand the toolmanager branch already returnsNone, so the annotations were misleading. Direction per timhoffm on #31979. Docstring updated to describe the backend-dependent return value.Also drop the now-unused
TYPE_CHECKINGimport ofSubplotTool, and alphabetize thetypingimport.Closes #31979