mirror of https://github.com/python/cpython
#7381: subprocess documentation and library docstring consistency fixes.
This commit is contained in:
parent
819a8fa0f6
commit
6ab5d083f2
|
@ -126,9 +126,10 @@ This module defines one class called :class:`Popen`:
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
This feature is only available if Python is built with universal newline support
|
This feature is only available if Python is built with universal newline
|
||||||
(the default). Also, the newlines attribute of the file objects :attr:`stdout`,
|
support (the default). Also, the newlines attribute of the file objects
|
||||||
:attr:`stdin` and :attr:`stderr` are not updated by the communicate() method.
|
:attr:`stdout`, :attr:`stdin` and :attr:`stderr` are not updated by the
|
||||||
|
communicate() method.
|
||||||
|
|
||||||
The *startupinfo* and *creationflags*, if given, will be passed to the
|
The *startupinfo* and *creationflags*, if given, will be passed to the
|
||||||
underlying CreateProcess() function. They can specify things such as appearance
|
underlying CreateProcess() function. They can specify things such as appearance
|
||||||
|
@ -162,7 +163,7 @@ This module also defines two shortcut functions:
|
||||||
|
|
||||||
The arguments are the same as for the Popen constructor. Example::
|
The arguments are the same as for the Popen constructor. Example::
|
||||||
|
|
||||||
retcode = call(["ls", "-l"])
|
>>> retcode = subprocess.call(["ls", "-l"])
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
@ -181,7 +182,8 @@ This module also defines two shortcut functions:
|
||||||
|
|
||||||
The arguments are the same as for the Popen constructor. Example::
|
The arguments are the same as for the Popen constructor. Example::
|
||||||
|
|
||||||
check_call(["ls", "-l"])
|
>>> subprocess.check_call(["ls", "-l"])
|
||||||
|
0
|
||||||
|
|
||||||
.. versionadded:: 2.5
|
.. versionadded:: 2.5
|
||||||
|
|
||||||
|
@ -208,8 +210,8 @@ This module also defines two shortcut functions:
|
||||||
To capture standard error in the result, use ``stderr=subprocess.STDOUT``::
|
To capture standard error in the result, use ``stderr=subprocess.STDOUT``::
|
||||||
|
|
||||||
>>> subprocess.check_output(
|
>>> subprocess.check_output(
|
||||||
["/bin/sh", "-c", "ls non_existent_file ; exit 0"],
|
... ["/bin/sh", "-c", "ls non_existent_file; exit 0"],
|
||||||
stderr=subprocess.STDOUT)
|
... stderr=subprocess.STDOUT)
|
||||||
'ls: non_existent_file: No such file or directory\n'
|
'ls: non_existent_file: No such file or directory\n'
|
||||||
|
|
||||||
.. versionadded:: 2.7
|
.. versionadded:: 2.7
|
||||||
|
|
|
@ -128,15 +128,15 @@ check_call(*popenargs, **kwargs):
|
||||||
check_call(["ls", "-l"])
|
check_call(["ls", "-l"])
|
||||||
|
|
||||||
check_output(*popenargs, **kwargs):
|
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
|
If the exit code was non-zero it raises a CalledProcessError. The
|
||||||
CalledProcessError object will have the return code in the returncode
|
CalledProcessError object will have the return code in the returncode
|
||||||
attribute and output in the output attribute.
|
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
|
Exceptions
|
||||||
----------
|
----------
|
||||||
|
@ -505,7 +505,7 @@ def check_call(*popenargs, **kwargs):
|
||||||
|
|
||||||
|
|
||||||
def check_output(*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
|
If the exit code was non-zero it raises a CalledProcessError. The
|
||||||
CalledProcessError object will have the return code in the returncode
|
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.
|
To capture standard error in the result, use stderr=subprocess.STDOUT.
|
||||||
|
|
||||||
>>> check_output(["/bin/sh", "-c",
|
>>> check_output(["/bin/sh", "-c",
|
||||||
"ls -l non_existent_file ; exit 0"],
|
... "ls -l non_existent_file ; exit 0"],
|
||||||
stderr=subprocess.STDOUT)
|
... stderr=subprocess.STDOUT)
|
||||||
'ls: non_existent_file: No such file or directory\n'
|
'ls: non_existent_file: No such file or directory\n'
|
||||||
"""
|
"""
|
||||||
if 'stdout' in kwargs:
|
if 'stdout' in kwargs:
|
||||||
|
|
Loading…
Reference in New Issue