#7381: subprocess documentation and library docstring consistency fixes.

This commit is contained in:
Georg Brandl 2009-12-20 14:33:20 +00:00
parent 819a8fa0f6
commit 6ab5d083f2
2 changed files with 18 additions and 16 deletions

View file

@ -128,15 +128,15 @@ check_call(*popenargs, **kwargs):
check_call(["ls", "-l"])
check_output(*popenargs, **kwargs):
Run command with arguments and return its output as a byte string.
Run command with arguments and return its output as a byte string.
If the exit code was non-zero it raises a CalledProcessError. The
CalledProcessError object will have the return code in the returncode
attribute and output in the output attribute.
If the exit code was non-zero it raises a CalledProcessError. The
CalledProcessError object will have the return code in the returncode
attribute and output in the output attribute.
The arguments are the same as for the Popen constructor. Example:
The arguments are the same as for the Popen constructor. Example:
output = subprocess.check_output(["ls", "-l", "/dev/null"])
output = subprocess.check_output(["ls", "-l", "/dev/null"])
Exceptions
----------
@ -505,7 +505,7 @@ def check_call(*popenargs, **kwargs):
def check_output(*popenargs, **kwargs):
"""Run command with arguments and return its output as a byte string.
r"""Run command with arguments and return its output as a byte string.
If the exit code was non-zero it raises a CalledProcessError. The
CalledProcessError object will have the return code in the returncode
@ -520,8 +520,8 @@ def check_output(*popenargs, **kwargs):
To capture standard error in the result, use stderr=subprocess.STDOUT.
>>> check_output(["/bin/sh", "-c",
"ls -l non_existent_file ; exit 0"],
stderr=subprocess.STDOUT)
... "ls -l non_existent_file ; exit 0"],
... stderr=subprocess.STDOUT)
'ls: non_existent_file: No such file or directory\n'
"""
if 'stdout' in kwargs: