Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-46328: added sys.exception() #30514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 30 additions & 15 deletions Doc/library/sys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -378,26 +378,41 @@ always available.
.. versionadded:: 3.8
__unraisablehook__


.. function:: exception()

This function returns the exception instance that is currently being
handled. This exception is specific both to the current thread and
to the current stack frame. If the current stack frame is not handling
an exception, the exception is taken from the calling stack frame, or its
caller, and so on until a stack frame is found that is handling an
exception. Here, "handling an exception" is defined as "executing an
except clause." For any stack frame, only the exception being currently
handled is accessible.

.. index:: object: traceback

If no exception is being handled anywhere on the stack, ``None`` is
returned.

.. versionadded:: 3.11


.. function:: exc_info()

This function returns a tuple of three values that give information about the
exception that is currently being handled. The information returned is specific
both to the current thread and to the current stack frame. If the current stack
frame is not handling an exception, the information is taken from the calling
stack frame, or its caller, and so on until a stack frame is found that is
handling an exception. Here, "handling an exception" is defined as "executing
an except clause." For any stack frame, only information about the exception
being currently handled is accessible.
This function returns the old-style representation of the handled
exception. If an exception ``e`` is currently handled (so
:func:`exception` would return ``e``), :func:`exc_info` returns the
tuple ``(type(e), e, e.__traceback__)``.
That is, a tuple containing the type of the exception (a subclass of
:exc:`BaseException`), the exception itself, and a :ref:`traceback
object <traceback-objects>` which typically encapsulates the call
stack at the point where the exception last occurred.

.. index:: object: traceback

If no exception is being handled anywhere on the stack, a tuple containing
three ``None`` values is returned. Otherwise, the values returned are
``(type, value, traceback)``. Their meaning is: *type* gets the type of the
exception being handled (a subclass of :exc:`BaseException`); *value* gets
the exception instance (an instance of the exception type); *traceback* gets
a :ref:`traceback object <traceback-objects>` which typically encapsulates
the call stack at the point where the exception last occurred.
If no exception is being handled anywhere on the stack, this function
return a tuple containing three ``None`` values.

.. versionchanged:: 3.11
The ``type`` and ``traceback`` fields are now derived from the ``value``
Expand Down
2 changes: 1 addition & 1 deletion Doc/tutorial/errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ then re-raise the exception (allowing a caller to handle the exception as well):
raise

Alternatively the last except clause may omit the exception name(s), however the exception
value must then be retrieved from ``sys.exc_info()[1]``.
value must then be retrieved with ``sys.exception()``.

The :keyword:`try` ... :keyword:`except` statement has an optional *else
clause*, which, when present, must follow all *except clauses*. It is useful
Expand Down
3 changes: 3 additions & 0 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,9 @@ sys
the results of subsequent calls to :func:`exc_info`.
(Contributed by Irit Katriel in :issue:`45711`.)

* Add :func:`sys.exception` which returns the active exception instance
(equivalent to ``sys.exc_info()[1]``).
(Contributed by Irit Katriel in :issue:`46328`.)

threading
---------
Expand Down
63 changes: 63 additions & 0 deletions Lib/test/test_sys.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,69 @@ def baddisplayhook(obj):
code = compile("42", "<string>", "single")
self.assertRaises(ValueError, eval, code)

class ActiveExceptionTests(unittest.TestCase):
def test_exc_info_no_exception(self):
self.assertEqual(sys.exc_info(), (None, None, None))

def test_sys_exception_no_exception(self):
self.assertEqual(sys.exception(), None)

def test_exc_info_with_exception_instance(self):
def f():
raise ValueError(42)

try:
f()
except Exception as e_:
e = e_
exc_info = sys.exc_info()

self.assertIsInstance(e, ValueError)
self.assertIs(exc_info[0], ValueError)
self.assertIs(exc_info[1], e)
self.assertIs(exc_info[2], e.__traceback__)

def test_exc_info_with_exception_type(self):
def f():
raise ValueError

try:
f()
except Exception as e_:
e = e_
exc_info = sys.exc_info()

self.assertIsInstance(e, ValueError)
self.assertIs(exc_info[0], ValueError)
self.assertIs(exc_info[1], e)
self.assertIs(exc_info[2], e.__traceback__)

def test_sys_exception_with_exception_instance(self):
def f():
raise ValueError(42)

try:
f()
except Exception as e_:
e = e_
exc = sys.exception()

self.assertIsInstance(e, ValueError)
self.assertIs(exc, e)

def test_sys_exception_with_exception_type(self):
def f():
raise ValueError

try:
f()
except Exception as e_:
e = e_
exc = sys.exception()

self.assertIsInstance(e, ValueError)
self.assertIs(exc, e)


class ExceptHookTest(unittest.TestCase):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added the :meth:`sys.exception` method which returns the active exception instance.
24 changes: 23 additions & 1 deletion Python/clinic/sysmodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 25 additions & 1 deletion Python/sysmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -771,6 +771,28 @@ sys_excepthook_impl(PyObject *module, PyObject *exctype, PyObject *value,
}


/*[clinic input]
sys.exception

Return the current exception.

Return the most recent exception caught by an except clause
in the current stack frame or in an older stack frame, or None
if no such exception exists.
[clinic start generated code]*/

static PyObject *
sys_exception_impl(PyObject *module)
/*[clinic end generated code: output=2381ee2f25953e40 input=c88fbb94b6287431]*/
{
_PyErr_StackItem *err_info = _PyErr_GetTopmostException(_PyThreadState_GET());
if (err_info->exc_value != NULL) {
return Py_NewRef(err_info->exc_value);
}
Py_RETURN_NONE;
}


/*[clinic input]
sys.exc_info

Expand Down Expand Up @@ -1963,6 +1985,7 @@ static PyMethodDef sys_methods[] = {
SYS__CURRENT_FRAMES_METHODDEF
SYS__CURRENT_EXCEPTIONS_METHODDEF
SYS_DISPLAYHOOK_METHODDEF
SYS_EXCEPTION_METHODDEF
SYS_EXC_INFO_METHODDEF
SYS_EXCEPTHOOK_METHODDEF
SYS_EXIT_METHODDEF
Expand Down Expand Up @@ -2457,7 +2480,8 @@ Functions:\n\
\n\
displayhook() -- print an object to the screen, and save it in builtins._\n\
excepthook() -- print an exception and its traceback to sys.stderr\n\
exc_info() -- return thread-safe information about the current exception\n\
exception() -- return the current thread's active exception\n\
exc_info() -- return information about the current thread's active exception\n\
exit() -- exit the interpreter by raising SystemExit\n\
getdlopenflags() -- returns flags to be used for dlopen() calls\n\
getprofile() -- get the global profiling function\n\
Expand Down