gh-87597: Document TimeoutExpired.stdout & .stderr types (#97685)

This documents the behavior that has always been the case since timeout
support was introduced in Python 3.3.
This commit is contained in:
Gregory P. Smith 2022-09-30 10:45:47 -07:00 committed by GitHub
parent 1cc308d03c
commit b05dd79649
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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