mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-19 08:11:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.11] gh-102249: Expand sys.call_tracing documentation (GH-102806) (#111558)

Browse source 
Co-authored-by: Quentin Peter <impact27@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Miss Islington (bot) 2023-10-31 17:40:17 +01:00 • committed by GitHub
parent 650eb29b49
commit 2bb10acfdd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/sys.rst
View file

@ -173,7 +173,11 @@ always available.
Call ``func(*args)``, while tracing is enabled. The tracing state is saved, 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 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 .. data:: copyright
@ -1439,13 +1443,16 @@ always available.
its return value is not used, so it can simply return ``None``. Error in the profile its return value is not used, so it can simply return ``None``. Error in the profile
function will cause itself unset. 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 Profile functions should have three arguments: *frame*, *event*, and
*arg*. *frame* is the current stack frame. *event* is a string: ``'call'``, *arg*. *frame* is the current stack frame. *event* is a string: ``'call'``,
``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends ``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends
on the event type. on the event type.
.. audit-event:: sys.setprofile "" sys.setprofile
The events have the following meaning: The events have the following meaning:
``'call'`` ``'call'``
@ -1467,6 +1474,9 @@ always available.
``'c_exception'`` ``'c_exception'``
A C function has raised an exception. *arg* is the C function object. A C function has raised an exception. *arg* is the C function object.
.. audit-event:: sys.setprofile "" sys.setprofile
.. function:: setrecursionlimit(limit) .. function:: setrecursionlimit(limit)
Set the maximum depth of the Python interpreter stack to *limit*. This limit Set the maximum depth of the Python interpreter stack to *limit*. This limit
@ -1526,6 +1536,10 @@ always available.
If there is any error occurred in the trace function, it will be unset, just If there is any error occurred in the trace function, it will be unset, just
like ``settrace(None)`` is called. 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: The events have the following meaning:
``'call'`` ``'call'``