new repository

1 files changed, 113 insertions, 0 deletions

diff --git a/devdocs/python~3.12/library%2Fsys.monitoring.html b/devdocs/python~3.12/library%2Fsys.monitoring.html
new file mode 100644
index 00000000..3e1282f1
--- /dev/null
+++ b/devdocs/python~3.12/library%2Fsys.monitoring.html
@@ -0,0 +1,113 @@
+ <span id="sys-monitoring-execution-event-monitoring"></span><h1>sys.monitoring — Execution event monitoring</h1> <div class="versionadded"> <p><span class="versionmodified added">New in version 3.12.</span></p> </div>  <div class="admonition note"> <p class="admonition-title">Note</p> <p><a class="reference internal" href="#module-sys.monitoring" title="sys.monitoring: Access and control event monitoring"><code>sys.monitoring</code></a> is a namespace within the <a class="reference internal" href="sys#module-sys" title="sys: Access system-specific parameters and functions."><code>sys</code></a> module, not an independent module, so there is no need to <code>import sys.monitoring</code>, simply <code>import sys</code> and then use <code>sys.monitoring</code>.</p> </div> <p>This namespace provides access to the functions and constants necessary to activate and control event monitoring.</p> <p>As programs execute, events occur that might be of interest to tools that monitor execution. The <a class="reference internal" href="#module-sys.monitoring" title="sys.monitoring: Access and control event monitoring"><code>sys.monitoring</code></a> namespace provides means to receive callbacks when events of interest occur.</p> <p>The monitoring API consists of three components:</p> <ul class="simple"> <li><a class="reference internal" href="#tool-identifiers">Tool identifiers</a></li> <li><a class="reference internal" href="#events">Events</a></li> <li><a class="reference internal" href="#callbacks"><span class="std std-ref">Callbacks</span></a></li> </ul> <section id="tool-identifiers"> <h2>Tool identifiers</h2> <p>A tool identifier is an integer and the associated name. Tool identifiers are used to discourage tools from interfering with each other and to allow multiple tools to operate at the same time. Currently tools are completely independent and cannot be used to monitor each other. This restriction may be lifted in the future.</p> <p>Before registering or activating events, a tool should choose an identifier. Identifiers are integers in the range 0 to 5 inclusive.</p> <section id="registering-and-using-tools"> <h3>Registering and using tools</h3> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.use_tool_id">
+<code>sys.monitoring.use_tool_id(tool_id: int, name: str, /) → None</code> </dt> <dd>
+<p>Must be called before <em>tool_id</em> can be used. <em>tool_id</em> must be in the range 0 to 5 inclusive. Raises a <a class="reference internal" href="exceptions#ValueError" title="ValueError"><code>ValueError</code></a> if <em>tool_id</em> is in use.</p> </dd>
+</dl> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.free_tool_id">
+<code>sys.monitoring.free_tool_id(tool_id: int, /) → None</code> </dt> <dd>
+<p>Should be called once a tool no longer requires <em>tool_id</em>.</p> </dd>
+</dl> <div class="admonition note"> <p class="admonition-title">Note</p> <p><a class="reference internal" href="#sys.monitoring.free_tool_id" title="sys.monitoring.free_tool_id"><code>free_tool_id()</code></a> will not disable global or local events associated with <em>tool_id</em>, nor will it unregister any callback functions. This function is only intended to be used to notify the VM that the particular <em>tool_id</em> is no longer in use.</p> </div> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.get_tool">
+<code>sys.monitoring.get_tool(tool_id: int, /) → str | None</code> </dt> <dd>
+<p>Returns the name of the tool if <em>tool_id</em> is in use, otherwise it returns <code>None</code>. <em>tool_id</em> must be in the range 0 to 5 inclusive.</p> </dd>
+</dl> <p>All IDs are treated the same by the VM with regard to events, but the following IDs are pre-defined to make co-operation of tools easier:</p> <pre data-language="python">sys.monitoring.DEBUGGER_ID = 0
+sys.monitoring.COVERAGE_ID = 1
+sys.monitoring.PROFILER_ID = 2
+sys.monitoring.OPTIMIZER_ID = 5
+</pre> <p>There is no obligation to set an ID, nor is there anything preventing a tool from using an ID even it is already in use. However, tools are encouraged to use a unique ID and respect other tools.</p> </section> </section> <section id="events"> <h2>Events</h2> <p>The following events are supported:</p> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-BRANCH">
+<code>sys.monitoring.events.BRANCH</code> </dt> <dd>
+<p>A conditional branch is taken (or not).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-CALL">
+<code>sys.monitoring.events.CALL</code> </dt> <dd>
+<p>A call in Python code (event occurs before the call).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-C_RAISE">
+<code>sys.monitoring.events.C_RAISE</code> </dt> <dd>
+<p>An exception raised from any callable, except for Python functions (event occurs after the exit).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-C_RETURN">
+<code>sys.monitoring.events.C_RETURN</code> </dt> <dd>
+<p>Return from any callable, except for Python functions (event occurs after the return).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-EXCEPTION_HANDLED">
+<code>sys.monitoring.events.EXCEPTION_HANDLED</code> </dt> <dd>
+<p>An exception is handled.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-INSTRUCTION">
+<code>sys.monitoring.events.INSTRUCTION</code> </dt> <dd>
+<p>A VM instruction is about to be executed.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-JUMP">
+<code>sys.monitoring.events.JUMP</code> </dt> <dd>
+<p>An unconditional jump in the control flow graph is made.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-LINE">
+<code>sys.monitoring.events.LINE</code> </dt> <dd>
+<p>An instruction is about to be executed that has a different line number from the preceding instruction.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_RESUME">
+<code>sys.monitoring.events.PY_RESUME</code> </dt> <dd>
+<p>Resumption of a Python function (for generator and coroutine functions), except for <code>throw()</code> calls.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_RETURN">
+<code>sys.monitoring.events.PY_RETURN</code> </dt> <dd>
+<p>Return from a Python function (occurs immediately before the return, the callee’s frame will be on the stack).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_START">
+<code>sys.monitoring.events.PY_START</code> </dt> <dd>
+<p>Start of a Python function (occurs immediately after the call, the callee’s frame will be on the stack)</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_THROW">
+<code>sys.monitoring.events.PY_THROW</code> </dt> <dd>
+<p>A Python function is resumed by a <code>throw()</code> call.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_UNWIND">
+<code>sys.monitoring.events.PY_UNWIND</code> </dt> <dd>
+<p>Exit from a Python function during exception unwinding.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-PY_YIELD">
+<code>sys.monitoring.events.PY_YIELD</code> </dt> <dd>
+<p>Yield from a Python function (occurs immediately before the yield, the callee’s frame will be on the stack).</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-RAISE">
+<code>sys.monitoring.events.RAISE</code> </dt> <dd>
+<p>An exception is raised, except those that cause a <a class="reference internal" href="#monitoring-event-STOP_ITERATION"><code>STOP_ITERATION</code></a> event.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-RERAISE">
+<code>sys.monitoring.events.RERAISE</code> </dt> <dd>
+<p>An exception is re-raised, for example at the end of a <a class="reference internal" href="../reference/compound_stmts#finally"><code>finally</code></a> block.</p> </dd>
+</dl> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-STOP_ITERATION">
+<code>sys.monitoring.events.STOP_ITERATION</code> </dt> <dd>
+<p>An artificial <a class="reference internal" href="exceptions#StopIteration" title="StopIteration"><code>StopIteration</code></a> is raised; see <a class="reference internal" href="#the-stop-iteration-event">the STOP_ITERATION event</a>.</p> </dd>
+</dl> <p>More events may be added in the future.</p> <p>These events are attributes of the <code>sys.monitoring.events</code> namespace. Each event is represented as a power-of-2 integer constant. To define a set of events, simply bitwise or the individual events together. For example, to specify both <a class="reference internal" href="#monitoring-event-PY_RETURN"><code>PY_RETURN</code></a> and <a class="reference internal" href="#monitoring-event-PY_START"><code>PY_START</code></a> events, use the expression <code>PY_RETURN | PY_START</code>.</p> <dl class="std monitoring-event"> <dt class="sig sig-object std" id="monitoring-event-NO_EVENTS">
+<code>sys.monitoring.events.NO_EVENTS</code> </dt> <dd>
+<p>An alias for <code>0</code> so users can do explict comparisions like:</p> <pre data-language="python">if get_events(DEBUGGER_ID) == NO_EVENTS:
+    ...
+</pre> </dd>
+</dl> <p>Events are divided into three groups:</p> <section id="local-events"> <h3>Local events</h3> <p>Local events are associated with normal execution of the program and happen at clearly defined locations. All local events can be disabled. The local events are:</p> <ul class="simple"> <li><a class="reference internal" href="#monitoring-event-PY_START"><code>PY_START</code></a></li> <li><a class="reference internal" href="#monitoring-event-PY_RESUME"><code>PY_RESUME</code></a></li> <li><a class="reference internal" href="#monitoring-event-PY_RETURN"><code>PY_RETURN</code></a></li> <li><a class="reference internal" href="#monitoring-event-PY_YIELD"><code>PY_YIELD</code></a></li> <li><a class="reference internal" href="#monitoring-event-CALL"><code>CALL</code></a></li> <li><a class="reference internal" href="#monitoring-event-LINE"><code>LINE</code></a></li> <li><a class="reference internal" href="#monitoring-event-INSTRUCTION"><code>INSTRUCTION</code></a></li> <li><a class="reference internal" href="#monitoring-event-JUMP"><code>JUMP</code></a></li> <li><a class="reference internal" href="#monitoring-event-BRANCH"><code>BRANCH</code></a></li> <li><a class="reference internal" href="#monitoring-event-STOP_ITERATION"><code>STOP_ITERATION</code></a></li> </ul> </section> <section id="ancillary-events"> <h3>Ancillary events</h3> <p>Ancillary events can be monitored like other events, but are controlled by another event:</p> <ul class="simple"> <li><a class="reference internal" href="#monitoring-event-C_RAISE"><code>C_RAISE</code></a></li> <li><a class="reference internal" href="#monitoring-event-C_RETURN"><code>C_RETURN</code></a></li> </ul> <p>The <a class="reference internal" href="#monitoring-event-C_RETURN"><code>C_RETURN</code></a> and <a class="reference internal" href="#monitoring-event-C_RAISE"><code>C_RAISE</code></a> events are controlled by the <a class="reference internal" href="#monitoring-event-CALL"><code>CALL</code></a> event. <a class="reference internal" href="#monitoring-event-C_RETURN"><code>C_RETURN</code></a> and <a class="reference internal" href="#monitoring-event-C_RAISE"><code>C_RAISE</code></a> events will only be seen if the corresponding <a class="reference internal" href="#monitoring-event-CALL"><code>CALL</code></a> event is being monitored.</p> </section> <section id="other-events"> <h3>Other events</h3> <p>Other events are not necessarily tied to a specific location in the program and cannot be individually disabled.</p> <p>The other events that can be monitored are:</p> <ul class="simple"> <li><a class="reference internal" href="#monitoring-event-PY_THROW"><code>PY_THROW</code></a></li> <li><a class="reference internal" href="#monitoring-event-PY_UNWIND"><code>PY_UNWIND</code></a></li> <li><a class="reference internal" href="#monitoring-event-RAISE"><code>RAISE</code></a></li> <li><a class="reference internal" href="#monitoring-event-EXCEPTION_HANDLED"><code>EXCEPTION_HANDLED</code></a></li> </ul> </section> <section id="the-stop-iteration-event"> <h3>The STOP_ITERATION event</h3> <p><span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0380/#use-of-stopiteration-to-return-values"><strong>PEP 380</strong></a> specifies that a <a class="reference internal" href="exceptions#StopIteration" title="StopIteration"><code>StopIteration</code></a> exception is raised when returning a value from a generator or coroutine. However, this is a very inefficient way to return a value, so some Python implementations, notably CPython 3.12+, do not raise an exception unless it would be visible to other code.</p> <p>To allow tools to monitor for real exceptions without slowing down generators and coroutines, the <a class="reference internal" href="#monitoring-event-STOP_ITERATION"><code>STOP_ITERATION</code></a> event is provided. <a class="reference internal" href="#monitoring-event-STOP_ITERATION"><code>STOP_ITERATION</code></a> can be locally disabled, unlike <a class="reference internal" href="#monitoring-event-RAISE"><code>RAISE</code></a>.</p> </section> </section> <section id="turning-events-on-and-off"> <h2>Turning events on and off</h2> <p>In order to monitor an event, it must be turned on and a corresponding callback must be registered. Events can be turned on or off by setting the events either globally or for a particular code object.</p> <section id="setting-events-globally"> <h3>Setting events globally</h3> <p>Events can be controlled globally by modifying the set of events being monitored.</p> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.get_events">
+<code>sys.monitoring.get_events(tool_id: int, /) → int</code> </dt> <dd>
+<p>Returns the <code>int</code> representing all the active events.</p> </dd>
+</dl> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.set_events">
+<code>sys.monitoring.set_events(tool_id: int, event_set: int, /) → None</code> </dt> <dd>
+<p>Activates all events which are set in <em>event_set</em>. Raises a <a class="reference internal" href="exceptions#ValueError" title="ValueError"><code>ValueError</code></a> if <em>tool_id</em> is not in use.</p> </dd>
+</dl> <p>No events are active by default.</p> </section> <section id="per-code-object-events"> <h3>Per code object events</h3> <p>Events can also be controlled on a per code object basis.</p> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.get_local_events">
+<code>sys.monitoring.get_local_events(tool_id: int, code: CodeType, /) → int</code> </dt> <dd>
+<p>Returns all the local events for <em>code</em></p> </dd>
+</dl> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.set_local_events">
+<code>sys.monitoring.set_local_events(tool_id: int, code: CodeType, event_set: int, /) → None</code> </dt> <dd>
+<p>Activates all the local events for <em>code</em> which are set in <em>event_set</em>. Raises a <a class="reference internal" href="exceptions#ValueError" title="ValueError"><code>ValueError</code></a> if <em>tool_id</em> is not in use.</p> </dd>
+</dl> <p>Local events add to global events, but do not mask them. In other words, all global events will trigger for a code object, regardless of the local events.</p> </section> <section id="disabling-events"> <h3>Disabling events</h3> <dl class="py data"> <dt class="sig sig-object py" id="sys.monitoring.DISABLE">
+<code>sys.monitoring.DISABLE</code> </dt> <dd>
+<p>A special value that can be returned from a callback function to disable events for the current code location.</p> </dd>
+</dl> <p>Local events can be disabled for a specific code location by returning <a class="reference internal" href="#sys.monitoring.DISABLE" title="sys.monitoring.DISABLE"><code>sys.monitoring.DISABLE</code></a> from a callback function. This does not change which events are set, or any other code locations for the same event.</p> <p>Disabling events for specific locations is very important for high performance monitoring. For example, a program can be run under a debugger with no overhead if the debugger disables all monitoring except for a few breakpoints.</p> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.restart_events">
+<code>sys.monitoring.restart_events() → None</code> </dt> <dd>
+<p>Enable all the events that were disabled by <a class="reference internal" href="#sys.monitoring.DISABLE" title="sys.monitoring.DISABLE"><code>sys.monitoring.DISABLE</code></a> for all tools.</p> </dd>
+</dl> </section> </section> <section id="registering-callback-functions"> <span id="callbacks"></span><h2>Registering callback functions</h2> <p>To register a callable for events call</p> <dl class="py function"> <dt class="sig sig-object py" id="sys.monitoring.register_callback">
+<code>sys.monitoring.register_callback(tool_id: int, event: int, func: Callable | None, /) → Callable | None</code> </dt> <dd>
+<p>Registers the callable <em>func</em> for the <em>event</em> with the given <em>tool_id</em></p> <p>If another callback was registered for the given <em>tool_id</em> and <em>event</em>, it is unregistered and returned. Otherwise <a class="reference internal" href="#sys.monitoring.register_callback" title="sys.monitoring.register_callback"><code>register_callback()</code></a> returns <code>None</code>.</p> </dd>
+</dl> <p>Functions can be unregistered by calling <code>sys.monitoring.register_callback(tool_id, event, None)</code>.</p> <p>Callback functions can be registered and unregistered at any time.</p> <p>Registering or unregistering a callback function will generate a <a class="reference internal" href="sys#sys.audit" title="sys.audit"><code>sys.audit()</code></a> event.</p> <section id="callback-function-arguments"> <h3>Callback function arguments</h3> <dl class="py data"> <dt class="sig sig-object py" id="sys.monitoring.MISSING">
+<code>sys.monitoring.MISSING</code> </dt> <dd>
+<p>A special value that is passed to a callback function to indicate that there are no arguments to the call.</p> </dd>
+</dl> <p>When an active event occurs, the registered callback function is called. Different events will provide the callback function with different arguments, as follows:</p> <ul> <li>
+<p><a class="reference internal" href="#monitoring-event-PY_START"><code>PY_START</code></a> and <a class="reference internal" href="#monitoring-event-PY_RESUME"><code>PY_RESUME</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int) -&gt; DISABLE | Any
+</pre> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-PY_RETURN"><code>PY_RETURN</code></a> and <a class="reference internal" href="#monitoring-event-PY_YIELD"><code>PY_YIELD</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int, retval: object) -&gt; DISABLE | Any
+</pre> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-CALL"><code>CALL</code></a>, <a class="reference internal" href="#monitoring-event-C_RAISE"><code>C_RAISE</code></a> and <a class="reference internal" href="#monitoring-event-C_RETURN"><code>C_RETURN</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int, callable: object, arg0: object | MISSING) -&gt; DISABLE | Any
+</pre> <p>If there are no arguments, <em>arg0</em> is set to <a class="reference internal" href="#sys.monitoring.MISSING" title="sys.monitoring.MISSING"><code>sys.monitoring.MISSING</code></a>.</p> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-RAISE"><code>RAISE</code></a>, <a class="reference internal" href="#monitoring-event-RERAISE"><code>RERAISE</code></a>, <a class="reference internal" href="#monitoring-event-EXCEPTION_HANDLED"><code>EXCEPTION_HANDLED</code></a>, <a class="reference internal" href="#monitoring-event-PY_UNWIND"><code>PY_UNWIND</code></a>, <a class="reference internal" href="#monitoring-event-PY_THROW"><code>PY_THROW</code></a> and <a class="reference internal" href="#monitoring-event-STOP_ITERATION"><code>STOP_ITERATION</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int, exception: BaseException) -&gt; DISABLE | Any
+</pre> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-LINE"><code>LINE</code></a>:</p> <pre data-language="python">func(code: CodeType, line_number: int) -&gt; DISABLE | Any
+</pre> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-BRANCH"><code>BRANCH</code></a> and <a class="reference internal" href="#monitoring-event-JUMP"><code>JUMP</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int, destination_offset: int) -&gt; DISABLE | Any
+</pre> <p>Note that the <em>destination_offset</em> is where the code will next execute. For an untaken branch this will be the offset of the instruction following the branch.</p> </li> <li>
+<p><a class="reference internal" href="#monitoring-event-INSTRUCTION"><code>INSTRUCTION</code></a>:</p> <pre data-language="python">func(code: CodeType, instruction_offset: int) -&gt; DISABLE | Any
+</pre> </li> </ul> </section> </section> <div class="_attribution">
+  <p class="_attribution-p">
+    &copy; 2001&ndash;2023 Python Software Foundation<br>Licensed under the PSF License.<br>
+    <a href="https://docs.python.org/3.12/library/sys.monitoring.html" class="_attribution-link">https://docs.python.org/3.12/library/sys.monitoring.html</a>
+  </p>
+</div>