From: Colin Watson <cjwatson@debian.org>
Date: Thu, 14 Nov 2024 05:01:35 +0000 (+0000)
Subject: Doc: Recommend shlex.quote alongside pipes removal (#126570)
X-Git-Tag: v3.14.0a2~49
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=73e34b680852794d110cd806505b3d74d9d593db;p=thirdparty%2FPython%2Fcpython.git

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.
---

diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index de4c7fd4c048..664b18661723 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.