[SPARK-40922][PYTHON] Document multiple path support in pyspark.pandas.read_csv
#38399
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can one of the admins verify this patch? |
HyukjinKwon
changed the title
pyspark.pandas.read_csvpyspark.pandas.read_csv
HyukjinKwon
reviewed
Oct 27, 2022
python/pyspark/pandas/namespace.py
Outdated
| path : str | ||
| The path string storing the CSV file to be read. | ||
| path : str or list | ||
| path(s) of the CSV file(s) to be read. |
Member
There was a problem hiding this comment.
Can we add this examaple to the docstring?
Contributor
There was a problem hiding this comment.
Yeah, let's add at least one example for docstring
Member
|
cc @itholic |
Contributor
|
Looks good except #38399 (comment) |
Contributor
Author
|
I added an example FYI: while looking around in the code, I suspect the feature of supporting multiple paths is also present in other |
HyukjinKwon
approved these changes
Oct 27, 2022
Member
|
Merged to master. |
SandishKumarHN
pushed a commit
to SandishKumarHN/spark
that referenced
this pull request
Dec 12, 2022
…as.read_csv` ### What changes were proposed in this pull request? as discussed in https://issues.apache.org/jira/browse/SPARK-40922: > The path argument of `pyspark.pandas.read_csv(path, ...)` currently has type annotation `str` and is documented as > > path : str > The path string storing the CSV file to be read. >The implementation however uses `pyspark.sql.DataFrameReader.csv(path, ...)` which does support multiple paths: > > path : str or list > string, or list of strings, for input path(s), > or RDD of Strings storing CSV rows. > This PR updates the type annotation and documentation of `path` argument of `pyspark.pandas.read_csv` ### Why are the changes needed? Loading multiple CSV files at once is a useful feature to have and should be documented ### Does this PR introduce _any_ user-facing change? it documents and existing feature ### How was this patch tested? No need for tests (so far): only type annotations and docblocks were changed Closes apache#38399 from soxofaan/SPARK-40922-pyspark-pandas-read-csv-multiple-paths. Authored-by: Stefaan Lippens <[email protected]> Signed-off-by: Hyukjin Kwon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
as discussed in https://issues.apache.org/jira/browse/SPARK-40922:
This PR updates the type annotation and documentation of
pathargument ofpyspark.pandas.read_csvWhy are the changes needed?
Loading multiple CSV files at once is a useful feature to have and should be documented
Does this PR introduce any user-facing change?
it documents and existing feature
How was this patch tested?
No need for tests (so far): only type annotations and docblocks were changed