subprocess reports signal as negative exit status, not documented

[dmacnet]

BPO	27167
Nosy	@gpshead, @dmacnet

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/gpshead'
closed_at = <Date 2016-06-03.19:15:46.718>
created_at = <Date 2016-05-31.16:35:00.419>
labels = ['type-bug', 'library']
title = 'subprocess reports signal as negative exit status, not documented'
updated_at = <Date 2016-06-03.19:15:46.717>
user = 'https://github.com/dmacnet'

bugs.python.org fields:

activity = <Date 2016-06-03.19:15:46.717>
actor = 'gregory.p.smith'
assignee = 'gregory.p.smith'
closed = True
closed_date = <Date 2016-06-03.19:15:46.718>
closer = 'gregory.p.smith'
components = ['Library (Lib)']
creation = <Date 2016-05-31.16:35:00.419>
creator = 'dmacnet'
dependencies = []
files = []
hgrepos = []
issue_num = 27167
keywords = []
message_count = 7.0
messages = ['266758', '266760', '267009', '267052', '267055', '267056', '267140']
nosy_count = 3.0
nosy_names = ['gregory.p.smith', 'python-dev', 'dmacnet']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue27167'
versions = ['Python 3.6']

[dmacnet]

If a command run by subprocess.check_call() exits because of a signal, e.g. SIGPIPE, Popen._handle_exitstatus() encodes the signal number as a negative return code. check_call() then raises that as a CalledProcessError, which describes it as "returned non-zero exit status -13". This is misleading and undocumented.

CalledProcessError.__str__() should check if self.returncode is negative and if so return a string indicating that it was "signal 13", not "exit status -13". Better yet, it should include the descriptive name of the signal, e.g., SIGPIPE.

And, the documentation for the subprocess module should note that a signal is converted into a negative returncode.

[gpshead]

I'll take this as a documentation update for 3.5 and a feature request for better message text in 3.6.

[gpshead]

docs updated (7b12180481da and 19d77132f38d).

working on the error message update.

[python-dev]

New changeset f2d13349ea5d by Gregory P. Smith in branch 'default':
Issue bpo-27167: Clarify the subprocess.CalledProcessError error message text
https://hg.python.org/cpython/rev/f2d13349ea5d

[python-dev]

New changeset 1022d09d11e5 by Gregory P. Smith in branch 'default':
bpo-27167: make the test not care about the exact signal name in the
https://hg.python.org/cpython/rev/1022d09d11e5

[gpshead]

So this is mostly done... one oddity which may warrant improvement though: signal numbers have multiple names. ie: SIGABRT is also known as SIGIOT, etc.

This is likely to be confusing to if the error message is surfaced to the user as most users only know one common name rather than all of them as described in their system headers or the signal(7) man page.

I'd rather Python not be in the business of picking which name is more popular, but it can generate different error messages for the same signal across repeated runs due to hash randomization changing the order of the map in the signal.Signals type.

run python3.5 -c 'import signal; print(signal.Signals(6))' a handful of times to see this.

[python-dev]

New changeset 365b5e6163a6 by Gregory P. Smith in branch 'default':
signal, socket, and ssl module IntEnum constant name lookups now return a
https://hg.python.org/cpython/rev/365b5e6163a6