summaryrefslogtreecommitdiffstats
path: root/Doc/library/subprocess.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-09-30 17:54:12 (GMT)
committerGitHub <noreply@github.com>2022-09-30 17:54:12 (GMT)
commitcdc01eaed9d19c17b4f01c3da3ca125c49fdffa5 (patch)
treecc6ee1229b6dc15838449de12b076f77d15b44fc /Doc/library/subprocess.rst
parentab2f1a615299b42a6dd7180519b7a35ba6dd4e6d (diff)
downloadcpython-cdc01eaed9d19c17b4f01c3da3ca125c49fdffa5.zip
cpython-cdc01eaed9d19c17b4f01c3da3ca125c49fdffa5.tar.gz
cpython-cdc01eaed9d19c17b4f01c3da3ca125c49fdffa5.tar.bz2
gh-87597: Document TimeoutExpired.stdout & .stderr types (GH-97685)
This documents the behavior that has always been the case since timeout support was introduced in Python 3.3. (cherry picked from commit b05dd796492160c37c9e15e3882f699f411b3461) Co-authored-by: Gregory P. Smith <greg@krypto.org>
Diffstat (limited to 'Doc/library/subprocess.rst')
-rw-r--r--Doc/library/subprocess.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 43d6ffc..dee5bd8 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -193,7 +193,10 @@ underlying :class:`Popen` interface can be used directly.
.. attribute:: output
Output of the child process if it was captured by :func:`run` or
- :func:`check_output`. Otherwise, ``None``.
+ :func:`check_output`. Otherwise, ``None``. This is always
+ :class:`bytes` when any output was captured regardless of the
+ ``text=True`` setting. It may remain ``None`` instead of ``b''``
+ when no output was observed.
.. attribute:: stdout
@@ -202,7 +205,9 @@ underlying :class:`Popen` interface can be used directly.
.. attribute:: stderr
Stderr output of the child process if it was captured by :func:`run`.
- Otherwise, ``None``.
+ Otherwise, ``None``. This is always :class:`bytes` when stderr output
+ was captured regardless of the ``text=True`` setting. It may remain
+ ``None`` instead of ``b''`` when no stderr output was observed.
.. versionadded:: 3.3