#5096: document PyErr_PrintEx().

This commit is contained in:
Georg Brandl 2009-02-05 10:56:37 +00:00
parent f3048e5b96
commit 115fb350fa

View file

@ -35,12 +35,21 @@ in various ways. There is a separate error indicator for each thread.
Either alphabetical or some kind of structure.
.. cfunction:: void PyErr_Print()
.. cfunction:: 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!)
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
type, value and traceback of the printed exception, respectively.
.. cfunction:: void PyErr_Print()
Alias for ``PyErr_PrintEx(1)``.
.. cfunction:: PyObject* PyErr_Occurred()