summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-09-30 17:53:07 (GMT)
committerGitHub <noreply@github.com>2022-09-30 17:53:07 (GMT)
commit6d7dbcc0b365c9f227a4c299211c068b3da54a90 (patch)
treef55aa8c1af208f365c8110d0f00a356c9ef1e660 /Doc/library
parentb61a51a450f8115ec1f174a00f4e70237148e92b (diff)
downloadcpython-6d7dbcc0b365c9f227a4c299211c068b3da54a90.zip
cpython-6d7dbcc0b365c9f227a4c299211c068b3da54a90.tar.gz
cpython-6d7dbcc0b365c9f227a4c299211c068b3da54a90.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')
-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 45fcfc7..f35a820 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -192,7 +192,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
@@ -201,7 +204,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