gh-136697: Use the standard audit event format for sys.monitoring docs (#136747)
Some checks are pending
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (push) Blocked by required conditions
Tests / Check if generated files are up to date (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Windows MSI (push) Blocked by required conditions
Tests / Ubuntu SSL tests with OpenSSL (push) Blocked by required conditions
Tests / Ubuntu SSL tests with AWS-LC (push) Blocked by required conditions
Tests / WASI (push) Blocked by required conditions
Tests / Hypothesis tests on Ubuntu (push) Blocked by required conditions
Tests / Address sanitizer (push) Blocked by required conditions
Tests / Undefined behavior sanitizer (push) Blocked by required conditions
Tests / Cross build Linux (push) Blocked by required conditions
Tests / CIFuzz (push) Blocked by required conditions
Tests / All required checks pass (push) Blocked by required conditions
Lint / lint (push) Waiting to run
mypy / Run mypy on Lib/_pyrepl (push) Waiting to run
mypy / Run mypy on Lib/test/libregrtest (push) Waiting to run
mypy / Run mypy on Lib/tomllib (push) Waiting to run
mypy / Run mypy on Tools/build (push) Waiting to run
mypy / Run mypy on Tools/cases_generator (push) Waiting to run
mypy / Run mypy on Tools/clinic (push) Waiting to run
mypy / Run mypy on Tools/jit (push) Waiting to run
mypy / Run mypy on Tools/peg_generator (push) Waiting to run

This commit is contained in:
Tian Gao 2025-07-17 11:10:10 -07:00 committed by GitHub
parent eddc8c0a1d
commit 28937d3a21
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -333,6 +333,8 @@ Registering callback functions
it is unregistered and returned.
Otherwise :func:`register_callback` returns ``None``.
.. audit-event:: sys.monitoring.register_callback func sys.monitoring.register_callback
Functions can be unregistered by calling
``sys.monitoring.register_callback(tool_id, event, None)``.
@ -343,8 +345,6 @@ globally and locally. As such, if an event could be turned on for both global
and local events by your code then the callback needs to be written to handle
either trigger.
Registering or unregistering a callback function will generate a :func:`sys.audit` event.
Callback function arguments
'''''''''''''''''''''''''''