]> granicus.if.org Git - python/commitdiff
[3.6] bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)
authorBerker Peksag <berker.peksag@gmail.com>
Thu, 7 Jun 2018 19:22:35 +0000 (22:22 +0300)
committerGitHub <noreply@github.com>
Thu, 7 Jun 2018 19:22:35 +0000 (22:22 +0300)
(cherry picked from commit af1ec97a6d1dde68b2dc0ee9b78965eb219061a8)

Conflicts:

Doc/library/subprocess.rst

Doc/library/subprocess.rst

index 6a5f276073b2c6c8d9b364f597187a71b8efcb91..f624adbda4c805ae5b4d325042785bc54e80b3c1 100644 (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,\
                   shell=False, cwd=None, timeout=None, check=False, \
-                  encoding=None, errors=None)
+                  encoding=None, errors=None, env=None)
 
    Run the command described by *args*.  Wait for command to complete, then
    return a :class:`CompletedProcess` instance.
@@ -75,6 +75,11 @@ compatibility with older versions, see the :ref:`call-function-trio` section.
    specified *encoding* and *errors* or the :class:`io.TextIOWrapper` default.
    Otherwise, 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::
 
       >>> subprocess.run(["ls", "-l"])  # doesn't capture output