From 115fb350fae25b6e7145cd5ab14fe458f5d1b6af Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 5 Feb 2009 10:56:37 +0000 Subject: #5096: document PyErr_PrintEx(). --- Doc/c-api/exceptions.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst index 3fb6e56..5355132 100644 --- a/Doc/c-api/exceptions.rst +++ b/Doc/c-api/exceptions.rst @@ -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() -- cgit v0.12