Document and fix command sanitizing with shlex.split#3245
Merged
Rowlando13 merged 1 commit intopallets:stablefrom Apr 8, 2026
Merged
Document and fix command sanitizing with shlex.split#3245Rowlando13 merged 1 commit intopallets:stablefrom
shlex.split#3245Rowlando13 merged 1 commit intopallets:stablefrom
Conversation
Removes last use of `shell=True` use for command invokation for defense-in-depth. Refs: pallets#1026, pallets#1477 and pallets#2775
kdeldycke
force-pushed
the
no-shell-command
branch
from
b6b3178 to
b96c260
Compare
Collaborator
Author
|
Thanks @Rowlando13 for the merge again ! 🎉 |
kdeldycke
added a commit
to kdeldycke/click
that referenced
this pull request
Apr 9, 2026
Add missing entries for pallets#3238 and pallets#3299 Fix wrong version for pallets#3245 changelog entry Lint section format
Collaborator
Author
|
There was a tiny issue with the location of the changelog entry for that PR that I fixed in 1339fd3 and moved it to the 8.3.3 section. |
davidism
reviewed
Apr 9, 2026
|
|
||
| .. note:: | ||
| ``posix=False`` `was considered but rejected | ||
| <https://github.com/pallets/click/pull/1477#issuecomment-620231711>`_ |
Member
There was a problem hiding this comment.
This comment, and the details above about PAGER splitting, isn't relevant to users. I also prefer not to have GitHub links in docs or comments at all. Add a simple explanation comment like "split doesn't use posix mode because ..." above the relevant code.
Member
There was a problem hiding this comment.
Actually, this linked issue suggests that shlex.split will not be correct across platforms. How did you determine that it is now correct?
davidism
reviewed
Apr 9, 2026
| because it retains quote characters in tokens. The | ||
| :func:`shlex.quote` approach was also reverted in :pr:`1543`. | ||
|
|
||
| .. seealso:: |
davidism
reviewed
Apr 9, 2026
|
|
||
| Returns `True` if the command was found, `False` otherwise and thus another | ||
| pager should be attempted. | ||
| .. seealso:: |
davidism
reviewed
Apr 9, 2026
| The editor command is split into an ``argv`` list with | ||
| :func:`shlex.split` in POSIX mode; see :func:`pager` for rationale. | ||
|
|
||
| .. seealso:: |
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
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.
Also removes last use of
shell=Trueuse for command invokation for defense-in-depth.Context
I was trying to eliminate the last usage of
shell=Trueinsubprocess.Popen, then had to resort to usingshlex.splitinedit_files. This led me into the rabbit hole ofshlex.splitusage in_termui_impl.pyfile. Which I use as an opportunity to document past choices from older issues and PRs.Tests
I also use that opportunity to collect test cases discussed in older related issues and PRs to illustrate and cover how we are expecting command path to be unquoted and interpreted on POSIX systems and Windows.
Related