diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2017-05-26 02:28:17 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2017-05-26 02:28:17 (GMT) |
| commit | 368cf1d20630498ca7939069a05d744fabb570aa (patch) | |
| tree | 0e4830c7d6fb712c1aa60366def6638f8b53ee38 /Doc | |
| parent | 18c1356ff6eac1d366346fd45b71a351c588d805 (diff) | |
| download | cpython-368cf1d20630498ca7939069a05d744fabb570aa.zip cpython-368cf1d20630498ca7939069a05d744fabb570aa.tar.gz cpython-368cf1d20630498ca7939069a05d744fabb570aa.tar.bz2 | |
bpo-30420: List cwd parameter in subprocess convenience APIs (GH-1685)
Partially clarify the subprocess convenience API documentation by
explicitly listing the `cwd` parameter in their abbreviated signatures.
While this has been merged as an improvement, it doesn't fully
resolve the issue, as the `cwd` should also be covered in the
"Frequently Used Arguments" section, and the fact these APIs
pass unlisted keyword arguments down to the lower level APIs
is currently still unclear.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/subprocess.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index afa1e86..2eaa48e 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -38,7 +38,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, timeout=None, check=False, \ + shell=False, cwd=None, timeout=None, check=False, \ encoding=None, errors=None) Run the command described by *args*. Wait for command to complete, then @@ -855,7 +855,7 @@ Prior to Python 3.5, these three functions comprised the high level API to subprocess. You can now use :func:`run` in many cases, but lots of existing code calls these functions. -.. function:: call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None) +.. function:: call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) Run the command described by *args*. Wait for command to complete, then return the :attr:`~Popen.returncode` attribute. @@ -881,7 +881,7 @@ calls these functions. .. versionchanged:: 3.3 *timeout* was added. -.. function:: check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None) +.. function:: check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None) Run command with arguments. Wait for command to complete. If the return code was zero then return, otherwise raise :exc:`CalledProcessError`. The @@ -911,7 +911,7 @@ calls these functions. .. function:: check_output(args, *, stdin=None, stderr=None, shell=False, \ - encoding=None, errors=None, \ + cwd=None, encoding=None, errors=None, \ universal_newlines=False, timeout=None) Run command with arguments and return its output. |