traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Alex Gaynor 2017-05-25 22:28:17 -04:00 committed by Nick Coghlan
parent 18c1356ff6
commit 368cf1d206
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Doc/library/subprocess.rst
View File

@ -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,\ .. 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) encoding=None, errors=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
@ -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 subprocess. You can now use :func:`run` in many cases, but lots of existing code
calls these functions. 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 Run the command described by *args*. Wait for command to complete, then
return the :attr:`~Popen.returncode` attribute. return the :attr:`~Popen.returncode` attribute.
@ -881,7 +881,7 @@ calls these functions.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
*timeout* was added. *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 Run command with arguments. Wait for command to complete. If the return
code was zero then return, otherwise raise :exc:`CalledProcessError`. The 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, \ .. 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) universal_newlines=False, timeout=None)
Run command with arguments and return its output. Run command with arguments and return its output.