Skip to content

Add AnyArrayLike for merge on arguments #231

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 2 commits into from
Aug 28, 2022
Merged

Add AnyArrayLike for merge on arguments #231

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
d39115d
Add AnyArrayLike for merge on arguments
phofl Aug 26, 2022
228f881
Add checks
phofl Aug 27, 2022
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
7 changes: 4 additions & 3 deletions pandas-stubs/core/frame.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ from pandas._typing import (
AggFuncType,
AggFuncTypeBase,
AggFuncTypeDict,
AnyArrayLike,
ArrayLike,
Axes,
Axis,
Expand Down Expand Up @@ -1049,9 +1050,9 @@ class DataFrame(NDFrame, OpsMixin):
self,
right: DataFrame | Series,
how: MergeHow = ...,
on: IndexLabel | None = ...,
left_on: IndexLabel | None = ...,
right_on: IndexLabel | None = ...,
on: IndexLabel | AnyArrayLike | None = ...,
left_on: IndexLabel | AnyArrayLike | None = ...,
right_on: IndexLabel | AnyArrayLike | None = ...,
left_index: _bool = ...,
right_index: _bool = ...,
sort: _bool = ...,
Expand Down
21 changes: 12 additions & 9 deletions pandas-stubs/core/reshape/merge.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,18 @@ from pandas import (
)

from pandas._libs.tslibs import Timedelta
from pandas._typing import Label
from pandas._typing import (
AnyArrayLike,
Label,
)

def merge(
left: DataFrame | Series,
right: DataFrame | Series,
how: str = ...,
on: Label | Sequence | None = ...,
left_on: Label | Sequence | None = ...,
right_on: Label | Sequence | None = ...,
on: Label | Sequence | AnyArrayLike | None = ...,
left_on: Label | Sequence | AnyArrayLike | None = ...,
right_on: Label | Sequence | AnyArrayLike | None = ...,
left_index: bool = ...,
right_index: bool = ...,
sort: bool = ...,
Expand All @@ -26,9 +29,9 @@ def merge(
def merge_ordered(
left: DataFrame | Series,
right: DataFrame | Series,
on: Label | Sequence | None = ...,
left_on: Label | Sequence | None = ...,
right_on: Label | Sequence | None = ...,
on: Label | Sequence | AnyArrayLike | None = ...,
left_on: Label | Sequence | AnyArrayLike | None = ...,
right_on: Label | Sequence | AnyArrayLike | None = ...,
left_by: str | list[str] | None = ...,
right_by: str | list[str] | None = ...,
fill_method: str | None = ...,
Expand All @@ -39,8 +42,8 @@ def merge_asof(
left: DataFrame | Series,
right: DataFrame | Series,
on: Label | None = ...,
left_on: Label | None = ...,
right_on: Label | None = ...,
left_on: Label | AnyArrayLike | None = ...,
right_on: Label | AnyArrayLike | None = ...,
left_index: bool = ...,
right_index: bool = ...,
by: str | list[str] | None = ...,
Expand Down
127 changes: 127 additions & 0 deletions tests/test_merge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,137 @@
from __future__ import annotations

import numpy as np
import pandas as pd
from typing_extensions import assert_type

from tests import check


def test_types_merge() -> None:
df = pd.DataFrame(data={"col1": [1, 1, 2], "col2": [3, 4, 5]})
df2 = pd.DataFrame(data={"col1": [1, 1, 2], "col2": [0, 1, 0]})
columns = ["col1", "col2"]
df.merge(df2, on=columns)

check(
assert_type(df.merge(df2, on=pd.Series([1, 2, 3])), pd.DataFrame), pd.DataFrame
)
check(
assert_type(df.merge(df2, on=pd.Index([1, 2, 3])), pd.DataFrame), pd.DataFrame
)
check(
assert_type(df.merge(df2, on=np.array([1, 2, 3])), pd.DataFrame), pd.DataFrame
)

check(
assert_type(
df.merge(df2, left_on=pd.Series([1, 2, 3]), right_on=pd.Series([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
df.merge(df2, left_on=pd.Index([1, 2, 3]), right_on=pd.Series([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
df.merge(df2, left_on=pd.Index([1, 2, 3]), right_on=pd.Index([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)

check(
assert_type(
df.merge(df2, left_on=np.array([1, 2, 3]), right_on=pd.Series([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
df.merge(df2, left_on=np.array([1, 2, 3]), right_on=pd.Index([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
df.merge(df2, left_on=np.array([1, 2, 3]), right_on=np.array([1, 2, 3])),
pd.DataFrame,
),
pd.DataFrame,
)

check(
assert_type(pd.merge(df, df2, on=pd.Series([1, 2, 3])), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(pd.merge(df, df2, on=pd.Index([1, 2, 3])), pd.DataFrame),
pd.DataFrame,
)
check(
assert_type(pd.merge(df, df2, on=np.array([1, 2, 3])), pd.DataFrame),
pd.DataFrame,
)

check(
assert_type(
pd.merge(
df, df2, left_on=pd.Series([1, 2, 3]), right_on=pd.Series([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
pd.merge(
df, df2, left_on=pd.Index([1, 2, 3]), right_on=pd.Series([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
pd.merge(
df, df2, left_on=pd.Index([1, 2, 3]), right_on=pd.Index([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)

check(
assert_type(
pd.merge(
df, df2, left_on=np.array([1, 2, 3]), right_on=pd.Series([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
pd.merge(
df, df2, left_on=np.array([1, 2, 3]), right_on=pd.Index([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)
check(
assert_type(
pd.merge(
df, df2, left_on=np.array([1, 2, 3]), right_on=np.array([1, 2, 3])
),
pd.DataFrame,
),
pd.DataFrame,
)