Thanks to visit codestin.com
Credit goes to github.com

Skip to content

TYP: Add type information to the data parameter of plot functions #31482

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
timhoffm wants to merge 2 commits into
base: main
Choose a base branch
from
Open

TYP: Add type information to the data parameter of plot functions #31482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a1f201
TYP: Add type information to the data parameter of plot functions
timhoffm Apr 9, 2026
71facf6
Run boilerplate with current version of black
timhoffm Apr 10, 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
81 changes: 41 additions & 40 deletions lib/matplotlib/axes/_axes.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ from collections.abc import Callable, Iterable, Sequence
from typing import Any, Literal, overload
import numpy as np
from numpy.typing import ArrayLike
from matplotlib.typing import ColorType, MarkerType, LegendLocType, LineStyleType
from matplotlib.typing import (
ColorType, DataParamType, MarkerType, LegendLocType, LineStyleType)
import pandas as pd


Expand Down Expand Up @@ -172,7 +173,7 @@ class Axes(_AxesBase):
linestyles: LineStyleType = ...,
*,
label: str = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> LineCollection: ...
def vlines(
Expand All @@ -184,7 +185,7 @@ class Axes(_AxesBase):
linestyles: LineStyleType = ...,
*,
label: str = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> LineCollection: ...
def eventplot(
Expand All @@ -198,22 +199,22 @@ class Axes(_AxesBase):
colors: ColorType | Sequence[ColorType] | None = ...,
alpha: float | Sequence[float] | None = ...,
linestyles: LineStyleType | Sequence[LineStyleType] = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> EventCollection: ...
def plot(
self,
*args: float | ArrayLike | str,
scalex: bool = ...,
scaley: bool = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> list[Line2D]: ...
def loglog(self, *args, **kwargs) -> list[Line2D]: ...
def semilogx(self, *args, **kwargs) -> list[Line2D]: ...
def semilogy(self, *args, **kwargs) -> list[Line2D]: ...
def acorr(
self, x: ArrayLike, *, data=..., **kwargs
self, x: ArrayLike, *, data: DataParamType = ..., **kwargs
) -> tuple[np.ndarray, np.ndarray, LineCollection | Line2D, Line2D | None]: ...
def xcorr(
self,
Expand All @@ -224,7 +225,7 @@ class Axes(_AxesBase):
detrend: Callable[[ArrayLike], ArrayLike] = ...,
usevlines: bool = ...,
maxlags: int = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, LineCollection | Line2D, Line2D | None]: ...
def step(
Expand All @@ -233,7 +234,7 @@ class Axes(_AxesBase):
y: ArrayLike,
*args,
where: Literal["pre", "post", "mid"] = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> list[Line2D]: ...
def bar(
Expand All @@ -244,7 +245,7 @@ class Axes(_AxesBase):
bottom: float | ArrayLike | None = ...,
*,
align: Literal["center", "edge"] = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> BarContainer: ...
def barh(
Expand All @@ -255,7 +256,7 @@ class Axes(_AxesBase):
left: float | ArrayLike | None = ...,
*,
align: Literal["center", "edge"] = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> BarContainer: ...
def bar_label(
Expand All @@ -274,7 +275,7 @@ class Axes(_AxesBase):
yrange: tuple[float, float],
align: Literal["bottom", "center", "top"] = ...,
*,
data=...,
data: DataParamType = ...,
**kwargs
) -> PolyCollection: ...
def grouped_bar(
Expand All @@ -299,7 +300,7 @@ class Axes(_AxesBase):
bottom: float = ...,
label: str | None = ...,
orientation: Literal["vertical", "horizontal"] = ...,
data=...,
data: DataParamType = ...,
) -> StemContainer: ...

# TODO: data kwarg preprocessor?
Expand All @@ -324,7 +325,7 @@ class Axes(_AxesBase):
rotatelabels: bool = ...,
normalize: bool = ...,
hatch: str | Sequence[str] | None = ...,
data=...,
data: DataParamType = ...,
) -> PieContainer: ...
def pie_label(
self,
Expand Down Expand Up @@ -356,7 +357,7 @@ class Axes(_AxesBase):
xuplims: bool | ArrayLike = ...,
errorevery: int | tuple[int, int] = ...,
capthick: float | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> ErrorbarContainer: ...
def boxplot(
Expand Down Expand Up @@ -391,7 +392,7 @@ class Axes(_AxesBase):
zorder: float | None = ...,
capwidths: float | ArrayLike | None = ...,
label: Sequence[str] | None = ...,
data=...,
data: DataParamType = ...,
) -> dict[str, Any]: ...
def bxp(
self,
Expand Down Expand Up @@ -436,7 +437,7 @@ class Axes(_AxesBase):
edgecolors: Literal["face", "none"] | ColorType | Sequence[ColorType] | None = ...,
colorizer: Colorizer | None = ...,
plotnonfinite: bool = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> PathCollection: ...
def hexbin(
Expand All @@ -461,7 +462,7 @@ class Axes(_AxesBase):
mincnt: int | None = ...,
marginals: bool = ...,
colorizer: Colorizer | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> PolyCollection: ...
def arrow(
Expand All @@ -470,9 +471,9 @@ class Axes(_AxesBase):
def quiverkey(
self, Q: Quiver, X: float, Y: float, U: float, label: str, **kwargs
) -> QuiverKey: ...
def quiver(self, *args, data=..., **kwargs) -> Quiver: ...
def barbs(self, *args, data=..., **kwargs) -> Barbs: ...
def fill(self, *args, data=..., **kwargs) -> list[Polygon]: ...
def quiver(self, *args, data: DataParamType = ..., **kwargs) -> Quiver: ...
def barbs(self, *args, data: DataParamType = ..., **kwargs) -> Barbs: ...
def fill(self, *args, data: DataParamType = ..., **kwargs) -> list[Polygon]: ...
def fill_between(
self,
x: ArrayLike,
Expand All @@ -482,7 +483,7 @@ class Axes(_AxesBase):
interpolate: bool = ...,
step: Literal["pre", "post", "mid"] | None = ...,
*,
data=...,
data: DataParamType = ...,
**kwargs
) -> FillBetweenPolyCollection: ...
def fill_betweenx(
Expand All @@ -494,7 +495,7 @@ class Axes(_AxesBase):
step: Literal["pre", "post", "mid"] | None = ...,
interpolate: bool = ...,
*,
data=...,
data: DataParamType = ...,
**kwargs
) -> FillBetweenPolyCollection: ...
def imshow(
Expand All @@ -516,7 +517,7 @@ class Axes(_AxesBase):
filterrad: float = ...,
resample: bool | None = ...,
url: str | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> AxesImage: ...
def pcolor(
Expand All @@ -529,7 +530,7 @@ class Axes(_AxesBase):
vmin: float | None = ...,
vmax: float | None = ...,
colorizer: Colorizer | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> Collection: ...
def pcolormesh(
Expand All @@ -543,7 +544,7 @@ class Axes(_AxesBase):
colorizer: Colorizer | None = ...,
shading: Literal["flat", "nearest", "gouraud", "auto"] | None = ...,
antialiased: bool = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> QuadMesh: ...
def pcolorfast(
Expand All @@ -555,11 +556,11 @@ class Axes(_AxesBase):
vmin: float | None = ...,
vmax: float | None = ...,
colorizer: Colorizer | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> AxesImage | PcolorImage | QuadMesh: ...
def contour(self, *args, data=..., **kwargs) -> QuadContourSet: ...
def contourf(self, *args, data=..., **kwargs) -> QuadContourSet: ...
def contour(self, *args, data: DataParamType = ..., **kwargs) -> QuadContourSet: ...
def contourf(self, *args, data: DataParamType = ..., **kwargs) -> QuadContourSet: ...
def clabel(
self, CS: ContourSet, levels: ArrayLike | None = ..., **kwargs
) -> list[Text]: ...
Expand All @@ -581,7 +582,7 @@ class Axes(_AxesBase):
color: ColorType | Sequence[ColorType] | None = ...,
label: str | Sequence[str] | None = ...,
stacked: bool = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[
np.ndarray | list[np.ndarray],
Expand All @@ -596,7 +597,7 @@ class Axes(_AxesBase):
orientation: Literal["vertical", "horizontal"] = ...,
baseline: float | ArrayLike | None = ...,
fill: bool = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> StepPatch: ...
def hist2d(
Expand All @@ -614,7 +615,7 @@ class Axes(_AxesBase):
weights: ArrayLike | None = ...,
cmin: float | None = ...,
cmax: float | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, np.ndarray, QuadMesh]: ...
def ecdf(
Expand All @@ -625,7 +626,7 @@ class Axes(_AxesBase):
complementary: bool=...,
orientation: Literal["vertical", "horizontal"]=...,
compress: bool=...,
data=...,
data: DataParamType = ...,
**kwargs
) -> Line2D: ...
def psd(
Expand All @@ -644,7 +645,7 @@ class Axes(_AxesBase):
sides: Literal["default", "onesided", "twosided"] | None = ...,
scale_by_freq: bool | None = ...,
return_line: bool | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray] | tuple[np.ndarray, np.ndarray, Line2D]: ...
def csd(
Expand All @@ -664,7 +665,7 @@ class Axes(_AxesBase):
sides: Literal["default", "onesided", "twosided"] | None = ...,
scale_by_freq: bool | None = ...,
return_line: bool | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray] | tuple[np.ndarray, np.ndarray, Line2D]: ...
def magnitude_spectrum(
Expand All @@ -677,7 +678,7 @@ class Axes(_AxesBase):
pad_to: int | None = ...,
sides: Literal["default", "onesided", "twosided"] | None = ...,
scale: Literal["default", "linear", "dB"] | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, Line2D]: ...
def angle_spectrum(
Expand All @@ -689,7 +690,7 @@ class Axes(_AxesBase):
window: Callable[[ArrayLike], ArrayLike] | ArrayLike | None = ...,
pad_to: int | None = ...,
sides: Literal["default", "onesided", "twosided"] | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, Line2D]: ...
def phase_spectrum(
Expand All @@ -701,7 +702,7 @@ class Axes(_AxesBase):
window: Callable[[ArrayLike], ArrayLike] | ArrayLike | None = ...,
pad_to: int | None = ...,
sides: Literal["default", "onesided", "twosided"] | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, Line2D]: ...
def cohere(
Expand All @@ -719,7 +720,7 @@ class Axes(_AxesBase):
pad_to: int | None = ...,
sides: Literal["default", "onesided", "twosided"] = ...,
scale_by_freq: bool | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray]: ...
def specgram(
Expand All @@ -743,7 +744,7 @@ class Axes(_AxesBase):
scale: Literal["default", "linear", "dB"] | None = ...,
vmin: float | None = ...,
vmax: float | None = ...,
data=...,
data: DataParamType = ...,
**kwargs
) -> tuple[np.ndarray, np.ndarray, np.ndarray, AxesImage]: ...
def spy(
Expand Down Expand Up @@ -778,7 +779,7 @@ class Axes(_AxesBase):
side: Literal["both", "low", "high"] = ...,
facecolor: Sequence[ColorType] | ColorType | None = ...,
linecolor: Sequence[ColorType] | ColorType | None = ...,
data=...,
data: DataParamType = ...,
) -> dict[str, Collection]: ...
def violin(
self,
Expand Down
Loading
Loading