]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Doc: Recommend shlex.quote alongside pipes removal (#126570)
authorColin Watson <cjwatson@debian.org>
Thu, 14 Nov 2024 05:01:35 +0000 (05:01 +0000)
committerGitHub <noreply@github.com>
Thu, 14 Nov 2024 05:01:35 +0000 (05:01 +0000)
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.

Doc/whatsnew/3.13.rst

index de4c7fd4c0486ba91a32508419f1a3d032fad2d4..664b186617237895112f748f23b51c9384e41146 100644 (file)
@@ -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.