Doc: Recommend shlex.quote alongside pipes removal #126570
Merged
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
One of the most common reasons I see the old `pipes` module still in use when porting to Python 3.13 is for the undocumented `pipes.quote` function, which can easily be replaced with `shlex.quote`. I think it's worth specifically calling this out, since being directed to the `subprocess` module would be confusing in this case.
ZeroIntensity
approved these changes
Nov 8, 2024
hauntsaninja
approved these changes
Nov 14, 2024
|
Thanks @cjwatson for the PR, and @hauntsaninja for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 14, 2024
One of the most common reasons I see the old `pipes` module still in use when porting to Python 3.13 is for the undocumented `pipes.quote` function, which can easily be replaced with `shlex.quote`. I think it's worth specifically calling this out, since being directed to the `subprocess` module would be confusing in this case. (cherry picked from commit 73e34b6) Co-authored-by: Colin Watson <cjwatson@debian.org>
|
GH-126820 is a backport of this pull request to the 3.13 branch. |
hauntsaninja
pushed a commit
that referenced
this pull request
Nov 14, 2024
…#126820) Doc: Recommend shlex.quote alongside pipes removal (GH-126570) One of the most common reasons I see the old `pipes` module still in use when porting to Python 3.13 is for the undocumented `pipes.quote` function, which can easily be replaced with `shlex.quote`. I think it's worth specifically calling this out, since being directed to the `subprocess` module would be confusing in this case. (cherry picked from commit 73e34b6) Co-authored-by: Colin Watson <cjwatson@debian.org>
picnixz
pushed a commit
to picnixz/cpython
that referenced
this pull request
Dec 8, 2024
One of the most common reasons I see the old `pipes` module still in use when porting to Python 3.13 is for the undocumented `pipes.quote` function, which can easily be replaced with `shlex.quote`. I think it's worth specifically calling this out, since being directed to the `subprocess` module would be confusing in this case.
ebonnal
pushed a commit
to ebonnal/cpython
that referenced
this pull request
Jan 12, 2025
One of the most common reasons I see the old `pipes` module still in use when porting to Python 3.13 is for the undocumented `pipes.quote` function, which can easily be replaced with `shlex.quote`. I think it's worth specifically calling this out, since being directed to the `subprocess` module would be confusing in this case.
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.
One of the most common reasons I see the old
pipesmodule still in use when porting to Python 3.13 is for the undocumentedpipes.quotefunction, which can easily be replaced withshlex.quote. I think it's worth specifically calling this out, since being directed to thesubprocessmodule would be confusing in this case.📚 Documentation preview 📚: https://cpython-previews--126570.org.readthedocs.build/