GH1043 Update _typing.pyi: add "cross" option to JoinHow #1044
Conversation
brzegorzTesco
changed the title
pandas-stubs/_typing.pyi
Outdated
| 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.
tests/test_frame.py
Outdated
| 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?
There was a problem hiding this comment.
CI is failing because you have to fix formatting. See https://github.com/pandas-dev/pandas-stubs/actions/runs/12008445166/job/33489766438?pr=1044
Best to create a dev environment via the instructions here so that pre-commit will pick up things like this:
https://github.com/pandas-dev/pandas-stubs/blob/main/docs/setup.md
Fix formatting
|
Thank you for the link, I haven't found it on my own previously. I've set up an dev environment, this commit should pass pre-commit checks. |
…1044) * Update _typing.pyi: add "cross" option to JoinHow * Removed "cross" option from JoinHow and added it back to MergeHow * Replaced JoinHow with MergeHow in frame.join * Added a test for join "how" * Update test_frame.py: used check(assert_type pattern in unit test * Update test_frame.py Fix formatting
* GH1051 Drop astype tests for Mac arm for float128 and complex256 * Fix * Fix * Test fix * Move to macos-latest * Update test.yml * GH1051 Lock in tables version to 3.10.1 * GH1049 Deprecate Index and Grouper methods for 2.0 migration (#1050) * GH1049 Deprecate Index and Grouper methods for migration to 2.0 * GH1049 Deprecate use_nullable_dtypes in read_parquet * Change signature of StringMethods.rsplit to match pandas (#1056) * GH1053 @ for DataFrame, eval in place for DataFrame, test migrations (#1054) * GH1053 @ for DataFrame, eval in place for DataFrame, test migrations * Formatting and spelling * GH1053 PR Feedback * GH1053 Formatting * GH1043 Update _typing.pyi: add "cross" option to JoinHow (#1044) * Update _typing.pyi: add "cross" option to JoinHow * Removed "cross" option from JoinHow and added it back to MergeHow * Replaced JoinHow with MergeHow in frame.join * Added a test for join "how" * Update test_frame.py: used check(assert_type pattern in unit test * Update test_frame.py Fix formatting * Version 2.2.3.241126 --------- Co-authored-by: kroche98 <[email protected]> Co-authored-by: brzegorzTesco <[email protected]> Co-authored-by: Irv Lustig <[email protected]>
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.