From af1ec97a6d1dde68b2dc0ee9b78965eb219061a8 Mon Sep 17 00:00:00 2001 From: Tobias Kunze Date: Tue, 5 Jun 2018 13:41:42 +0200 Subject: [PATCH] bpo-32392: Document env keyword argument of subprocess.run() (GH-7289) --- Doc/library/subprocess.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index fbf2c3d9fa..58439864f3 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -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 -- 2.40.0