Skip to content
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

GH1043 Update _typing.pyi: add "cross" option to JoinHow #1044

Merged
merged 6 commits into from
Nov 26, 2024
Merged

GH1043 Update _typing.pyi: add "cross" option to JoinHow #1044

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
84ccb39
Update _typing.pyi: add "cross" option to JoinHow
brzegorzTesco Nov 21, 2024
dbda093
Removed "cross" option from JoinHow and added it back to MergeHow
brzegorzTesco Nov 22, 2024
64b7dab
Replaced JoinHow with MergeHow in frame.join
brzegorzTesco Nov 22, 2024
5807199
Added a test for join "how"
brzegorzTesco Nov 22, 2024
f00b7c6
Update test_frame.py: used check(assert_type pattern in unit test
brzegorzTesco Nov 25, 2024
752bc05
Update test_frame.py
brzegorzTesco Nov 26, 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
4 changes: 2 additions & 2 deletions pandas-stubs/_typing.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,8 +729,8 @@ InterpolateOptions: TypeAlias = Literal[
ReplaceMethod: TypeAlias = Literal["pad", "ffill", "bfill"]
SortKind: TypeAlias = Literal["quicksort", "mergesort", "heapsort", "stable"]
NaPosition: TypeAlias = Literal["first", "last"]
JoinHow: TypeAlias = Literal["left", "right", "outer", "inner"]
MergeHow: TypeAlias = JoinHow | Literal["cross"]
JoinHow: TypeAlias = Literal["left", "right", "outer", "inner", "cross"]
MergeHow: TypeAlias = JoinHow
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fix is not correct, because JoinHow is used as the type of the join argument in the align() method.

The right fix is to change the typing of DataFrame.join() to use the existing MergeHow type.

You would then add a test like your example that shows that "cross" is accepted as a value for the how argument of DataFrame.join()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the quick feedback, I've done as you said.

JsonFrameOrient: TypeAlias = Literal[
"split", "records", "index", "columns", "values", "table"
]
Expand Down