traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #13237: remove some details that only apply to the 3.x version of this module and cross reference the relocated warning about the dangers of invoking the shell with untrusted input

This commit is contained in:
Nick Coghlan 2011-10-26 21:15:53 +10:00
parent 2ed203af87
commit 65ad31a8f8
1 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Doc/library/subprocess.rst
View File

@ -101,9 +101,6 @@ use cases, the underlying :class:`Popen` interface can be used directly.
Examples:: Examples::
>>> subprocess.check_output(["echo", "Hello World!"]) >>> subprocess.check_output(["echo", "Hello World!"])
b'Hello World!\n'
>>> subprocess.check_output(["echo", "Hello World!"], universal_newlines=True)
'Hello World!\n' 'Hello World!\n'
>>> subprocess.check_output("exit 1", shell=True) >>> subprocess.check_output("exit 1", shell=True)
@ -111,13 +108,6 @@ use cases, the underlying :class:`Popen` interface can be used directly.
... ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1 subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1
By default, this function will return the data as encoded bytes. The actual
encoding of the output data may depend on the command being invoked, so the
decoding to text will often need to be handled at the application level.
This behaviour may be overridden by setting *universal_newlines* to
:const:`True` as described below in :ref:`frequently-used-arguments`.
To also capture standard error in the result, use To also capture standard error in the result, use
``stderr=subprocess.STDOUT``:: ``stderr=subprocess.STDOUT``::
@ -179,10 +169,8 @@ default values. The arguments that are most commonly needed are:
handle as for stdout. handle as for stdout.
When *stdout* or *stderr* are pipes and *universal_newlines* is When *stdout* or *stderr* are pipes and *universal_newlines* is
:const:`True` then the output data is assumed to be encoded as UTF-8 and :const:`True` then all line endings will be converted to ``'\n'`` as
will automatically be decoded to text. All line endings will be converted described for the universal newlines `'U'`` mode argument to :func:`open`.
to ``'\n'`` as described for the universal newlines `'U'`` mode argument
to :func:`open`.
If *shell* is :const:`True`, the specified command will be executed through If *shell* is :const:`True`, the specified command will be executed through
the shell. This can be useful if you are using Python primarily for the the shell. This can be useful if you are using Python primarily for the
@ -318,6 +306,12 @@ functions.
If *shell* is :const:`True`, the specified command will be executed through the If *shell* is :const:`True`, the specified command will be executed through the
shell. shell.
.. note::
Enabling this option can be a security hazard if combined with untrusted
input. See the warning under :ref:`frequently-used-arguments`
for details.
If *cwd* is not ``None``, the child's current directory will be changed to *cwd* If *cwd* is not ``None``, the child's current directory will be changed to *cwd*
before it is executed. Note that this directory is not considered when before it is executed. Note that this directory is not considered when
searching the executable, so you can't specify the program's path relative to searching the executable, so you can't specify the program's path relative to