Unverified Kaydet (Commit) 60da99b8 authored tarafından Xiang Zhang's avatar Xiang Zhang Kaydeden (comit) GitHub

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

Mention in the documentation of settrace and setprofile that errors in the
registered handlers will cause themselves unset.
üst 61d478c7
...@@ -1089,7 +1089,8 @@ always available. ...@@ -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. ...@@ -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'``
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment