Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Doc/library/sys.monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,17 @@ Registering and using tools

Unregister all events and callback functions associated with *tool_id*.

.. audit-event:: sys.monitoring.clear_tool_id tool_id sys.monitoring.clear_tool_id

.. versionadded:: 3.14

.. function:: free_tool_id(tool_id: int, /) -> None

Should be called once a tool no longer requires *tool_id*.
Will call :func:`clear_tool_id` before releasing *tool_id*.

.. audit-event:: sys.monitoring.free_tool_id tool_id sys.monitoring.free_tool_id

.. versionchanged:: 3.14
Now calls :func:`clear_tool_id` before releasing *tool_id*.
Previously, it would not disable global or local events associated
Expand Down
13 changes: 13 additions & 0 deletions Lib/test/audit-tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -648,6 +648,19 @@ def hook(event, args):
sys.monitoring.register_callback(1, 1, None)


def test_sys_monitoring_clear_free_tool_id():
import sys

def hook(event, args):
if event.startswith("sys.monitoring"):
print(event, args)

sys.addaudithook(hook)
sys.monitoring.use_tool_id(1, "test")
sys.monitoring.clear_tool_id(1)
sys.monitoring.free_tool_id(1)


def test_winapi_createnamedpipe(pipe_name):
import _winapi

Expand Down
15 changes: 15 additions & 0 deletions Lib/test/test_audit.py
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,21 @@ def test_sys_monitoring_register_callback(self):

self.assertEqual(actual, expected)

def test_sys_monitoring_clear_free_tool_id(self):
returncode, events, stderr = self.run_python("test_sys_monitoring_clear_free_tool_id")
if returncode:
self.fail(stderr)

if support.verbose:
print(*events, sep='\n')
actual = [(ev[0], ev[2]) for ev in events]
expected = [
("sys.monitoring.clear_tool_id", "(1,)"),
("sys.monitoring.free_tool_id", "(1,)"),
]

self.assertEqual(actual, expected)

def test_winapi_createnamedpipe(self):
winapi = import_helper.import_module("_winapi")

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Emit audit events when ``sys.monitoring`` tool IDs are cleared or freed.
9 changes: 9 additions & 0 deletions Python/instrumentation.c
Original file line number Diff line number Diff line change
Expand Up @@ -2226,6 +2226,10 @@ monitoring_clear_tool_id_impl(PyObject *module, int tool_id)
return NULL;
}

if (PySys_Audit("sys.monitoring.clear_tool_id", "i", tool_id) < 0) {
return NULL;
}

PyInterpreterState *interp = _PyInterpreterState_GET();

if (interp->monitoring_tool_names[tool_id] != NULL) {
Expand All @@ -2252,6 +2256,11 @@ monitoring_free_tool_id_impl(PyObject *module, int tool_id)
if (check_valid_tool(tool_id)) {
return NULL;
}

if (PySys_Audit("sys.monitoring.free_tool_id", "i", tool_id) < 0) {
return NULL;
}

PyInterpreterState *interp = _PyInterpreterState_GET();

if (interp->monitoring_tool_names[tool_id] != NULL) {
Expand Down
Loading