Add type stubs for Axes3D and improve type hints in _AxesBase #30713

ABarpanda · 2025-10-31T20:34:29Z

PR summary

This PR adds a new type stub file for mpl_toolkits.mplot3d.axes3d and makes minor improvements to type hints in matplotlib.axes._base.

Added axes3d.pyi with type definitions for Axes3D, _Quaternion, and get_test_data.
Updated _base.py and _base.pyi with more explicit annotations for _shared_axes and _twinned_axes.
Since there are no dedicated test files for these modules, pytest could not be used.
Type checking was done using mypy; remaining errors are from inherited parent classes, not the new additions.

PR checklist

"resolves [MNT]: Inconsistent type annotation #30670 " is in the body of the PR description to link the related issue

QuLogic

You will need to fix the linting errors. There are also a lot of Any; I'm not sure how helpful the type hints are with so many of them.

QuLogic · 2025-11-01T00:19:30Z

lib/matplotlib/axes/_base.pyi

 import numpy as np
 from numpy.typing import ArrayLike
-from typing import Any, Literal, TypeVar, overload
+from typing import Any, Literal, TypeVar, overload, List


We don't use these deprecated aliases; you should be using list.

QuLogic · 2025-11-01T00:19:57Z

lib/matplotlib/axes/_base.pyi

+    def __init__(self, bounds: Sequence[float], transform: Transform) -> None: ...
+
+    def __call__(self, ax: Any, renderer: Any) -> Bbox: ...


Don't need the blank lines between methods in type stubs.

QuLogic · 2025-11-01T00:21:02Z

lib/matplotlib/axes/_base.pyi

    title: Text
    _axis_map: dict[str, Axis]
    _projection_init: Any
+    _axis_names: tuple[Literal['x'], Literal['y']] | tuple[Literal['x'], Literal['y'], Literal['z']]


This type is definitely not literals.

@QuLogic not sure. I think right now this is true at least within the core library. At least PolarAxes still has ("x", "y") whether that is desirable is another topic.

QuLogic · 2025-11-01T00:21:44Z

lib/mpl_toolkits/mplot3d/axes3d.py

        fig : Figure
            The parent figure.
-        rect : tuple (left, bottom, width, height), default: (0, 0, 1, 1)
+        rect : tuple (left, bottom, width, height), default: None


This change is unrelated, and incorrect.

Please revert. Defaults stated in the docstring are the logical defaults, not necessary what's formally given as the default placeholder object.

QuLogic · 2025-11-01T00:22:04Z

lib/mpl_toolkits/mplot3d/axes3d.pyi

+from __future__ import annotations
+__all__ = ["Axes3D", "_Quaternion", "get_test_data"]
+
+from typing import Any, List, Optional, Sequence, Tuple, Union


Remove all deprecated aliases. We don't use Optional or Union either.

QuLogic · 2025-11-01T00:22:24Z

lib/mpl_toolkits/mplot3d/axes3d.pyi

@@ -0,0 +1,170 @@
+from __future__ import annotations
+__all__ = ["Axes3D", "_Quaternion", "get_test_data"]


Is __all__ actually relevant in type stubs?

ABarpanda · 2025-11-01T03:50:39Z

Oh thanks
The comments are really detailed😅
I will make the changes as soon as possible

…nto abarpanda

timhoffm · 2025-11-11T12:03:06Z

lib/matplotlib/axes/_axes.py

                      label_namer="y")
    @_docstring.interpd
-    def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
+    def scatter(self, x, y, z=0, s=None, c=None, marker=None, cmap=None, norm=None,


You can't change the signature of Axes methods. Please revert.

ABarpanda · 2025-11-13T12:03:37Z

@timhoffm Please check the latest commit...

timhoffm

@ABarpanda please be more carefully to fully implement requested changes and also fix the reported linting / typing errors before requesting a new review.

timhoffm · 2025-11-13T15:41:11Z

lib/matplotlib/axes/_axes.py

+        zs : float or array-like, default: 0
+            The z-positions. Either an array of the same length as *xs* and
+            *ys* or a single value to place all points in the same plane.
+


Please revert as well.

timhoffm · 2025-11-13T15:41:24Z

lib/matplotlib/axes/_axes.pyi

        self,
        x: float | ArrayLike,
        y: float | ArrayLike,
+        z: float | ArrayLike,


Please revert as well.

timhoffm · 2025-11-13T15:48:07Z

lib/matplotlib/axes/_base.pyi

    title: Text
    _axis_map: dict[str, Axis]
    _projection_init: Any
+    _axis_names: tuple[Literal['x'], Literal['y']] | tuple[Literal['x'], Literal['y'], Literal['z']]


@QuLogic not sure. I think right now this is true at least within the core library. At least PolarAxes still has ("x", "y") whether that is desirable is another topic.

timhoffm · 2025-11-13T15:49:51Z

lib/mpl_toolkits/mplot3d/axes3d.py

        fig : Figure
            The parent figure.
-        rect : tuple (left, bottom, width, height), default: (0, 0, 1, 1)
+        rect : tuple (left, bottom, width, height), default: None


Please revert. Defaults stated in the docstring are the logical defaults, not necessary what's formally given as the default placeholder object.

ABarpanda added 2 commits October 24, 2025 10:03

Created axes3d.pyi

e599889

Changes in _base.pyi

89e5545

github-actions bot added topic: mplot3d topic: axes labels Oct 31, 2025

QuLogic reviewed Nov 1, 2025

View reviewed changes

QuLogic added the topic: typing label Nov 1, 2025

ABarpanda added 3 commits November 11, 2025 16:51

Merge branch 'matplotlib:main' into abarpanda

e7e3d42

Type hinted first 3000 lines of mpl_toolkits/mplot3d/axes3d.py

1852fc6

Merge branch 'abarpanda' of https://github.com/ABarpanda/matplotlib i…

563fbb2

…nto abarpanda

timhoffm reviewed Nov 11, 2025

View reviewed changes

Completed axes3d.pyi

5e802f5

timhoffm reviewed Nov 13, 2025

View reviewed changes

		def __init__(self, bounds: Sequence[float], transform: Transform) -> None: ...

		def __call__(self, ax: Any, renderer: Any) -> Bbox: ...

		@@ -0,0 +1,170 @@
		from __future__ import annotations
		__all__ = ["Axes3D", "_Quaternion", "get_test_data"]

Uh oh!

Add type stubs for Axes3D and improve type hints in _AxesBase #30713

Are you sure you want to change the base?

Add type stubs for Axes3D and improve type hints in _AxesBase #30713

Conversation

ABarpanda commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR summary

PR checklist

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ABarpanda commented Nov 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ABarpanda commented Nov 13, 2025

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ABarpanda commented Oct 31, 2025 •

edited

Loading