Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-87901: os.popen: Remove the encoding argument #92836

Merged
merged 3 commits into from
May 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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, \
Expand Down
5 changes: 2 additions & 3 deletions Lib/os.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Removed the ``encoding`` argument from :func:`os.popen` that was added in
3.11b1.