languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-19 15:11:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the surprising sideeffect PyErr_Print(). (#12081)

Browse source 
Did you know an API documented as printing the pending traceback would sometimes exit the process?

You do now.
This commit is contained in:
Gregory P. Smith 2019-02-27 15:27:32 -08:00 committed by GitHub
parent 4064089fce
commit 4173772031
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Doc/c-api/exceptions.rst
View file

@ -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