diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-02-27 15:45:28 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-27 15:45:28 -0800 |
| commit | 661151b3417a30912024dc72854286f1db4fe72b (patch) | |
| tree | ae7d120f8df5a8d354daf400599bc33082d9d372 | |
| parent | 79e72591b17bfff8bee17ae837bfa4685e1599dc (diff) | |
| download | cpython3-661151b3417a30912024dc72854286f1db4fe72b.tar.gz | |
Document the surprising sideeffect PyErr_Print(). (GH-12081)
Did you know an API documented as printing the pending traceback would sometimes exit the process?
You do now.
(cherry picked from commit 4173772031747a9b249be4100b4aa9eda805ea23)
Co-authored-by: Gregory P. Smith <greg@krypto.org>
| -rw-r--r-- | Doc/c-api/exceptions.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst index dd1e026cb0..cd06096ef7 100644 --- a/Doc/c-api/exceptions.rst +++ b/Doc/c-api/exceptions.rst @@ -53,8 +53,12 @@ Printing and clearing .. c:function:: void PyErr_PrintEx(int set_sys_last_vars) Print a standard traceback to ``sys.stderr`` and clear the error indicator. - Call this function only when the error indicator is set. (Otherwise it will - cause a fatal error!) + **Unless** the error is a ``SystemExit``. In that case the no traceback + is printed and Python process will exit with the error code specified by + the ``SystemExit`` instance. + + Call this function **only** when the error indicator is set. Otherwise it + will cause a fatal error! If *set_sys_last_vars* is nonzero, the variables :data:`sys.last_type`, :data:`sys.last_value` and :data:`sys.last_traceback` will be set to the |