Skip to content

TYP: Index.join #46518

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
jreback merged 6 commits into from
May 6, 2022
Merged

TYP: Index.join #46518

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ebb4d62
TYP: Index.join
twoertwein Mar 26, 2022
74e61a1
type other
twoertwein Mar 31, 2022
9ed6314
whatsnew
twoertwein Apr 3, 2022
ebd7c48
Merge remote-tracking branch 'upstream/main' into index
twoertwein Apr 3, 2022
47c17f2
typo
twoertwein Apr 3, 2022
ba2fede
Merge branch 'main' into index
twoertwein May 4, 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
56 changes: 51 additions & 5 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
DtypeObj,
F,
IgnoreRaise,
Level,
Shape,
npt,
)
Expand Down Expand Up @@ -4529,16 +4530,53 @@ def _reindex_non_unique(
# --------------------------------------------------------------------
# Join Methods

@overload
def join(
self,
other: Index,
*,
how: str_t = ...,
level: Level = ...,
return_indexers: Literal[True],
sort: bool = ...,
) -> tuple[Index, npt.NDArray[np.intp] | None, npt.NDArray[np.intp] | None]:
...

@overload
def join(
self,
other: Index,
*,
how: str_t = ...,
level: Level = ...,
return_indexers: Literal[False] = ...,
sort: bool = ...,
) -> Index:
...

@overload
def join(
self,
other: Index,
*,
how: str_t = ...,
level: Level = ...,
return_indexers: bool = ...,
sort: bool = ...,
) -> Index | tuple[Index, npt.NDArray[np.intp] | None, npt.NDArray[np.intp] | None]:
...

@final
@deprecate_nonkeyword_arguments(version=None, allowed_args=["self", "other"])
@_maybe_return_indexers
def join(
self,
other,
other: Index,
how: str_t = "left",
level=None,
level: Level = None,
return_indexers: bool = False,
sort: bool = False,
):
) -> Index | tuple[Index, npt.NDArray[np.intp] | None, npt.NDArray[np.intp] | None]:
"""
Compute join_index and indexers to conform data
structures to the new index.
Expand Down Expand Up @@ -4723,16 +4761,24 @@ def _join_multi(self, other: Index, how: str_t):
# Join left and right
# Join on same leveled multi-index frames is supported
join_idx, lidx, ridx = self_jnlevels.join(
other_jnlevels, how, return_indexers=True
other_jnlevels, how=how, return_indexers=True
)

# Restore the dropped levels
# Returned index level order is
# common levels, ldrop_names, rdrop_names
dropped_names = ldrop_names + rdrop_names

# error: Argument 5/6 to "restore_dropped_levels_multijoin" has
# incompatible type "Optional[ndarray[Any, dtype[signedinteger[Any
# ]]]]"; expected "ndarray[Any, dtype[signedinteger[Any]]]"
levels, codes, names = restore_dropped_levels_multijoin(
self, other, dropped_names, join_idx, lidx, ridx
self,
other,
dropped_names,
join_idx,
lidx, # type: ignore[arg-type]
ridx, # type: ignore[arg-type]
)

# Re-create the multi-index
Expand Down