This is an automated email from the ASF dual-hosted git repository.
ruifengz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 5a00631e5805 [SPARK-45442][PYTHON][DOCS] Refine docstring of
DataFrame.show
5a00631e5805 is described below
commit 5a00631e5805f3c1bc9d8e4827e2cf30ee312274
Author: allisonwang-db <[email protected]>
AuthorDate: Thu Oct 12 13:05:40 2023 +0800
[SPARK-45442][PYTHON][DOCS] Refine docstring of DataFrame.show
### What changes were proposed in this pull request?
This PR refines the docstring of `DataFrame.show` by adding more examples.
### Why are the changes needed?
To improve PySpark documentations.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
doctest
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #43252 from allisonwang-db/spark-45442-refine-show.
Authored-by: allisonwang-db <[email protected]>
Signed-off-by: Ruifeng Zheng <[email protected]>
---
python/pyspark/sql/dataframe.py | 49 ++++++++++++++++++++++++++++++++---------
1 file changed, 39 insertions(+), 10 deletions(-)
diff --git a/python/pyspark/sql/dataframe.py b/python/pyspark/sql/dataframe.py
index c44838c0ee11..637787ceb660 100644
--- a/python/pyspark/sql/dataframe.py
+++ b/python/pyspark/sql/dataframe.py
@@ -887,7 +887,8 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
return self._jdf.isEmpty()
def show(self, n: int = 20, truncate: Union[bool, int] = True, vertical:
bool = False) -> None:
- """Prints the first ``n`` rows to the console.
+ """
+ Prints the first ``n`` rows of the DataFrame to the console.
.. versionadded:: 1.3.0
@@ -896,20 +897,32 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
Parameters
----------
- n : int, optional
+ n : int, optional, default 20
Number of rows to show.
- truncate : bool or int, optional
- If set to ``True``, truncate strings longer than 20 chars by
default.
+ truncate : bool or int, optional, default True
+ If set to ``True``, truncate strings longer than 20 chars.
If set to a number greater than one, truncates long strings to
length ``truncate``
and align cells right.
vertical : bool, optional
- If set to ``True``, print output rows vertically (one line
- per column value).
+ If set to ``True``, print output rows vertically (one line per
column value).
Examples
--------
>>> df = spark.createDataFrame([
- ... (14, "Tom"), (23, "Alice"), (16, "Bob")], ["age", "name"])
+ ... (14, "Tom"), (23, "Alice"), (16, "Bob"), (19, "This is a super
long name")],
+ ... ["age", "name"])
+
+ Show :class:`DataFrame`
+
+ >>> df.show()
+ +---+--------------------+
+ |age| name|
+ +---+--------------------+
+ | 14| Tom|
+ | 23| Alice|
+ | 16| Bob|
+ | 19|This is a super l...|
+ +---+--------------------+
Show only top 2 rows.
@@ -922,6 +935,18 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
+---+-----+
only showing top 2 rows
+ Show full column content without truncation.
+
+ >>> df.show(truncate=False)
+ +---+-------------------------+
+ |age|name |
+ +---+-------------------------+
+ |14 |Tom |
+ |23 |Alice |
+ |16 |Bob |
+ |19 |This is a super long name|
+ +---+-------------------------+
+
Show :class:`DataFrame` where the maximum number of characters is 3.
>>> df.show(truncate=3)
@@ -931,20 +956,24 @@ class DataFrame(PandasMapOpsMixin, PandasConversionMixin):
| 14| Tom|
| 23| Ali|
| 16| Bob|
+ | 19| Thi|
+---+----+
Show :class:`DataFrame` vertically.
>>> df.show(vertical=True)
- -RECORD 0-----
+ -RECORD 0--------------------
age | 14
name | Tom
- -RECORD 1-----
+ -RECORD 1--------------------
age | 23
name | Alice
- -RECORD 2-----
+ -RECORD 2--------------------
age | 16
name | Bob
+ -RECORD 3--------------------
+ age | 19
+ name | This is a super l...
"""
if not isinstance(n, int) or isinstance(n, bool):
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
