[Python-checkins] [3.6] bpo-22635: subprocess.getstatusoutput doc update. (GH-3398) (#3411)

Wed Sep 6 22:57:54 EDT 2017

https://github.com/python/cpython/commit/dee54f6010ee2df60322c350a5f1dc8bfcf367d6
commit: dee54f6010ee2df60322c350a5f1dc8bfcf367d6
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Christian Heimes <christian at python.org>
date: 2017年09月06日T19:57:52-07:00
summary:
[3.6] bpo-22635: subprocess.getstatusoutput doc update. (GH-3398) (#3411)
The `subprocess.getstatusoutput` API was inadvertently changed
in Python 3.3.4. Document the change, it is too late to undo the
API change now as it has shipped in many stable releases.
(cherry picked from commit 738b7d9766e1a794aaaabfba0d515a467ba833ca)
files:
M Doc/library/subprocess.rst

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 663e232851b..27f3e825961 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -1166,27 +1166,32 @@ handling consistency are valid for these functions.
 
 .. function:: getstatusoutput(cmd)
 
- Return ``(status, output)`` of executing *cmd* in a shell.
+ Return ``(exitcode, output)`` of executing *cmd* in a shell.
 
 Execute the string *cmd* in a shell with :meth:`Popen.check_output` and
- return a 2-tuple ``(status, output)``. The locale encoding is used;
+ return a 2-tuple ``(exitcode, output)``. The locale encoding is used;
 see the notes on :ref:`frequently-used-arguments` for more details.
 
 A trailing newline is stripped from the output.
- The exit status for the command can be interpreted
- according to the rules for the C function :c:func:`wait`. Example::
+ The exit code for the command can be interpreted as the return code
+ of subprocess. Example::
 
 >>> subprocess.getstatusoutput('ls /bin/ls')
 (0, '/bin/ls')
 >>> subprocess.getstatusoutput('cat /bin/junk')
- (256, 'cat: /bin/junk: No such file or directory')
+ (1, 'cat: /bin/junk: No such file or directory')
 >>> subprocess.getstatusoutput('/bin/junk')
- (256, 'sh: /bin/junk: not found')
+ (127, 'sh: /bin/junk: not found')
+ >>> subprocess.getstatusoutput('/bin/kill $$')
+ (-15, '')
 
 Availability: POSIX & Windows
 
 .. versionchanged:: 3.3.4
- Windows support added
+ Windows support was added.
+
+ The function now returns (exitcode, output) instead of (status, output)
+ as it did in Python 3.3.3 and earlier. See :func:`WEXITSTATUS`.
 
 
 .. function:: getoutput(cmd)
