Add note on capture_output arg to subprocess.run() docstring (#98012)

add note on capture_output arg to the docstring
This commit is contained in:
andrei kulakov 2022-10-07 13:08:08 -04:00 committed by GitHub
parent 72c166add8
commit 80b3e32d62
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions

View File

@ -509,7 +509,8 @@ def run(*popenargs,
The returned instance will have attributes args, returncode, stdout and
stderr. By default, stdout and stderr are not captured, and those attributes
will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.
will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them,
or pass capture_output=True to capture both.
If check is True and the exit code was non-zero, it raises a
CalledProcessError. The CalledProcessError object will have the return code