Using shlex.join() when logging a command
#490
Merged
Conversation
This file contains 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
dhermes
commented
Oct 2, 2021
nox/command.py
Outdated
| @@ -84,7 +85,7 @@ def run( | |||
| success_codes = [0] | |||
|
|
|||
| cmd, args = args[0], args[1:] | |||
| full_cmd = f"{cmd} {' '.join(args)}" | |||
| full_cmd = f"{cmd} {shlex.join(args)}" | |||
There was a problem hiding this comment.
Aw man; added in 3.8
There was a problem hiding this comment.
Luckily the implementation is dead simple:
def join(split_command):
"""Return a shell-escaped string from *split_command*."""
return ' '.join(quote(arg) for arg in split_command)and
$ python3.6 -c 'import shlex; print(shlex.quote)'
<function quote at 0x7f9c9e123d08>
$ python3.7 -c 'import shlex; print(shlex.quote)'
<function quote at 0x1023fd710>
dhermes
commented
Oct 2, 2021
nox/command.py
Outdated
| @@ -67,6 +68,11 @@ def _clean_env(env: Optional[dict]) -> Optional[dict]: | |||
| return clean_env | |||
|
|
|||
|
|
|||
| def _shlex_join(args: Sequence[str]) -> str: | |||
| # shlex.join() was added in Python 3.8 | |||
| return " ".join(shlex.quote(arg) for arg in split_command) | |||
There was a problem hiding this comment.
Whoops, copy-pasta life
dhermes
commented
Oct 2, 2021
| @@ -84,7 +90,7 @@ def run( | |||
| success_codes = [0] | |||
|
|
|||
| cmd, args = args[0], args[1:] | |||
| full_cmd = f"{cmd} {' '.join(args)}" | |||
| full_cmd = f"{cmd} {_shlex_join(args)}" | |||
There was a problem hiding this comment.
It occurs to me I should probably do a docs search for python -m pip and see what should be updated.
(As reviewers may already see from the branch name, I made this PR fully from the browser.)
theacodes
approved these changes
Oct 2, 2021
|
Thanks @dhermes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.