GH1043 Update _typing.pyi: add "cross" option to JoinHow #1044
+11
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brzegorzTesco
changed the title
Dr-Irv
requested changes
Nov 21, 2024
pandas-stubs/_typing.pyi
Outdated
Comment on lines
732
to
733
| JoinHow: TypeAlias = Literal["left", "right", "outer", "inner", "cross"] | ||
| MergeHow: TypeAlias = JoinHow |
There was a problem hiding this comment.
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()
There was a problem hiding this comment.
Thank you for the quick feedback, I've done as you said.
Dr-Irv
requested changes
Nov 22, 2024
Comment on lines
+2351
to
+2355
| df1.join(df2, how="cross") | ||
| df1.join(df2, how="inner") | ||
| df1.join(df2, how="outer") | ||
| df1.join(df2, how="left") | ||
| df1.join(df2, how="right") |
There was a problem hiding this comment.
Can you use the check(assert_type(... pattern here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
assert_type()to assert the type of any return valueI haven't added tests since JoinHow doesn't seem to be tested in any case. Should I add some? Merge tests unimpacted.