summaryrefslogtreecommitdiffstats
path: root/Doc/library/sys.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-18 12:17:12 (GMT)
committerGitHub <noreply@github.com>2023-08-18 12:17:12 (GMT)
commitaf6e5fa718535b4ccbfa47f382584878aaa69bc2 (patch)
treeac4908362f10bd694763f262a4ab6384c303ef90 /Doc/library/sys.rst
parent2b8e0207cb91c5377ea82638d038e737070c64bb (diff)
downloadcpython-af6e5fa718535b4ccbfa47f382584878aaa69bc2.zip
cpython-af6e5fa718535b4ccbfa47f382584878aaa69bc2.tar.gz
cpython-af6e5fa718535b4ccbfa47f382584878aaa69bc2.tar.bz2
[3.12] Docs: emphasise warning and add accurate markups for sys.unraisablehook (GH-108105) (#108109)
Docs: emphasise warning and add accurate markups for sys.unraisablehook (GH-108105) (cherry picked from commit cc58ec9724772a8d5c4a5c9a6525f9f96e994227) Co-authored-by: Erlend E. Aasland <erlend@python.org>
Diffstat (limited to 'Doc/library/sys.rst')
-rw-r--r--Doc/library/sys.rst38
1 files changed, 21 insertions, 17 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 33391d1..b6346ba 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -1811,35 +1811,39 @@ always available.
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``.
- * *err_msg*: Error message, can be ``None``.
- * *object*: Object causing the exception, can be ``None``.
+ * :attr:`!exc_type`: Exception type.
+ * :attr:`!exc_value`: Exception value, can be ``None``.
+ * :attr:`!exc_traceback`: Exception traceback, can be ``None``.
+ * :attr:`!err_msg`: Error message, can be ``None``.
+ * :attr:`!object`: Object causing the exception, can be ``None``.
- The default hook formats *err_msg* and *object* as:
+ The default hook formats :attr:`!err_msg` and :attr:`!object` as:
``f'{err_msg}: {object!r}'``; use "Exception ignored in" error message
- if *err_msg* is ``None``.
+ if :attr:`!err_msg` is ``None``.
:func:`sys.unraisablehook` can be overridden to control how unraisable
exceptions are handled.
- Storing *exc_value* using a custom hook can create a reference cycle. It
- should be cleared explicitly to break the reference cycle when the
- exception is no longer needed.
+ .. seealso::
+
+ :func:`excepthook` which handles uncaught exceptions.
+
+ .. warning::
- Storing *object* using a custom hook can resurrect it if it is set to an
- object which is being finalized. Avoid storing *object* after the custom
- hook completes to avoid resurrecting objects.
+ Storing :attr:`!exc_value` using a custom hook can create a reference cycle.
+ It should be cleared explicitly to break the reference cycle when the
+ exception is no longer needed.
- See also :func:`excepthook` which handles uncaught exceptions.
+ Storing :attr:`!object` using a custom hook can resurrect it if it is set to an
+ object which is being finalized. Avoid storing :attr:`!object` after the custom
+ hook completes to avoid resurrecting objects.
.. audit-event:: sys.unraisablehook hook,unraisable sys.unraisablehook
Raise an auditing event ``sys.unraisablehook`` with arguments
- ``hook``, ``unraisable`` when an exception that cannot be handled occurs.
- The ``unraisable`` object is the same as what will be passed to the hook.
- If no hook has been set, ``hook`` may be ``None``.
+ *hook*, *unraisable* when an exception that cannot be handled occurs.
+ The *unraisable* object is the same as what will be passed to the hook.
+ If no hook has been set, *hook* may be ``None``.
.. versionadded:: 3.8