Skip to content

Type Series #1467

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

Type Series #1467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ac467d
Type `Series`
MarcoGorelli Nov 3, 2025
ed1792b
update pyproject
MarcoGorelli Nov 3, 2025
8dd0c69
use IndexOpsMixin more
MarcoGorelli Nov 3, 2025
a0cfb18
remove `_NoDefaultDoNotUse`
MarcoGorelli Nov 4, 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
100 changes: 78 additions & 22 deletions pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,21 +239,27 @@ class SupportsTruedivInt(Protocol[_T_co]):

class _iLocIndexerSeries(_iLocIndexer, Generic[S1]):
# get item
# Keep in sync with `Series.__getitem__`
@overload
def __getitem__(self, idx: IndexingInt) -> S1: ...
@overload
def __getitem__(self, idx: Index | slice | np_ndarray_anyint) -> Series[S1]: ...
def __getitem__(
self, idx: Index | Series | slice | np_ndarray_anyint
) -> Series[S1]: ...

# set item
# Keep in sync with `Series.__setitem__`
@overload
def __setitem__(self, idx: int, value: S1 | None) -> None: ...
@overload
def __setitem__(
self,
idx: Index | slice | np_ndarray_anyint | list[int],
value: S1 | Series[S1] | None,
value: S1 | IndexOpsMixin[S1] | None,
) -> None: ...

class _LocIndexerSeries(_LocIndexer, Generic[S1]):
# Keep in sync with `Series.__getitem__`
# ignore needed because of mypy. Overlapping, but we want to distinguish
# having a tuple of just scalars, versus tuples that include slices or Index
@overload
Expand All @@ -268,6 +274,7 @@ class _LocIndexerSeries(_LocIndexer, Generic[S1]):
idx: (
MaskType
| Index
| Series
| SequenceNotStr[float | _str | Timestamp]
| slice
| _IndexSliceTuple
Expand All @@ -277,11 +284,13 @@ class _LocIndexerSeries(_LocIndexer, Generic[S1]):
# _IndexSliceTuple is when having a tuple that includes a slice. Could just
# be s.loc[1, :], or s.loc[pd.IndexSlice[1, :]]
) -> Series[S1]: ...

# Keep in sync with `Series.__setitem__`
@overload
def __setitem__(
self,
idx: Index | MaskType | slice,
value: S1 | ArrayLike | Series[S1] | None,
idx: IndexOpsMixin[S1] | MaskType | slice,
value: S1 | ArrayLike | IndexOpsMixin[S1] | None,
) -> None: ...
@overload
def __setitem__(
Expand All @@ -293,7 +302,7 @@ class _LocIndexerSeries(_LocIndexer, Generic[S1]):
def __setitem__(
self,
idx: MaskType | StrLike | _IndexSliceTuple | list[ScalarT],
value: S1 | ArrayLike | Series[S1] | None,
value: S1 | ArrayLike | IndexOpsMixin[S1] | None,
) -> None: ...

_DataLike: TypeAlias = ArrayLike | dict[str, np.ndarray] | SequenceNotStr[S1]
Expand Down Expand Up @@ -513,33 +522,78 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
def values(self) -> ArrayLike: ...
def ravel(self, order: _str = ...) -> np.ndarray: ...
def __len__(self) -> int: ...
def view(self, dtype=...) -> Series[S1]: ...
def view(self, dtype: Dtype | None = None) -> Series[S1]: ...
@final
def __array_ufunc__(
self, ufunc: Callable, method: _str, *inputs: Any, **kwargs: Any
): ...
) -> Any: ...
def __array__(
self, dtype: _str | np.dtype = ..., copy: bool | None = ...
) -> np_1darray: ...
@property
def axes(self) -> list: ...
@final
def __getattr__(self, name: _str) -> S1: ...

