mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

bpo-32532: Improve documentation of settrace and setprofile (#5359)

Browse source 
Mention in the documentation of settrace and setprofile that errors in the
registered handlers will cause themselves unset.
This commit is contained in:
Xiang Zhang 2018-01-27 23:04:47 +08:00 • committed by GitHub
parent 61d478c71c
commit 60da99b8e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/sys.rst
View file

@ -1089,7 +1089,8 @@ always available.
but the return event is reported even when an exception has been set). The function is but the return event is reported even when an exception has been set). The function is
thread-specific, but there is no way for the profiler to know about context switches between thread-specific, but there is no way for the profiler to know about context switches between
threads, so it does not make sense to use this in the presence of multiple threads. Also, threads, so it does not make sense to use this in the presence of multiple threads. Also,
its return value is not used, so it can simply return ``None``. its return value is not used, so it can simply return ``None``. Error in the profile
function will cause itself unset.
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'``,
@ -1173,6 +1174,9 @@ always available.
function for further tracing in that scope), or ``None`` to turn off tracing function for further tracing in that scope), or ``None`` to turn off tracing
in that scope. in that scope.
If there is any error occurred in the trace function, it will be unset, just
like ``settrace(None)`` is called.
The events have the following meaning: The events have the following meaning:
``'call'`` ``'call'``