Quote tokens when logging pip commands
#4761
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
Previously, pip commands were printed as lists of tokens. a82bbb7 amended the logging to join the tokens with strings. However, this will lead to invalid commands if any token contains a space or some other special character that needs to be escaped for standard shells. In order to improve the logging, this commit shell-quotes each token before joining the results with spaces.
|
Please advise if I should add a unit test for |
|
That is okay, thanks. |
|
Thanks for the quick response, @frostming 🙏 |
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.
The issue
See #4760.
The fix
In order to improve the logging, this commit shell-quotes each token before joining the results with spaces. This means that users should be able to copy and paste logged commands and run them using any common shell without issue, including when paths contain spaces or other special characters.
The checklist
news/directory to describe this fix with the extension.bugfix,.feature,.behavior,.doc..vendor. or.trivial(this will appear in the release changelog). Use semantic line breaks and name the file after the issue number or the PR #.