You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/08/11 10:06:55 UTC
[GitHub] [spark] dcoliversun opened a new pull request, #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
dcoliversun opened a new pull request, #37482:
URL: https://github.com/apache/spark/pull/37482
<!--
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.
-->
This PR proposes to improve the examples in `pyspark.sql.streaming.query` by making each example self-contained with a brief explanation and a bit more realistic example.
### 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.
-->
To make the documentation more readable and able to copy and paste directly in PySpark shell.
### 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'.
-->
Yes, it changes the documentation.
### 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.
-->
Manually ran each doctest.
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r943335368
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -165,6 +165,11 @@ def explain(self, extended: bool = False) -> None:
Examples
--------
+ >>> sdf = spark.readStream.format("text").load("python/test_support/sql/streaming")
Review Comment:
I think we can also switch this to `spark.readStream.format("rate").load()`
--
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] dcoliversun commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
dcoliversun commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r946454199
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -300,6 +467,24 @@ def addListener(self, listener: StreamingQueryListener) -> None:
:class:`~pyspark.sql.streaming.StreamingQuery`.
.. versionadded:: 3.4.0
+
+ Examples
+ --------
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
+ >>> test_listener = TestListener()
+
+ Register streaming query listener
+ >>> spark.streams.addListener(test_listener)
Review Comment:
Thanks, updated :)
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r946444912
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -300,6 +467,24 @@ def addListener(self, listener: StreamingQueryListener) -> None:
:class:`~pyspark.sql.streaming.StreamingQuery`.
.. versionadded:: 3.4.0
+
+ Examples
+ --------
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
+ >>> test_listener = TestListener()
+
+ Register streaming query listener
+ >>> spark.streams.addListener(test_listener)
Review Comment:
Let's remove the listener back here too to avoid affecting other tests.
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r946444330
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -316,14 +501,33 @@ def removeListener(self, listener: StreamingQueryListener) -> None:
Deregister a :class:`StreamingQueryListener`.
.. versionadded:: 3.4.0
+
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
Review Comment:
```suggestion
```
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -300,6 +467,24 @@ def addListener(self, listener: StreamingQueryListener) -> None:
:class:`~pyspark.sql.streaming.StreamingQuery`.
.. versionadded:: 3.4.0
+
+ Examples
+ --------
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
Review Comment:
```suggestion
```
--
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] srowen commented on pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
srowen commented on PR #37482:
URL: https://github.com/apache/spark/pull/37482#issuecomment-1216655355
Merged to master
--
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] dcoliversun commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
dcoliversun commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r944098960
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -165,6 +165,11 @@ def explain(self, extended: bool = False) -> None:
Examples
Review Comment:
Addressed in https://github.com/apache/spark/pull/37482/commits/7d890d68fc82d860d6783976f30673d11d7ef4c9
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -165,6 +165,11 @@ def explain(self, extended: bool = False) -> None:
Examples
--------
+ >>> sdf = spark.readStream.format("text").load("python/test_support/sql/streaming")
Review Comment:
Addressed in https://github.com/apache/spark/commit/7d890d68fc82d860d6783976f30673d11d7ef4c9
--
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] dcoliversun commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
dcoliversun commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r944052100
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -337,7 +352,6 @@ def _test() -> None:
globs["spark"] = spark
globs["sqlContext"] = SQLContext.getOrCreate(spark.sparkContext)
Review Comment:
Good catch. Address in next commit :)
--
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] srowen closed pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
srowen closed pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
URL: https://github.com/apache/spark/pull/37482
--
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] xinrong-meng commented on pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
xinrong-meng commented on PR #37482:
URL: https://github.com/apache/spark/pull/37482#issuecomment-1212245579
Thanks @dcoliversun! We may also want to document parameters, e.g. `id` in `get` misses documents.
Also feel free to open another PR if you prefer :)
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r946444036
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -316,14 +501,33 @@ def removeListener(self, listener: StreamingQueryListener) -> None:
Deregister a :class:`StreamingQueryListener`.
.. versionadded:: 3.4.0
+
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
+ >>> test_listener = TestListener()
+
+ Register streaming query listener
Review Comment:
```suggestion
Register streaming query listener
```
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -316,14 +501,33 @@ def removeListener(self, listener: StreamingQueryListener) -> None:
Deregister a :class:`StreamingQueryListener`.
.. versionadded:: 3.4.0
+
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
+ >>> test_listener = TestListener()
+
+ Register streaming query listener
+ >>> spark.streams.addListener(test_listener)
+
+ Deregister streaming query listener
Review Comment:
```suggestion
Deregister streaming query listener
```
--
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] HyukjinKwon commented on pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on PR #37482:
URL: https://github.com/apache/spark/pull/37482#issuecomment-1216270209
@viirya and @HeartSaVioR FYI
--
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] AmplabJenkins commented on pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on PR #37482:
URL: https://github.com/apache/spark/pull/37482#issuecomment-1212424310
Can one of the admins verify this patch?
--
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] dcoliversun commented on pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
dcoliversun commented on PR #37482:
URL: https://github.com/apache/spark/pull/37482#issuecomment-1212647491
@xinrong-meng Good idea. I will do this on another PR :)
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r943335622
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -337,7 +352,6 @@ def _test() -> None:
globs["spark"] = spark
globs["sqlContext"] = SQLContext.getOrCreate(spark.sparkContext)
Review Comment:
Or remove it since SQLContext is deprecated.
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r943334859
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -165,6 +165,11 @@ def explain(self, extended: bool = False) -> None:
Examples
Review Comment:
Should also probably add examples to the API that do not have examples, e.g., `stop`.
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -165,6 +165,11 @@ def explain(self, extended: bool = False) -> None:
Examples
Review Comment:
or `processAllAvailable`
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r943334535
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -337,7 +352,6 @@ def _test() -> None:
globs["spark"] = spark
globs["sqlContext"] = SQLContext.getOrCreate(spark.sparkContext)
Review Comment:
We should probably remove `sqlContext` too (and replace the usages in the doctests to `spark`).
--
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] HyukjinKwon commented on a diff in pull request #37482: [SPARK-40042][PYTHON][DOCS] Make pyspark.sql.streaming.query examples self-contained
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on code in PR #37482:
URL: https://github.com/apache/spark/pull/37482#discussion_r946444510
##########
python/pyspark/sql/streaming/query.py:
##########
@@ -300,6 +467,24 @@ def addListener(self, listener: StreamingQueryListener) -> None:
:class:`~pyspark.sql.streaming.StreamingQuery`.
.. versionadded:: 3.4.0
+
+ Examples
+ --------
+ >>> from pyspark.sql.streaming import StreamingQueryListener
+ >>> class TestListener(StreamingQueryListener):
+ ... def onQueryStarted(self, event):
+ ... pass
+ ...
+ ... def onQueryProgress(self, event):
+ ... pass
+ ...
+ ... def onQueryTerminated(self, event):
+ ... pass
+
+ >>> test_listener = TestListener()
+
+ Register streaming query listener
Review Comment:
```suggestion
Register streaming query listener
```
--
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