Commit a588343
Document the surprising sideeffect PyErr_Print(). (pythonGH-12081)
Did you know an API documented as printing the pending traceback would sometimes exit the process?
You do now.
(cherry picked from commit 4173772)
Co-authored-by: Gregory P. Smith <greg@krypto.org>1 parent 60ef9b0 commit a588343
1 file changed
Lines changed: 6 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -44,8 +44,12 @@ is a separate error indicator for each thread. | |||
| 44 | 44 | .. c:function:: void PyErr_PrintEx(int set_sys_last_vars) | |
| 45 | 45 | ||
| 46 | 46 | Print a standard traceback to ``sys.stderr`` and clear the error indicator. | |
| 47 | - Call this function only when the error indicator is set. (Otherwise it will | ||
| 48 | - cause a fatal error!) | ||
| 47 | + **Unless** the error is a ``SystemExit``. In that case the no traceback | ||
| 48 | + is printed and Python process will exit with the error code specified by | ||
| 49 | + the ``SystemExit`` instance. | ||
| 50 | + | ||
| 51 | + Call this function **only** when the error indicator is set. Otherwise it | ||
| 52 | + will cause a fatal error! | ||
| 49 | 53 | ||
| 50 | 54 | If *set_sys_last_vars* is nonzero, the variables :data:`sys.last_type`, | |
| 51 | 55 | :data:`sys.last_value` and :data:`sys.last_traceback` will be set to the | |
0 commit comments