Skip to content

Fix type annotation for Axes.get_legend() to include None #30321

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
timhoffm merged 4 commits into from
Jul 17, 2025
Merged

Fix type annotation for Axes.get_legend() to include None #30321

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d0eed0e
Added None to get_legend() type annotation
nrnavaneet Jul 16, 2025
b520f86
Added an edge case test
nrnavaneet Jul 16, 2025
24e9946
Test changes
nrnavaneet Jul 16, 2025
3070ac8
Removed the test
nrnavaneet Jul 17, 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
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_base.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ class _AxesBase(martist.Artist):
ymin: float | None = ...,
ymax: float | None = ...
) -> tuple[float, float, float, float]: ...
def get_legend(self) -> Legend: ...
def get_legend(self) -> Legend | None: ...
def get_images(self) -> list[AxesImage]: ...
def get_lines(self) -> list[Line2D]: ...
def get_xaxis(self) -> XAxis: ...
Expand Down
13 changes: 13 additions & 0 deletions lib/matplotlib/tests/test_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9900,3 +9900,16 @@ def test_pie_all_zeros():
fig, ax = plt.subplots()
with pytest.raises(ValueError, match="All wedge sizes are zero"):
ax.pie([0, 0], labels=["A", "B"])


def test_get_legend_return_type():
fig, ax = plt.subplots()

assert ax.get_legend() is None

ax.plot([1, 2], label="Line")
ax.legend()

legend = ax.get_legend()
assert legend is not None
assert isinstance(legend, matplotlib.legend.Legend)
Loading