Skip to content

type isin, remove redundant Iterable | Series #1507

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 14 commits into from
Dec 1, 2025
Merged

type isin, remove redundant Iterable | Series #1507

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ee06333
type `isin`, remove redundant `Iterable | Series`
MarcoGorelli Nov 26, 2025
b47951a
Iterable -> Iterable[Any], extra test cases
MarcoGorelli Nov 26, 2025
75adc95
Merge branch 'main' into clean-iterable
MarcoGorelli Nov 26, 2025
07cd485
add overloads for multiindex.isin
MarcoGorelli Nov 27, 2025
f3e2dec
Merge branch 'clean-iterable' of github.com:MarcoGorelli/pandas-stubs…
MarcoGorelli Nov 27, 2025
fdbe5f0
fix pyrefly
MarcoGorelli Nov 27, 2025
145807f
fix pyright
MarcoGorelli Nov 27, 2025
96fbc5e
fix pyrefly
MarcoGorelli Nov 27, 2025
3212e19
Merge remote-tracking branch 'upstream/main' into clean-iterable
MarcoGorelli Dec 1, 2025
ef6ab94
extra test case, use Collection
MarcoGorelli Dec 1, 2025
29ba4a2
remove extra test case
MarcoGorelli Dec 1, 2025
815e68f
extra test cases
MarcoGorelli Dec 1, 2025
3279cd1
mypy
MarcoGorelli Dec 1, 2025
c868e8d
ty
MarcoGorelli Dec 1, 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
4 changes: 3 additions & 1 deletion pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1783,7 +1783,9 @@ class DataFrame(NDFrame, OpsMixin, _GetItemHack):
axis: Axis = 0,
copy: _bool = True,
) -> Self: ...
def isin(self, values: Iterable | Series | DataFrame | dict) -> Self: ...
def isin(
self, values: Iterable | DataFrame | Mapping[Hashable, Iterable]
) -> Self: ...
@property
def plot(self) -> PlotAccessor: ...
def hist(
Expand Down
2 changes: 1 addition & 1 deletion pandas-stubs/core/indexes/base.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ class Index(IndexOpsMixin[S1], ElementOpsMixin[S1]):
@final
def get_indexer_for(self, target, **kwargs: Any): ...
def map(self, mapper, na_action=...) -> Index: ...
def isin(self, values, level=...) -> np_1darray_bool: ...
def isin(self, values: Iterable, level: Level | None = None) -> np_1darray_bool: ...
def slice_indexer(
self,
start: Label | None = None,
Expand Down
2 changes: 1 addition & 1 deletion pandas-stubs/core/series.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1302,7 +1302,7 @@ class Series(IndexOpsMixin[S1], ElementOpsMixin[S1], NDFrame):
show_counts: bool | None = ...,
) -> None: ...
def memory_usage(self, index: _bool = True, deep: _bool = False) -> int: ...
def isin(self, values: Iterable | Series[S1] | dict) -> Series[_bool]: ...
def isin(self, values: Iterable) -> Series[_bool]: ...
def between(
self,
left: Scalar | ListLikeU,
Expand Down
6 changes: 4 additions & 2 deletions tests/indexes/test_indexes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,10 @@ def test_index_duplicated() -> None:

def test_index_isin() -> None:
ind = pd.Index([1, 2, 3, 4, 5])
isin = ind.isin([2, 4])
check(assert_type(isin, np_1darray_bool), np_1darray_bool)
check(assert_type(ind.isin([2, 4]), np_1darray_bool), np_1darray_bool)
check(assert_type(ind.isin({2, 4}), np_1darray_bool), np_1darray_bool)
check(assert_type(ind.isin(pd.Series([2, 4])), np_1darray_bool), np_1darray_bool)
check(assert_type(ind.isin(pd.Index([2, 4])), np_1darray_bool), np_1darray_bool)


def test_index_astype() -> None:
Expand Down
10 changes: 10 additions & 0 deletions tests/series/test_series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1610,6 +1610,16 @@ def test_series_min_max_sub_axis() -> None:
check(assert_type(df.max(axis=1), pd.Series), pd.Series)


def test_series_isin() -> None:
s = pd.Series([1, 2, 3, 4, 5])
check(assert_type(s.isin([3, 4]), "pd.Series[bool]"), pd.Series, np.bool_)
check(assert_type(s.isin({3, 4}), "pd.Series[bool]"), pd.Series, np.bool_)
check(
assert_type(s.isin(pd.Series([3, 4])), "pd.Series[bool]"), pd.Series, np.bool_
)
check(assert_type(s.isin(pd.Index([3, 4])), "pd.Series[bool]"), pd.Series, np.bool_)


def test_series_index_isin() -> None:
s = pd.Series([1, 2, 3, 4, 5], index=[1, 2, 2, 3, 3])
t1 = s.loc[s.index.isin([1, 3])]
Expand Down
10 changes: 10 additions & 0 deletions tests/test_frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2940,6 +2940,16 @@ def test_getmultiindex_columns() -> None:
check(assert_type(df[li[0]], pd.Series), pd.Series)


def test_frame_isin() -> None:
df = pd.DataFrame({"x": [1, 2, 3, 4, 5]}, index=[1, 2, 3, 4, 5])
check(assert_type(df.isin([1, 3, 5]), pd.DataFrame), pd.DataFrame)
check(assert_type(df.isin({1, 3, 5}), pd.DataFrame), pd.DataFrame)
check(assert_type(df.isin(pd.Series([1, 3, 5])), pd.DataFrame), pd.DataFrame)
check(assert_type(df.isin(pd.Index([1, 3, 5])), pd.DataFrame), pd.DataFrame)
check(assert_type(df.isin(df), pd.DataFrame), pd.DataFrame)
check(assert_type(df.isin({"x": [1, 2]}), pd.DataFrame), pd.DataFrame)


def test_frame_getitem_isin() -> None:
df = pd.DataFrame({"x": [1, 2, 3, 4, 5]}, index=[1, 2, 3, 4, 5])
check(assert_type(df[df.index.isin([1, 3, 5])], pd.DataFrame), pd.DataFrame)
Expand Down