Skip to content

Overload the function signature of axline #29235

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

Overload the function signature of axline #29235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a9bf66f
initial change on overloading axline, with one having the option to s…
li-ruihao Dec 5, 2024
e6e373e
Ran boilerplate.py to change axline definition in pyplot.py
li-ruihao Dec 5, 2024
e1a95bb
readded default type for xy2 and slope to be None in overloaded axlin…
li-ruihao Dec 5, 2024
00543ae
remodified _axes.pyi for minor changes to retain original behaviours
li-ruihao Dec 5, 2024
92e858b
Merge branch 'feature/axline_definition_overload' of https://github.c…
li-ruihao Dec 5, 2024
f5d852c
reverted changes in lib/matplotlib/pyplot.py
li-ruihao Dec 5, 2024
663982f
ran tools/boilerplate.py to update lib/matplotlib/pyplot.py to fix fa…
li-ruihao Dec 5, 2024
f6cea91
Merge remote-tracking branch 'upstream/main'
li-ruihao Dec 5, 2024
faf2231
Merge branch 'main' into feature/axline_definition_overload
li-ruihao Dec 5, 2024
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
9 changes: 8 additions & 1 deletion lib/matplotlib/axes/_axes.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,15 +139,22 @@ class Axes(_AxesBase):
self, x: float = ..., ymin: float = ..., ymax: float = ..., **kwargs
) -> Line2D: ...

# TODO: Could separate the xy2 and slope signatures
@overload
def axline(
self,
xy1: tuple[float, float],
xy2: tuple[float, float] | None = ...,
**kwargs
) -> AxLine: ...
@overload
def axline(
self,
xy1: tuple[float, float],
*,
slope: float | None = ...,
**kwargs
) -> AxLine: ...

def axhspan(
self, ymin: float, ymax: float, xmin: float = ..., xmax: float = ..., **kwargs
) -> Rectangle: ...
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2941,7 +2941,7 @@ def axline(
xy1: tuple[float, float],
xy2: tuple[float, float] | None = None,
*,
slope: float | None = None,
slope=None,
**kwargs,
) -> AxLine:
return gca().axline(xy1, xy2=xy2, slope=slope, **kwargs)
Expand Down
Loading