aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorStanley <46876382+slateny@users.noreply.github.com>2023-02-08 00:12:46 -0800
committerGitHub <noreply@github.com>2023-02-08 00:12:46 -0800
commit027adf42cd85db41fee05b0a40d89ef822876c97 (patch)
tree6e5c1787bf85e1d99f39de319fd5ce56ddcbfd3d
parenta9f01448a99c6a2ae34d448806176f2df3a5b323 (diff)
downloadcpython-027adf42cd85db41fee05b0a40d89ef822876c97.tar.gz
cpython-027adf42cd85db41fee05b0a40d89ef822876c97.zip
gh-47937: Note that Popen attributes are read-only (#93070)
* Note that Popen attributes aren't meant to be set by users by rewording the text about the attributes. * Also update some universal_newlines references to mention the modern text parameter name while in the area. Co-authored-by: Gregory P. Smith <greg@krypto.org>
-rw-r--r--Doc/library/subprocess.rst23
1 files changed, 12 insertions, 11 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 785251afdf2..a87369a2461 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -457,7 +457,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
@@ -847,7 +847,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
@@ -860,9 +861,9 @@ 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
@@ -870,9 +871,9 @@ The following attributes are also available:
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
@@ -880,9 +881,9 @@ The following attributes are also available:
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::