bpo-45554: Document multiprocessing.Process.exitcode values (GH-30142)

This addresses [bpo-45554]() by expanding the `exitcode` documentation to also describe what `exitcode` will be in cases of normal termination, `sys.exit()` called, and on uncaught exceptions.

Automerge-Triggered-By: GH:pitrou
This commit is contained in:
John Marshall 2022-01-18 21:31:27 +00:00 committed by GitHub
parent 16bf9bd157
commit 3852269b91
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 2 deletions

View file

@ -569,8 +569,15 @@ The :mod:`multiprocessing` package mostly replicates the API of the
.. attribute:: exitcode
The child's exit code. This will be ``None`` if the process has not yet
terminated. A negative value *-N* indicates that the child was terminated
by signal *N*.
terminated.
If the child's :meth:`run` method returned normally, the exit code
will be 0. If it terminated via :func:`sys.exit` with an integer
argument *N*, the exit code will be *N*.
If the child terminated due to an exception not caught within
:meth:`run`, the exit code will be 1. If it was terminated by
signal *N*, the exit code will be the negative value *-N*.
.. attribute:: authkey

View file

@ -1118,6 +1118,7 @@ Vincent Marchetti
David Marek
Doug Marien
Sven Marnach
John Marshall
Alex Martelli
Dennis Mårtensson
Anthony Martin