Skip to content

Docs: clarify import of PIPE in subprocess docs #25416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 1, 2024
Merged

Docs: clarify import of PIPE in subprocess docs #25416

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6f7d672
clarify import of PIPE in subprocess docs
mdavis-xyz Apr 14, 2021
0a6e512
Merge branch 'main' into subprocess_dot_pipe_docs
JelleZijlstra Apr 2, 2022
5762de8
Merge branch 'main' into subprocess_dot_pipe_docs
kumaraditya303 Nov 25, 2022
2b9dccd
Merge branch 'main' into subprocess_dot_pipe_docs
erlend-aasland Mar 31, 2024
3eab7f3
Lint
erlend-aasland Mar 31, 2024
50b2704
Clarify where PIPE comes from in subprocess docs
mdavis-xyz Apr 1, 2024
c800498
Clarify PIPE vs capture_output in subprocess docs
mdavis-xyz Apr 1, 2024
d29b7bc
Merge branch 'main' into subprocess_dot_pipe_docs
mdavis-xyz Apr 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions Doc/library/subprocess.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,12 @@ underlying :class:`Popen` interface can be used directly.

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

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

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