[SPARK-58971][PS] Add pct, na_option, and axis parameters to Series.rank and DataFrame.rank - #58254
Open
jzhan-2026 wants to merge 4 commits into
Open
[SPARK-58971][PS] Add pct, na_option, and axis parameters to Series.rank and DataFrame.rank#58254jzhan-2026 wants to merge 4 commits into
jzhan-2026 wants to merge 4 commits into
Conversation
Author
|
@holdenk Could you help take a look on the PR when you have time? Thanks. |
jzhan-2026
changed the title
Contributor
|
I'll take a look, there are some failing "slow" pandas tests, they look like they could be bad tests but if you can also take a look @jzhan-2026 that would be great! |
holdenk
reviewed
Aug 24, 2026
Comment on lines
+4363
to
+4383
| # Determine ordering with null placement based on na_option. | ||
| # 'top' always assigns the smallest rank to NaN, 'bottom' the largest, | ||
| # regardless of ascending direction. | ||
| if ascending: | ||
| asc_func = PySparkColumn.asc | ||
| sort_col = ( | ||
| self.spark.column.asc_nulls_first() | ||
| if na_option == "top" | ||
| else self.spark.column.asc_nulls_last() | ||
| ) | ||
| nat_order_col = F.col(NATURAL_ORDER_COLUMN_NAME).asc() | ||
| else: | ||
| asc_func = PySparkColumn.desc | ||
| sort_col = ( | ||
| self.spark.column.desc_nulls_first() | ||
| if na_option == "top" | ||
| else self.spark.column.desc_nulls_last() | ||
| ) | ||
| nat_order_col = F.col(NATURAL_ORDER_COLUMN_NAME).desc() | ||
|
|
||
| if method == "first": | ||
| window = ( | ||
| Window.orderBy( | ||
| asc_func(self.spark.column), | ||
| asc_func(F.col(NATURAL_ORDER_COLUMN_NAME)), | ||
| ) | ||
| Window.orderBy(sort_col, nat_order_col) |
Contributor
There was a problem hiding this comment.
I think the new ordering is a little screwed up, I took a little of time but not 100% sure. Tentatively my guess is making the asc_func and then applying it to the natural order column name would work better. I think it could also simplify the code a bit since the multiple different calls to .desc() / .desc_nulls_last / desc_nulls... etc.
Contributor
|
Did a bit more of a poke, I think there might be something off in the new ordering code not just the ttests. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changes were proposed in this pull request?
Add
na_option,pct, andaxisparameters toSeries.rank(), andna_optionandpcttoDataFrame.rank(), to match the pandas API.na_option('keep'/'top'/'bottom'): controls howNaNvalues are rankedpct: expresses ranks as percentile fractions in(0, 1]axisonSeries.rank(): accepts0/'index'only, added for API compatibilityWhy are the changes needed?
The pandas-on-Spark implementations were missing these parameters, making it harder to migrate pandas code to Spark without modification.
DataFrame.rankwas tracked in SPARK-46167; this PR also coversSeries.rank.Does this PR introduce any user-facing change?
Yes. Two new keyword parameters on
Series.rank()andDataFrame.rank(). Defaults are unchanged so existing code is unaffected.How was this patch tested?
New test method test_rank_pct_na_option in test_compute.py and new cases in test_stat.py covering all methods, both axes, combined parameters, and invalid input errors.
Was this patch authored or co-authored using generative AI tooling?
This patch was co-authored with AI assistance (Claude Sonnet 4.6).