You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "LuciferYang (via GitHub)" <gi...@apache.org> on 2023/08/29 06:11:38 UTC
[GitHub] [spark] LuciferYang opened a new pull request, #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
LuciferYang opened a new pull request, #42717:
URL: https://github.com/apache/spark/pull/42717
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1309674635
##########
python/pyspark/sql/functions.py:
##########
@@ -723,27 +750,67 @@ def desc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the descending order.
+ Target column to sort by in the descending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in descending order.
- >>> spark.range(5).orderBy(desc("id")).show()
- +---+
- | id|
- +---+
- | 4|
- | 3|
- | 2|
- | 1|
- | 0|
- +---+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.sort(desc("id")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 4| B|
+ | 3| A|
+ | 2| C|
+ +---+-----+
+
+ Example 2: Use `desc` in `orderBy` function to sort the DataFrame.
+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.orderBy(desc("value")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 2| C|
+ | 4| B|
+ | 3| A|
+ +---+-----+
+
+ Example 3: Combine `asc` with `desc` to sort by multiple columns.
+
+ >>> from pyspark.sql.functions import asc, desc
Review Comment:
On second thought, I will try to change all the imports in functions.py in one batch.
So no need to make a follow up :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1309566338
##########
python/pyspark/sql/functions.py:
##########
@@ -723,27 +750,67 @@ def desc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the descending order.
+ Target column to sort by in the descending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in descending order.
- >>> spark.range(5).orderBy(desc("id")).show()
- +---+
- | id|
- +---+
- | 4|
- | 3|
- | 2|
- | 1|
- | 0|
- +---+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.sort(desc("id")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 4| B|
+ | 3| A|
+ | 2| C|
+ +---+-----+
+
+ Example 2: Use `desc` in `orderBy` function to sort the DataFrame.
+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.orderBy(desc("value")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 2| C|
+ | 4| B|
+ | 3| A|
+ +---+-----+
+
+ Example 3: Combine `asc` with `desc` to sort by multiple columns.
+
+ >>> from pyspark.sql.functions import asc, desc
Review Comment:
yes, @LuciferYang what about making a follow up to apply `import pyspark.sql.functions as sf` (to be consistent with the quick start examples) ?
since we just started improving the docstring, I think it is a good chance to follow this import style which can avoid potential namespace conflicts (e.g. `from pyspark.sql.functions import max` vs python built-in function `max` )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1309675385
##########
python/pyspark/sql/functions.py:
##########
@@ -723,27 +750,67 @@ def desc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the descending order.
+ Target column to sort by in the descending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in descending order.
- >>> spark.range(5).orderBy(desc("id")).show()
- +---+
- | id|
- +---+
- | 4|
- | 3|
- | 2|
- | 1|
- | 0|
- +---+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.sort(desc("id")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 4| B|
+ | 3| A|
+ | 2| C|
+ +---+-----+
+
+ Example 2: Use `desc` in `orderBy` function to sort the DataFrame.
+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.orderBy(desc("value")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 2| C|
+ | 4| B|
+ | 3| A|
+ +---+-----+
+
+ Example 3: Combine `asc` with `desc` to sort by multiple columns.
+
+ >>> from pyspark.sql.functions import asc, desc
Review Comment:
OK
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] allisonwang-db commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1309380134
##########
python/pyspark/sql/functions.py:
##########
@@ -723,27 +750,67 @@ def desc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the descending order.
+ Target column to sort by in the descending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in descending order.
- >>> spark.range(5).orderBy(desc("id")).show()
- +---+
- | id|
- +---+
- | 4|
- | 3|
- | 2|
- | 1|
- | 0|
- +---+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.sort(desc("id")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 4| B|
+ | 3| A|
+ | 2| C|
+ +---+-----+
+
+ Example 2: Use `desc` in `orderBy` function to sort the DataFrame.
+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.orderBy(desc("value")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 2| C|
+ | 4| B|
+ | 3| A|
+ +---+-----+
+
+ Example 3: Combine `asc` with `desc` to sort by multiple columns.
+
+ >>> from pyspark.sql.functions import asc, desc
Review Comment:
cc @zhengruifeng should we in the future use this import style instead? `import pyspark.sql.functions as sf`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #42717:
URL: https://github.com/apache/spark/pull/42717#issuecomment-1697724949
thanks @dongjoon-hyun @HyukjinKwon @yaooqinn
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1308261175
##########
python/pyspark/sql/functions.py:
##########
@@ -670,50 +671,74 @@ def asc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the ascending order.
+ Target column to sort by in the ascending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in ascending order.
- >>> df = spark.range(5)
- >>> df = df.sort(desc("id"))
Review Comment:
The original example is incorrect, it demonstrated a desc example within function asc.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] dongjoon-hyun closed pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun closed pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
URL: https://github.com/apache/spark/pull/42717
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] dongjoon-hyun commented on pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #42717:
URL: https://github.com/apache/spark/pull/42717#issuecomment-1697686127
Merged to master for Apache Spark 4. Thank you, @LuciferYang and all.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] zhengruifeng commented on a diff in pull request #42717: [SPARK-45003][PYTHON][DOCS] Refine docstring of `asc/desc`
Posted by "zhengruifeng (via GitHub)" <gi...@apache.org>.
zhengruifeng commented on code in PR #42717:
URL: https://github.com/apache/spark/pull/42717#discussion_r1309566338
##########
python/pyspark/sql/functions.py:
##########
@@ -723,27 +750,67 @@ def desc(col: "ColumnOrName") -> Column:
Parameters
----------
col : :class:`~pyspark.sql.Column` or str
- target column to sort by in the descending order.
+ Target column to sort by in the descending order.
Returns
-------
:class:`~pyspark.sql.Column`
- the column specifying the order.
+ The column specifying the sort order.
Examples
--------
- Sort by the column 'id' in the descending order.
+ Example 1: Sort DataFrame by 'id' column in descending order.
- >>> spark.range(5).orderBy(desc("id")).show()
- +---+
- | id|
- +---+
- | 4|
- | 3|
- | 2|
- | 1|
- | 0|
- +---+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.sort(desc("id")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 4| B|
+ | 3| A|
+ | 2| C|
+ +---+-----+
+
+ Example 2: Use `desc` in `orderBy` function to sort the DataFrame.
+
+ >>> from pyspark.sql.functions import desc
+ >>> df = spark.createDataFrame([(4, 'B'), (3, 'A'), (2, 'C')], ['id', 'value'])
+ >>> df.orderBy(desc("value")).show()
+ +---+-----+
+ | id|value|
+ +---+-----+
+ | 2| C|
+ | 4| B|
+ | 3| A|
+ +---+-----+
+
+ Example 3: Combine `asc` with `desc` to sort by multiple columns.
+
+ >>> from pyspark.sql.functions import asc, desc
Review Comment:
yes, @LuciferYang what about making a follow up to apply `import pyspark.sql.functions as sf` (to be consistent with the quick start example) ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org