]> granicus.if.org Git - python/commitdiff
bpo-32392: Document env keyword argument of subprocess.run() (GH-7289)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 5 Jun 2018 12:03:02 +0000 (05:03 -0700)
committerGitHub <noreply@github.com>
Tue, 5 Jun 2018 12:03:02 +0000 (05:03 -0700)
(cherry picked from commit af1ec97a6d1dde68b2dc0ee9b78965eb219061a8)

Co-authored-by: Tobias Kunze <r@rixx.de>
Doc/library/subprocess.rst

index fbf2c3d9fac9a26dcb3e593ae38551fbab947a58..58439864f37a088b6ae4a64ed842dd566d729284 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, text=None)
+                  encoding=None, errors=None, text=None, env=None)
 
    Run the command described by *args*.  Wait for command to complete, then
    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
    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::
 
       >>> subprocess.run(["ls", "-l"])  # doesn't capture output