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/04/19 14:40:28 UTC
[GitHub] [spark] malthe opened a new pull request #32237: Quote arguments with "&" character on Windows
malthe opened a new pull request #32237:
URL: https://github.com/apache/spark/pull/32237
This fixes issue #35124. Note that it is quite unlikely that this issue would be mitigated or fixed in the Python standard library itself code due to the history of "subprocess.list2cmdline" (see https://bugs.python.org/issue8972 which was created in 2010).
<!--
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'.
-->
### What changes were proposed in this pull request?
This fixes support for the "&" character appearing in Spark configuration values (common in cloud resource URIs).
<!--
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?
If an "&" character appears in a configuration value, the Windows submit scripts do not work correctly, interpreting the character as the beginning of a new command rather as part of an argument.
<!--
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?
No.
<!--
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?
This was tested manually, providing a configuration value with a "&" character in it.
<!--
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.
-->
--
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.
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] malthe commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
malthe commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868778542
@holdenk I'm not really a Windows user either so I had to piece together a solution based on snippets and assorted help pages from Microsoft – really I just ended up experimenting to get it right.
--
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 removed a comment on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868821653
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/44871/
--
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] SparkQA removed a comment on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868763109
**[Test build #140340 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/140340/testReport)** for PR 32237 at commit [`5ed9037`](https://github.com/apache/spark/commit/5ed9037503b759f415a5f7632fc40d5ac5745592).
--
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 #32237: Quote arguments with "&" character on Windows
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-822535885
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.
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 removed a comment on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-822535885
--
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] malthe commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
malthe commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-822708928
I have added support for the remaining set of characters: "&<>()|,;^".
--
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.
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] malthe commented on a change in pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
malthe commented on a change in pull request #32237:
URL: https://github.com/apache/spark/pull/32237#discussion_r658958091
##########
File path: python/pyspark/java_gateway.py
##########
@@ -97,8 +99,18 @@ def preexec_func():
popen_kwargs['preexec_fn'] = preexec_func
proc = Popen(command, **popen_kwargs)
else:
+ # If an argument contains a character that needs escaping (e.g. an
+ # ampersand) we need to apply a double quoting mechanism to correctly
+ # pass the value through the submit shell scripts.
+ def quote(s):
+ r, count = subn(r"([&<>()|,;^])", r"^^^\1", s)
+ if count:
+ return '"""' + r + '"""'
+ return s
Review comment:
I have looked and not found any ...
--
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] SparkQA commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868763109
**[Test build #140340 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/140340/testReport)** for PR 32237 at commit [`5ed9037`](https://github.com/apache/spark/commit/5ed9037503b759f415a5f7632fc40d5ac5745592).
--
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] github-actions[bot] commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-933056131
We're closing this PR because it hasn't been updated in a while. This isn't a judgement on the merit of the PR in any way. It's just a way of keeping the PR queue manageable.
If you'd like to revive this PR, please reopen it and ask a committer to remove the Stale tag!
--
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] SparkQA commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868809177
Kubernetes integration test status success
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/44871/
--
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] SparkQA commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868792245
Kubernetes integration test starting
URL: https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder-K8s/44871/
--
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] holdenk commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
holdenk commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868746291
Jenkins ok to test
--
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] github-actions[bot] closed pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed pull request #32237:
URL: https://github.com/apache/spark/pull/32237
--
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] holdenk commented on a change in pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
holdenk commented on a change in pull request #32237:
URL: https://github.com/apache/spark/pull/32237#discussion_r658953261
##########
File path: python/pyspark/java_gateway.py
##########
@@ -97,8 +99,18 @@ def preexec_func():
popen_kwargs['preexec_fn'] = preexec_func
proc = Popen(command, **popen_kwargs)
else:
+ # If an argument contains a character that needs escaping (e.g. an
+ # ampersand) we need to apply a double quoting mechanism to correctly
+ # pass the value through the submit shell scripts.
+ def quote(s):
+ r, count = subn(r"([&<>()|,;^])", r"^^^\1", s)
+ if count:
+ return '"""' + r + '"""'
+ return s
Review comment:
Can we put this in a utils function and or is there a library that does this escaping? I imagine there's a bunch of random values and I'd rather us get them all.
--
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] SparkQA commented on pull request #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
SparkQA commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868763891
**[Test build #140340 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/140340/testReport)** for PR 32237 at commit [`5ed9037`](https://github.com/apache/spark/commit/5ed9037503b759f415a5f7632fc40d5ac5745592).
* This patch **fails Python style tests**.
* This patch merges cleanly.
* This patch adds no public classes.
--
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 #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868821653
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/44871/
--
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 #32237: Quote arguments with special characters (e.g. "&") on Windows
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on pull request #32237:
URL: https://github.com/apache/spark/pull/32237#issuecomment-868763913
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/140340/
--
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