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 2021/10/27 19:46:53 UTC
[GitHub] [spark] tnixon opened a new pull request #34406: Minor fix to docs for read_csv
tnixon opened a new pull request #34406:
URL: https://github.com/apache/spark/pull/34406
Fixed documentation of the escapechar parameter of read_csv function
(docs incorrectly say this is for escaping the delimiter - it is for escaping a quotechar)
<!--
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.
-->
--
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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786452886
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
Thanks for the work to improve the documents, but maybe I think it just follows the [pandas documents](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html), so maybe we can just keep it as is if there is no strong necessity.
Following the pandas as much as possible is the goal we aim for the most in pandas API on 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] AmplabJenkins commented on pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #34406:
URL: https://github.com/apache/spark/pull/34406#issuecomment-953271187
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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786452886
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
I think it just follows the [pandas documents](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html), so maybe we can just keep it as is if there is no strong necessity.
Following the pandas as much as possible is the goal we aim for the most in pandas API on 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] itholic commented on pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on pull request #34406:
URL: https://github.com/apache/spark/pull/34406#issuecomment-1062725236
Would you mind rebasing this PR to the 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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786452886
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
Thanks for fixing, but maybe I think it just follows the [pandas documents](https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html), so maybe we can just keep it as is if there is no strong necessity.
Following the pandas as much as possible is the goal we aim for the most in pandas API on 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] srowen commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
srowen commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r834482770
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used to escape other characters.
Review comment:
Would it be more accurate to say "delimiters and quotes"? not all other chars are escaped of course
--
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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786454523
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
And maybe the `escaper` is not only for escaping quotes inside an already quoted values ??
I think It can be any 1-length string other than quotes?
--
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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786452886
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
I think it just follows the pandas documents, so maybe we can just keep it as is if there is no strong necessity.
Following the pandas as much as possible is the goal we aim for the most in pandas API on 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] itholic commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
itholic commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r786454523
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
And maybe the `escaper` is not only for escaping quotes inside an already quoted values ??
I think It can be any 1-length string other than quotes?
Please let me know if I understand incorrectly!
--
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] tnixon commented on a change in pull request #34406: Minor fix to docs for read_csv
Posted by GitBox <gi...@apache.org>.
tnixon commented on a change in pull request #34406:
URL: https://github.com/apache/spark/pull/34406#discussion_r822225909
##########
File path: python/pyspark/pandas/namespace.py
##########
@@ -272,7 +272,7 @@ def read_csv(
The character used to denote the start and end of a quoted item. Quoted items can include
the delimiter and it will be ignored.
escapechar : str (length 1), default None
- One-character string used to escape delimiter
+ One-character string used for escaping quotes inside an already quoted value.
Review comment:
Good point @itholic - I have updated the PR to reflect the Pandas docs.
yes, this param is used to escape more than just the quotes, but also more than just the delimiter char (as suggested by the current language).
--
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