diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-02-04 03:57:34 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-04 03:57:34 (GMT) |
| commit | dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d (patch) | |
| tree | e2eb332f8d414001b299d199604f481f2fcd3cff /Doc | |
| parent | 3139ea33ed84190e079d6ff4859baccdad778dae (diff) | |
| download | cpython-dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d.zip cpython-dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d.tar.gz cpython-dbdbc796d264b8d63c89c2ca3ea9634bbaee2d2d.tar.bz2 | |
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)
(cherry picked from commit cef9de62b8bf5e2d11d5a074012dfa81dc4ea935)
Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/faulthandler.rst | 10 | ||||
| -rw-r--r-- | Doc/library/pdb.rst | 9 | ||||
| -rw-r--r-- | Doc/library/traceback.rst | 9 |
3 files changed, 26 insertions, 2 deletions
diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst index be09123..b80de69 100644 --- a/Doc/library/faulthandler.rst +++ b/Doc/library/faulthandler.rst @@ -43,6 +43,13 @@ Python is deadlocked. The :ref:`Python Development Mode <devmode>` calls :func:`faulthandler.enable` at Python startup. +.. seealso:: + + Module :mod:`pdb` + Interactive source code debugger for Python programs. + + Module :mod:`traceback` + Standard interface to extract, format and print stack traces of Python programs. Dumping the traceback --------------------- @@ -52,6 +59,8 @@ Dumping the traceback Dump the tracebacks of all threads into *file*. If *all_threads* is ``False``, dump only the current thread. + .. seealso:: :func:`traceback.print_tb`, which can be used to print a traceback object. + .. versionchanged:: 3.5 Added support for passing file descriptor to this function. @@ -178,4 +187,3 @@ handler: File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at File "<stdin>", line 1 in <module> Segmentation fault - diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst index dcd509d..c87e327 100644 --- a/Doc/library/pdb.rst +++ b/Doc/library/pdb.rst @@ -27,6 +27,15 @@ The debugger is extensible -- it is actually defined as the class :class:`Pdb`. This is currently undocumented but easily understood by reading the source. The extension interface uses the modules :mod:`bdb` and :mod:`cmd`. +.. seealso:: + + Module :mod:`faulthandler` + Used to dump Python tracebacks explicitly, on a fault, after a timeout, + or on a user signal. + + Module :mod:`traceback` + Standard interface to extract, format and print stack traces of Python programs. + The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control of the debugger is:: diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index c93e7f4..ab51cb9 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -20,8 +20,15 @@ The module uses traceback objects --- this is the object type that is stored in the :data:`sys.last_traceback` variable and returned as the third item from :func:`sys.exc_info`. -The module defines the following functions: +.. seealso:: + + Module :mod:`faulthandler` + Used to dump Python tracebacks explicitly, on a fault, after a timeout, or on a user signal. + Module :mod:`pdb` + Interactive source code debugger for Python programs. + +The module defines the following functions: .. function:: print_tb(tb, limit=None, file=None) |