summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2024-11-14 05:01:35 (GMT)
committerGitHub <noreply@github.com>2024-11-14 05:01:35 (GMT)
commit73e34b680852794d110cd806505b3d74d9d593db (patch)
tree32ef46d10709692363162bb8d2014f0913de7753 /Doc
parent6a93a1adbb56a64ec6d20e8aab911439998502c9 (diff)
downloadcpython-73e34b680852794d110cd806505b3d74d9d593db.zip
cpython-73e34b680852794d110cd806505b3d74d9d593db.tar.gz
cpython-73e34b680852794d110cd806505b3d74d9d593db.tar.bz2
Doc: Recommend shlex.quote alongside pipes removal (#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.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/whatsnew/3.13.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index de4c7fd..664b186 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -1568,6 +1568,8 @@ and are now removed:
For audio playback, use the :pypi:`pygame` library from PyPI instead.
* :mod:`!pipes`:
Use the :mod:`subprocess` module instead.
+ Use :func:`shlex.quote` to replace the undocumented ``pipes.quote``
+ function.
* :mod:`!sndhdr`:
The :pypi:`filetype`, :pypi:`puremagic`, or :pypi:`python-magic` libraries
should be used as replacements.