summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@redhat.com>2019-05-22 09:28:22 (GMT)
committerGitHub <noreply@github.com>2019-05-22 09:28:22 (GMT)
commitef9d9b63129a2f243591db70e9a2dd53fab95d86 (patch)
tree3ecd9bb04fba6c9d360b8db5d8b1e78cda50d49b /Doc/library/sys.rst
parent2725cb01d7cbf5caecb51cc20d97ba324b09ce96 (diff)
downloadcpython-ef9d9b63129a2f243591db70e9a2dd53fab95d86.zip
cpython-ef9d9b63129a2f243591db70e9a2dd53fab95d86.tar.gz
cpython-ef9d9b63129a2f243591db70e9a2dd53fab95d86.tar.bz2
bpo-36829: Add sys.unraisablehook() (GH-13187)
Add new sys.unraisablehook() function which can be overridden to control how "unraisable exceptions" are handled. It is called when an exception has occurred but there is no way for Python to handle it. For example, when a destructor raises an exception or during garbage collection (gc.collect()). Changes: * Add an internal UnraisableHookArgs type used to pass arguments to sys.unraisablehook. * Add _PyErr_WriteUnraisableDefaultHook(). * The default hook now ignores exception on writing the traceback. * test_sys now uses unittest.main() to automatically discover tests: remove test_main(). * Add _PyErr_Init(). * Fix PyErr_WriteUnraisable(): hold a strong reference to sys.stderr while using it
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst33
1 files changed, 29 insertions, 4 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 7d27c89..3b754bd 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -248,16 +248,19 @@ always available.
before the program exits. The handling of such top-level exceptions can be
customized by assigning another three-argument function to ``sys.excepthook``.
+ See also :func:`unraisablehook` which handles unraisable exceptions.
+
.. data:: __breakpointhook__
__displayhook__
__excepthook__
+ __unraisablehook__
These objects contain the original values of ``breakpointhook``,
- ``displayhook``, and ``excepthook`` at the start of the program. They are
- saved so that ``breakpointhook``, ``displayhook`` and ``excepthook`` can be
- restored in case they happen to get replaced with broken or alternative
- objects.
+ ``displayhook``, ``excepthook``, and ``unraisablehook`` at the start of the
+ program. They are saved so that ``breakpointhook``, ``displayhook`` and
+ ``excepthook``, ``unraisablehook`` can be restored in case they happen to
+ get replaced with broken or alternative objects.
.. versionadded:: 3.7
__breakpointhook__
@@ -1487,6 +1490,28 @@ always available.
is suppressed and only the exception type and value are printed.
+.. function:: unraisablehook(unraisable, /)
+
+ Handle an unraisable exception.
+
+ Called when an exception has occurred but there is no way for Python to
+ handle it. For example, when a destructor raises an exception or during
+ garbage collection (:func:`gc.collect`).
+
+ The *unraisable* argument has the following attributes:
+
+ * *exc_type*: Exception type.
+ * *exc_value*: Exception value, can be ``None``.
+ * *exc_traceback*: Exception traceback, can be ``None``.
+ * *object*: Object causing the exception, can be ``None``.
+
+ :func:`sys.unraisablehook` can be overridden to control how unraisable
+ exceptions are handled.
+
+ See also :func:`excepthook` which handles uncaught exceptions.
+
+ .. versionadded:: 3.8
+
.. data:: version
A string containing the version number of the Python interpreter plus additional