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-47937: Note that Popen attributes are read-only #93070

Merged
merged 3 commits into from
Feb 8, 2023
Merged
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
23 changes: 12 additions & 11 deletions Doc/library/subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ functions.
- :const:`0` means unbuffered (read and write are one
system call and can return short)
- :const:`1` means line buffered
(only usable if ``universal_newlines=True`` i.e., in a text mode)
(only usable if ``text=True`` or ``universal_newlines=True``)
- any other positive value means use a buffer of approximately that
size
- negative bufsize (the default) means the system default of
Expand Down Expand Up @@ -839,7 +839,8 @@ Instances of the :class:`Popen` class have the following methods:
On Windows :meth:`kill` is an alias for :meth:`terminate`.


The following attributes are also available:
The following attributes are also set by the class for you to access.
Reassigning them to new values is unsupported:

.. attribute:: Popen.args

Expand All @@ -852,29 +853,29 @@ The following attributes are also available:

If the *stdin* argument was :data:`PIPE`, this attribute is a writeable
stream object as returned by :func:`open`. If the *encoding* or *errors*
arguments were specified or the *universal_newlines* argument was ``True``,
the stream is a text stream, otherwise it is a byte stream. If the *stdin*
argument was not :data:`PIPE`, this attribute is ``None``.
arguments were specified or the *text* or *universal_newlines* argument
was ``True``, the stream is a text stream, otherwise it is a byte stream.
If the *stdin* argument was not :data:`PIPE`, this attribute is ``None``.


.. attribute:: Popen.stdout

If the *stdout* argument was :data:`PIPE`, this attribute is a readable
stream object as returned by :func:`open`. Reading from the stream provides
output from the child process. If the *encoding* or *errors* arguments were
specified or the *universal_newlines* argument was ``True``, the stream is a
text stream, otherwise it is a byte stream. If the *stdout* argument was not
:data:`PIPE`, this attribute is ``None``.
specified or the *text* or *universal_newlines* argument was ``True``, the
stream is a text stream, otherwise it is a byte stream. If the *stdout*
argument was not :data:`PIPE`, this attribute is ``None``.


.. attribute:: Popen.stderr

If the *stderr* argument was :data:`PIPE`, this attribute is a readable
stream object as returned by :func:`open`. Reading from the stream provides
error output from the child process. If the *encoding* or *errors* arguments
were specified or the *universal_newlines* argument was ``True``, the stream
is a text stream, otherwise it is a byte stream. If the *stderr* argument was
not :data:`PIPE`, this attribute is ``None``.
were specified or the *text* or *universal_newlines* argument was ``True``, the
stream is a text stream, otherwise it is a byte stream. If the *stderr* argument
was not :data:`PIPE`, this attribute is ``None``.

.. warning::

Expand Down