Skip to content

Commit

Permalink
bpo-22635: Update the getstatusoutput docstring. (python#3435)
Browse files Browse the repository at this point in the history
To match the documentation updates already made.
Also renames the local variable used within to match
what it actually holds.
  • Loading branch information
gpshead authored Sep 7, 2017
1 parent 888bbdc commit 2eb0cb4
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions Lib/subprocess.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 2eb0cb4

Please sign in to comment.