mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 05:35:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (#101157)

Browse source 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Furkan Onder 2023-02-04 03:49:29 +00:00 • committed by GitHub
parent f11a3d1ebe
commit cef9de62b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 26 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/library/faulthandler.rst
View file

@ -43,6 +43,13 @@ Python is deadlocked.
The :ref:`Python Development Mode <devmode>` calls :func:`faulthandler.enable` The :ref:`Python Development Mode <devmode>` calls :func:`faulthandler.enable`
at Python startup. 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 Dumping the traceback
--------------------- ---------------------
@ -52,6 +59,8 @@ Dumping the traceback
Dump the tracebacks of all threads into *file*. If *all_threads* is Dump the tracebacks of all threads into *file*. If *all_threads* is
``False``, dump only the current thread. ``False``, dump only the current thread.
.. seealso:: :func:`traceback.print_tb`, which can be used to print a traceback object.
.. versionchanged:: 3.5 .. versionchanged:: 3.5
Added support for passing file descriptor to this function. 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 "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
File "<stdin>", line 1 in <module> File "<stdin>", line 1 in <module>
Segmentation fault Segmentation fault

9
Doc/library/pdb.rst
View file

@ -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 This is currently undocumented but easily understood by reading the source. The
extension interface uses the modules :mod:`bdb` and :mod:`cmd`. 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 The debugger's prompt is ``(Pdb)``. Typical usage to run a program under control
of the debugger is:: of the debugger is::

9
Doc/library/traceback.rst
View file

@ -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 the :data:`sys.last_traceback` variable and returned as the third item from
:func:`sys.exc_info`. :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) .. function:: print_tb(tb, limit=None, file=None)