[Python-checkins] gh-87901: Remove the encoding argument from os.popen (GH-92836)

miss-islington webhook-mailer at python.org
Wed May 18 23:13:07 EDT 2022


https://github.com/python/cpython/commit/aa55985aa85ebad5409ed5485fd4957d5ca28f94
commit: aa55985aa85ebad5409ed5485fd4957d5ca28f94
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-05-18T20:12:47-07:00
summary:

gh-87901: Remove the encoding argument from os.popen (GH-92836)

(cherry picked from commit 96f65835f8f66d058b444e0b4e436af45e2902f7)

Co-authored-by: Inada Naoki <songofacandy at gmail.com>

files:
A Misc/NEWS.d/next/Library/2022-05-18-21-04-09.gh-issue-87901.lnf041.rst
M Doc/library/os.rst
M Lib/os.py

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 3c189bb40e234..dc0f2e4158ac0 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -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, \
diff --git a/Lib/os.py b/Lib/os.py
index 67662ca7ad858..648188e0f1349 100644
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -974,15 +974,14 @@ def spawnlpe(mode, file, *args):
 # 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
index 0000000000000..3488541eb3d77
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2022-05-18-21-04-09.gh-issue-87901.lnf041.rst
@@ -0,0 +1,2 @@
+Removed the ``encoding`` argument from :func:`os.popen` that was added in
+3.11b1.



More information about the Python-checkins mailing list