[Python-checkins] bpo-22635: Update the getstatusoutput docstring. (#3435)

Thu Sep 7 19:11:07 EDT 2017

https://github.com/python/cpython/commit/2eb0cb4787d02d995a9bb6dc075983792c12835c
commit: 2eb0cb4787d02d995a9bb6dc075983792c12835c
branch: master
author: Gregory P. Smith <greg at krypto.org>
committer: GitHub <noreply at github.com>
date: 2017年09月07日T16:11:02-07:00
summary:
bpo-22635: Update the getstatusoutput docstring. (#3435)
To match the documentation updates already made.
Also renames the local variable used within to match
what it actually holds.
files:
M Lib/subprocess.py

diff --git a/Lib/subprocess.py b/Lib/subprocess.py
index f61ff0c3946..6b90d40564f 100644
--- a/Lib/subprocess.py
+++ b/Lib/subprocess.py
@@ -38,7 +38,7 @@
 getoutput(...): Runs a command in the shell, waits for it to complete,
 then returns the output
 getstatusoutput(...): Runs a command in the shell, waits for it to complete,
- then returns a (status, output) tuple
+ then returns a (exitcode, output) tuple
 """
 
 import sys
@@ -492,7 +492,7 @@ def list2cmdline(seq):
 #
 
 def 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 'check_output' and
 return a 2-tuple (status, output). The locale encoding is used
@@ -506,19 +506,21 @@ def getstatusoutput(cmd):
 >>> 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, '')
 """
 try:
 data = check_output(cmd, shell=True, universal_newlines=True, stderr=STDOUT)
- status = 0
+ exitcode = 0
 except CalledProcessError as ex:
 data = ex.output
- status = ex.returncode
+ exitcode = ex.returncode
 if data[-1:] == '\n':
 data = data[:-1]
- return status, data
+ return exitcode, data
 
 def getoutput(cmd):
 """Return output (stdout or stderr) of executing cmd in a shell.
