[SPARK-46568][PYTHON] Make Python data source options a case-insensitive dictionary #44564
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
HyukjinKwon
reviewed
Jan 3, 2024
allisonwang-db
force-pushed
the
spark-46568-ds-options
branch
from
0cf2162 to
9075dab
Compare
HyukjinKwon
approved these changes
Jan 3, 2024
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
Please fix Python flake8 check failure, @allisonwang-db .
flake8 checks failed:
./python/pyspark/sql/datasource.py:19:1: F401 'typing.final' imported but unused
from typing import final, Any, Dict, Iterator, List, Sequence, Tuple, Type, Union, TYPE_CHECKING
Member
|
linter failure seems related. let's fix up. |
Contributor
Author
|
@HyukjinKwon fixed! |
Member
|
Merged to master for Apache Spark 4. |
vinodkc
pushed a commit
to vinodkc/spark
that referenced
this pull request
Jan 5, 2024
…ive dictionary
### What changes were proposed in this pull request?
This PR updates the `options` field to use a case-insensitive dictionary to keep the behavior consistent with the Scala side (which uses `CaseInsensitiveStringMap`). Currently, `options` are stored in a normal Python dictionary which can be confusing to users. For instance:
```python
class MyDataSource(DataSource):
def __init__(self, options):
self.api_key = options.get("API_KEY") # <- This is None
spark.read.format(..).option("API_KEY", my_key).load(...)
```
Here, `options` will not have this "API_KEY" as everything is converted to lowercase on the Scala side.
### Why are the changes needed?
To improve usability.
### Does this PR introduce _any_ user-facing change?
No
### How was this patch tested?
New unit tests
### Was this patch authored or co-authored using generative AI tooling?
No
Closes apache#44564 from allisonwang-db/spark-46568-ds-options.
Authored-by: allisonwang-db <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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?
This PR updates the
optionsfield to use a case-insensitive dictionary to keep the behavior consistent with the Scala side (which usesCaseInsensitiveStringMap). Currently,optionsare stored in a normal Python dictionary which can be confusing to users. For instance:Here,
optionswill not have this "API_KEY" as everything is converted to lowercase on the Scala side.Why are the changes needed?
To improve usability.
Does this PR introduce any user-facing change?
No
How was this patch tested?
New unit tests
Was this patch authored or co-authored using generative AI tooling?
No