]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-87901: Add encoding to os.popen (GH-92374)
authorInada Naoki <songofacandy@gmail.com>
Fri, 6 May 2022 05:48:36 +0000 (14:48 +0900)
committerGitHub <noreply@github.com>
Fri, 6 May 2022 05:48:36 +0000 (14:48 +0900)
Doc/library/os.rst
Lib/os.py
Misc/NEWS.d/next/Library/2022-05-06-13-53-10.gh-issue-87901.NnkUVr.rst [new file with mode: 0644]

index 21c2073c9edc3f9e23733d929dce9811e6d65ff7..3c189bb40e234c7aad02d2d31069b637247fbf1b 100644 (file)
@@ -3916,12 +3916,13 @@ written in Python, such as a mail server's external command delivery program.
    .. availability:: Unix.
 
 
-.. function:: popen(cmd, mode='r', buffering=-1)
+.. function:: popen(cmd, mode='r', buffering=-1, encoding=None)
 
    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* argument has the same meaning as
+   is ``'r'`` (default) or ``'w'``.
+   The *buffering* and *encoding* arguments 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.
 
@@ -3944,6 +3945,9 @@ 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.
+
 
 .. function:: posix_spawn(path, argv, env, *, file_actions=None, \
                           setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
index 4626d1fc4a9b54e7ca458d53953bbfe913174da6..67662ca7ad8588f42b6847aba9b020a77dffe026 100644 (file)
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -974,7 +974,7 @@ 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):
+    def popen(cmd, mode="r", buffering=-1, encoding=None):
         if not isinstance(cmd, str):
             raise TypeError("invalid cmd type (%s, expected string)" % type(cmd))
         if mode not in ("r", "w"):
@@ -982,6 +982,7 @@ if sys.platform != 'vxworks':
         if buffering == 0 or buffering is None:
             raise ValueError("popen() does not support unbuffered streams")
         import subprocess, io
+        encoding = io.text_encoding(encoding)
         if mode == "r":
             proc = subprocess.Popen(cmd,
                                     shell=True, text=True,
diff --git a/Misc/NEWS.d/next/Library/2022-05-06-13-53-10.gh-issue-87901.NnkUVr.rst b/Misc/NEWS.d/next/Library/2022-05-06-13-53-10.gh-issue-87901.NnkUVr.rst
new file mode 100644 (file)
index 0000000..7f50dfb
--- /dev/null
@@ -0,0 +1 @@
+Add the *encoding* parameter to :func:`os.popen`.