mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 12:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)

Browse source
This commit is contained in:
Tobias Kunze 2018-06-05 13:41:42 +02:00 • committed by Berker Peksag
parent e336484847
commit af1ec97a6d
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/subprocess.rst
View file

@ -39,7 +39,7 @@ compatibility with older versions, see the :ref:`call-function-trio` section.
.. function:: run(args, *, stdin=None, input=None, stdout=None, stderr=None,\ .. function:: run(args, *, stdin=None, input=None, stdout=None, stderr=None,\
shell=False, cwd=None, timeout=None, check=False, \ shell=False, cwd=None, timeout=None, check=False, \
encoding=None, errors=None, text=None) encoding=None, errors=None, text=None, env=None)
Run the command described by *args*. Wait for command to complete, then Run the command described by *args*. Wait for command to complete, then
return a :class:`CompletedProcess` instance. return a :class:`CompletedProcess` instance.
@ -78,6 +78,11 @@ compatibility with older versions, see the :ref:`call-function-trio` section.
The *universal_newlines* argument is equivalent to *text* and is provided The *universal_newlines* argument is equivalent to *text* and is provided
for backwards compatibility. By default, file objects are opened in binary mode. for backwards compatibility. By default, file objects are opened in binary mode.
If *env* is not ``None``, it must be a mapping that defines the environment
variables for the new process; these are used instead of the default
behavior of inheriting the current process' environment. It is passed directly
to :class:`Popen`.
Examples:: Examples::
>>> subprocess.run(["ls", "-l"]) # doesn't capture output >>> subprocess.run(["ls", "-l"]) # doesn't capture output