]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-87901: Remove the encoding argument from os.popen (GH-92836)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 19 May 2022 03:12:47 +0000 (20:12 -0700)
committerGitHub <noreply@github.com>
Thu, 19 May 2022 03:12:47 +0000 (20:12 -0700)
(cherry picked from commit 96f65835f8f66d058b444e0b4e436af45e2902f7)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
Doc/library/os.rst
Lib/os.py
Misc/NEWS.d/next/Library/2022-05-18-21-04-09.gh-issue-87901.lnf041.rst [new file with mode: 0644]

index 3c189bb40e234c7aad02d2d31069b637247fbf1b..dc0f2e4158ac0e1cbccbe3c6db2495c62bb2e388 100644 (file)
@@ -3916,13 +3916,13 @@ written in Python, such as a mail server's external command delivery program.
    .. availability:: Unix.
 
 
-.. function:: popen(cmd, mode='r', buffering=-1, encoding=None)
+.. function:: popen(cmd, mode='r', buffering=-1)
 
    Open a pipe to or from command *cmd*.
    The return value is an open file object
    connected to the pipe, which can be read or written depending on whether *mode*
    is ``'r'`` (default) or ``'w'``.
-   The *buffering* and *encoding* arguments have the same meaning as
+   The *buffering* argument have the same meaning as
    the corresponding argument to the built-in :func:`open` function. The
    returned file object reads or writes text strings rather than bytes.
 
@@ -3945,8 +3945,13 @@ written in Python, such as a mail server's external command delivery program.
    documentation for more powerful ways to manage and communicate with
    subprocesses.
 
-   .. versionchanged:: 3.11
-      Added the *encoding* parameter.
+   .. note::
+      The :ref:`Python UTF-8 Mode <utf8-mode>` affects encodings used
+      for *cmd* and pipe contents.
+
+      :func:`popen` is a simple wrapper around :class:`subprocess.Popen`.
+      Use :class:`subprocess.Popen` or :func:`subprocess.run` to
+      control options like encodings.
 
 
 .. function:: posix_spawn(path, argv, env, *, file_actions=None, \
index 67662ca7ad8588f42b6847aba9b020a77dffe026..648188e0f13490efade8c6a74f5db76b50186e38 100644 (file)
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -974,15 +974,14 @@ otherwise return -SIG, where SIG is the signal that killed it. """
 # command in a shell can't be supported.
 if sys.platform != 'vxworks':
     # Supply os.popen()
-    def popen(cmd, mode="r", buffering=-1, encoding=None):
+    def popen(cmd, mode="r", buffering=-1):
         if not isinstance(cmd, str):
             raise TypeError("invalid cmd type (%s, expected string)" % type(cmd))
         if mode not in ("r", "w"):
             raise ValueError("invalid mode %r" % mode)
         if buffering == 0 or buffering is None:
             raise ValueError("popen() does not support unbuffered streams")
-        import subprocess, io
-        encoding = io.text_encoding(encoding)
+        import subprocess
         if mode == "r":
             proc = subprocess.Popen(cmd,
                                     shell=True, text=True,
diff --git a/Misc/NEWS.d/next/Library/2022-05-18-21-04-09.gh-issue-87901.lnf041.rst b/Misc/NEWS.d/next/Library/2022-05-18-21-04-09.gh-issue-87901.lnf041.rst
new file mode 100644 (file)
index 0000000..3488541
--- /dev/null
@@ -0,0 +1,2 @@
+Removed the ``encoding`` argument from :func:`os.popen` that was added in
+3.11b1.