# Keep in sync with `iLocIndexerSeries.__getitem__`
@overload
def __getitem__(self, idx: IndexingInt) -> S1: ...
@overload
def __getitem__(
self, idx: Index | Series | slice | np_ndarray_anyint
) -> Series[S1]: ...
# Keep in sync with `LocIndexerSeries.__getitem__`
@overload
def __getitem__( # type: ignore[overload-overlap] # pyright: ignore[reportOverlappingOverload]
self,
idx: Scalar | tuple[Scalar, ...],
# tuple case is for getting a specific element when using a MultiIndex
) -> S1: ...
@overload
def __getitem__(
self,
idx: (
list[_str]
MaskType
| Index
| Series[S1]
| Series
| SequenceNotStr[float | _str | Timestamp]
| slice
| MaskType
| tuple[Hashable | slice, ...]
| _IndexSliceTuple
| Sequence[_IndexSliceTuple]
| Callable
),
) -> Self: ...
# _IndexSliceTuple is when having a tuple that includes a slice. Could just
# be s.loc[1, :], or s.loc[pd.IndexSlice[1, :]]
) -> Series[S1]: ...

# Keep in sync with `_iLocIndexerSeries.__setitem__`
@overload
def __getitem__(self, idx: Scalar) -> S1: ...
def __setitem__(self, key, value) -> None: ...
def __setitem__(self, idx: int, value: S1 | None) -> None: ...
@overload
def __setitem__(
self,
idx: Index | slice | np_ndarray_anyint | list[int],
value: S1 | IndexOpsMixin[S1] | None,
) -> None: ...
# Keep in sync with `_LocIndexerSeries.__setitem__`
@overload
def __setitem__(
self,
idx: Index | MaskType | slice,
value: S1 | ArrayLike | IndexOpsMixin[S1] | None,
) -> None: ...
@overload
def __setitem__(
self,
idx: _str,
value: S1 | None,
) -> None: ...
@overload
def __setitem__(
self,
idx: MaskType | StrLike | _IndexSliceTuple | list[ScalarT],
value: S1 | ArrayLike | IndexOpsMixin[S1] | None,
) -> None: ...
@overload
def get(self, key: Hashable, default: None = None) -> S1 | None: ...
@overload
Expand Down Expand Up @@ -804,7 +858,7 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
dropna: _bool = ...,
) -> SeriesGroupBy[S1, Any]: ...
def count(self) -> int: ...
def mode(self, dropna=True) -> Series[S1]: ...
def mode(self, dropna: bool = True) -> Series[S1]: ...
@overload
def unique(self: Series[Never]) -> np.ndarray: ... # type: ignore[overload-overlap]
@overload
Expand Down Expand Up @@ -1527,10 +1581,6 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
axis: AxisIndex | None = 0,
) -> Series[S1]: ...
@final
def first(self, offset) -> Series[S1]: ...
@final
def last(self, offset) -> Series[S1]: ...
@final
def rank(
self,
axis: AxisIndex = 0,
Expand All @@ -1550,7 +1600,7 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
| Callable[[Series[S1]], Series[bool]]
| Callable[[S1], bool]
),
other=...,
other: S1 | Self | Callable[..., S1 | Self] = ...,
*,
inplace: Literal[True],
axis: AxisIndex | None = 0,
Expand All @@ -1566,7 +1616,7 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
| Callable[[Series[S1]], Series[bool]]
| Callable[[S1], bool]
),
other=...,
other: Scalar | Self | Callable[..., Scalar | Self] = ...,
*,
inplace: Literal[False] = False,
axis: AxisIndex | None = 0,
Expand Down Expand Up @@ -4603,7 +4653,13 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
copy: _bool = ...,
inplace: Literal[False] = False,
) -> Self: ...
def set_axis(self, labels, *, axis: Axis = ..., copy: _bool = ...) -> Self: ...
def set_axis(
self,
labels: AxesData,
*,
axis: Axis = 0,
copy: _bool | _NoDefaultDoNotUse = ...,
) -> Self: ...
@final
def xs(
self,
Expand Down
4 changes: 0 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,6 @@ ignore = [
"PYI042", # https://docs.astral.sh/ruff/rules/snake-case-type-alias/
"ERA001", "PLR0402", "PLC0105"
]
"*series.pyi" = [
# TODO: remove when pandas-dev/pandas-stubs#1444 is resolved
"ANN001", "ANN201", "ANN204", "ANN206",
]
"*frame.pyi" = [
# TODO: remove when pandas-dev/pandas-stubs#1446 is resolved
"ANN001", "ANN201", "ANN204", "ANN206",
Expand Down