You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "sryza (via GitHub)" <gi...@apache.org> on 2025/08/22 17:02:58 UTC
[PR] improve python data source docs [spark]
sryza opened a new pull request, #52101:
URL: https://github.com/apache/spark/pull/52101
<!--
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
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
A few small improvements to the Python data source docs:
- Added more type annotations
- Added a little bit of hierarchy to make the relationships between sections more clear: nested several sections underneath a "Comprehensive Example: Data Source with Batch and Streaming Readers and Writers" section.
- A few small wording tweaks.
### Why are the changes needed?
I was reading the Python data source docs to learn how to use Python data sources and got confused by a few small things.
### Does this PR introduce _any_ user-facing change?
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
Re: [PR] [SPARK-53356][PYTHON][DOCS] Small improvements to python data source docs [spark]
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on code in PR #52101:
URL: https://github.com/apache/spark/pull/52101#discussion_r2334223808
##########
python/docs/source/tutorial/sql/python_data_source.rst:
##########
@@ -327,7 +355,7 @@ This is a streaming data writer that write the metadata information of each micr
cnt += 1
return SimpleCommitMessage(partition_id=partition_id, count=cnt)
- def commit(self, messages, batchId) -> None:
+ def commit(self, messages: List[Optional[WriterCommitMessage]], batchId: int) -> None:
Review Comment:
nit: This should be `List[Optional[SimpleCommitMessage]]`
##########
python/docs/source/tutorial/sql/python_data_source.rst:
##########
@@ -336,7 +364,7 @@ This is a streaming data writer that write the metadata information of each micr
with open(os.path.join(self.path, f"{batchId}.json"), "a") as file:
file.write(json.dumps(status) + "\n")
- def abort(self, messages, batchId) -> None:
+ def abort(self, messages: List[Optional[WriterCommitMessage]], batchId: int) -> None:
Review Comment:
ditto
--
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
Re: [PR] [SPARK-53356][PYTHON][DOCS] Small improvements to python data source docs [spark]
Posted by "sryza (via GitHub)" <gi...@apache.org>.
sryza closed pull request #52101: [SPARK-53356][PYTHON][DOCS] Small improvements to python data source docs
URL: https://github.com/apache/spark/pull/52101
--
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
Re: [PR] [SPARK-53356] Small improvements to python data source docs [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #52101:
URL: https://github.com/apache/spark/pull/52101#issuecomment-3218455084
cc @allisonwang-db
--
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
Re: [PR] [SPARK-53356][PYTHON][DOCS] Small improvements to python data source docs [spark]
Posted by "sryza (via GitHub)" <gi...@apache.org>.
sryza commented on code in PR #52101:
URL: https://github.com/apache/spark/pull/52101#discussion_r2372807990
##########
python/docs/source/tutorial/sql/python_data_source.rst:
##########
@@ -327,7 +355,7 @@ This is a streaming data writer that write the metadata information of each micr
cnt += 1
return SimpleCommitMessage(partition_id=partition_id, count=cnt)
- def commit(self, messages, batchId) -> None:
+ def commit(self, messages: List[Optional[WriterCommitMessage]], batchId: int) -> None:
Review Comment:
👍
##########
python/docs/source/tutorial/sql/python_data_source.rst:
##########
@@ -336,7 +364,7 @@ This is a streaming data writer that write the metadata information of each micr
with open(os.path.join(self.path, f"{batchId}.json"), "a") as file:
file.write(json.dumps(status) + "\n")
- def abort(self, messages, batchId) -> None:
+ def abort(self, messages: List[Optional[WriterCommitMessage]], batchId: int) -> None:
Review Comment:
👍
--
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
Re: [PR] [SPARK-53356][PYTHON][DOCS] Small improvements to python data source docs [spark]
Posted by "sryza (via GitHub)" <gi...@apache.org>.
sryza commented on PR #52101:
URL: https://github.com/apache/spark/pull/52101#issuecomment-3324668684
Thanks for catching @dongjoon-hyun – looks like I was missing an empty line at the start of the code block
--
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