languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-03 00:29:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

gh-102249: Expand sys.call_tracing documentation (#102806)

Browse source 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Quentin Peter 2023-10-31 17:24:54 +01:00 committed by GitHub
parent 5cc6c80a77
commit 2445673983
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/sys.rst
View file

@ -175,7 +175,11 @@ always available.
Call ``func(*args)``, while tracing is enabled. The tracing state is saved,
and restored afterwards. This is intended to be called from a debugger from
a checkpoint, to recursively debug some other code.
a checkpoint, to recursively debug or profile some other code.
Tracing is suspended while calling a tracing function set by
:func:`settrace` or :func:`setprofile` to avoid infinite recursion.
:func:`!call_tracing` enables explicit recursion of the tracing function.
.. data:: copyright
@ -1473,13 +1477,16 @@ always available.
its return value is not used, so it can simply return ``None``. Error in the profile
function will cause itself unset.
.. note::
The same tracing mechanism is used for :func:`!setprofile` as :func:`settrace`.
To trace calls with :func:`!setprofile` inside a tracing function
(e.g. in a debugger breakpoint), see :func:`call_tracing`.
Profile functions should have three arguments: *frame*, *event*, and
*arg*. *frame* is the current stack frame. *event* is a string: ``'call'``,
``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends
on the event type.
.. audit-event:: sys.setprofile "" sys.setprofile
The events have the following meaning:
``'call'``
@ -1501,6 +1508,9 @@ always available.
``'c_exception'``
A C function has raised an exception. *arg* is the C function object.
.. audit-event:: sys.setprofile "" sys.setprofile
.. function:: setrecursionlimit(limit)
Set the maximum depth of the Python interpreter stack to *limit*. This limit
@ -1560,6 +1570,10 @@ always available.
If there is any error occurred in the trace function, it will be unset, just
like ``settrace(None)`` is called.
.. note::
Tracing is disabled while calling the trace function (e.g. a function set by
:func:`!settrace`). For recursive tracing see :func:`call_tracing`.
The events have the following meaning:
``'call'``