Skip to content

Commit 4a3fc49

Browse files
[3.12] Docs: add more links to PIPE in subprocess docs (GH-25416) (#117427)
(cherry picked from commit fc20716) Co-authored-by: Matthew Davis <[email protected]>
1 parent 87e470b commit 4a3fc49

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

Doc/library/subprocess.rst

+8-5
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,12 @@ underlying :class:`Popen` interface can be used directly.
5252

5353
If *capture_output* is true, stdout and stderr will be captured.
5454
When used, the internal :class:`Popen` object is automatically created with
55-
``stdout=PIPE`` and ``stderr=PIPE``. The *stdout* and *stderr* arguments may
56-
not be supplied at the same time as *capture_output*. If you wish to capture
57-
and combine both streams into one, use ``stdout=PIPE`` and ``stderr=STDOUT``
58-
instead of *capture_output*.
55+
*stdout* and *stdin* both set to :data:`~subprocess.PIPE`.
56+
The *stdout* and *stderr* arguments may not be supplied at the same time as *capture_output*.
57+
If you wish to capture and combine both streams into one,
58+
set *stdout* to :data:`~subprocess.PIPE`
59+
and *stderr* to :data:`~subprocess.STDOUT`,
60+
instead of using *capture_output*.
5961

6062
A *timeout* may be specified in seconds, it is internally passed on to
6163
:meth:`Popen.communicate`. If the timeout expires, the child process will be
@@ -69,7 +71,8 @@ underlying :class:`Popen` interface can be used directly.
6971
subprocess's stdin. If used it must be a byte sequence, or a string if
7072
*encoding* or *errors* is specified or *text* is true. When
7173
used, the internal :class:`Popen` object is automatically created with
72-
``stdin=PIPE``, and the *stdin* argument may not be used as well.
74+
*stdin* set to :data:`~subprocess.PIPE`,
75+
and the *stdin* argument may not be used as well.
7376

7477
If *check* is true, and the process exits with a non-zero exit code, a
7578
:exc:`CalledProcessError` exception will be raised. Attributes of that

0 commit comments

Comments
 (0)