https://github.com/python/cpython/commit/f815f740381dcf797d8aa67b9a0eabf4869bc790 commit: f815f740381dcf797d8aa67b9a0eabf4869bc790 branch: main author: Christian Neumüller <[email protected]> committer: nedbat <[email protected]> date: 2026-09-14T06:51:59-04:00 summary:
gh-116750: Document 3.14 changes around sys.monitoring.clear_tool_id (#156706) gh-116750: Document versionadded/versionchanged for sys.monitoring tool_id functions clear_tool_id() was added in 3.14 but lacked a versionadded note, and free_tool_id()'s behavior change (now calling clear_tool_id() before releasing the tool_id, rather than leaving events/callbacks registered) was undocumented. Also add a What's New in 3.14 entry for both. Co-authored-by: Ned Batchelder <[email protected]> files: M Doc/library/sys.monitoring.rst M Doc/whatsnew/3.14.rst diff --git a/Doc/library/sys.monitoring.rst b/Doc/library/sys.monitoring.rst index 7cca6f2bcdae91..0a653506b3d495 100644 --- a/Doc/library/sys.monitoring.rst +++ b/Doc/library/sys.monitoring.rst @@ -54,11 +54,18 @@ Registering and using tools Unregister all events and callback functions associated with *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*. + .. versionchanged:: 3.14 + Now calls :func:`clear_tool_id` before releasing *tool_id*. + Previously, it would not disable global or local events associated + with *tool_id*, nor unregister any callback functions. + .. function:: get_tool(tool_id: int, /) -> str | None Returns the name of the tool if *tool_id* is in use, diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst index 6e3e6331a1b7e8..565bc563a8b41f 100644 --- a/Doc/whatsnew/3.14.rst +++ b/Doc/whatsnew/3.14.rst @@ -1906,6 +1906,12 @@ sys.monitoring These replace and deprecate the :monitoring-event:`!BRANCH` event. (Contributed by Mark Shannon in :gh:`122548`.) +* Add :func:`sys.monitoring.clear_tool_id` to unregister all events and + callback functions associated with a tool identifier. + :func:`sys.monitoring.free_tool_id` now calls it before releasing the + tool identifier, instead of leaving its events and callbacks registered. + (Contributed by Tian Gao in :gh:`116750`.) + sysconfig --------- _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3//lists/python-checkins.python.org Member address: [email protected]
