Skip to content

Commit

Permalink
Docs: Add restart_events() and positional arg semantics for `sys.mo…
Browse files Browse the repository at this point in the history
…nitoring` (python#111291)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
2 people authored and aisk committed Feb 11, 2024
1 parent 36997b1 commit 0e8e5ec
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions Doc/library/sys.monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,17 @@ Identifiers are integers in the range 0 to 5 inclusive.
Registering and using tools
'''''''''''''''''''''''''''

.. function:: use_tool_id(tool_id: int, name: str) -> None
.. function:: use_tool_id(tool_id: int, name: str, /) -> None

Must be called before *tool_id* can be used.
*tool_id* must be in the range 0 to 5 inclusive.
Raises a :exc:`ValueError` if *tool_id* is in use.

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

Should be called once a tool no longer requires *tool_id*.

.. function:: get_tool(tool_id: int) -> str | None
.. function:: get_tool(tool_id: int, /) -> str | None

Returns the name of the tool if *tool_id* is in use,
otherwise it returns ``None``.
Expand Down Expand Up @@ -237,11 +237,11 @@ Setting events globally

Events can be controlled globally by modifying the set of events being monitored.

.. function:: get_events(tool_id: int) -> int
.. function:: get_events(tool_id: int, /) -> int

Returns the ``int`` representing all the active events.

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

Activates all events which are set in *event_set*.
Raises a :exc:`ValueError` if *tool_id* is not in use.
Expand All @@ -253,11 +253,11 @@ Per code object events

Events can also be controlled on a per code object basis.

.. function:: get_local_events(tool_id: int, code: CodeType) -> int
.. function:: get_local_events(tool_id: int, code: CodeType, /) -> int

Returns all the local events for *code*

.. function:: set_local_events(tool_id: int, code: CodeType, event_set: int)
.. function:: set_local_events(tool_id: int, code: CodeType, event_set: int, /) -> None

Activates all the local events for *code* which are set in *event_set*.
Raises a :exc:`ValueError` if *tool_id* is not in use.
Expand All @@ -284,6 +284,11 @@ 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.

.. function:: restart_events() -> None

Enable all the events that were disabled by :data:`sys.monitoring.DISABLE`
for all tools.


.. _callbacks:

Expand All @@ -292,7 +297,7 @@ Registering callback functions

To register a callable for events call

.. function:: register_callback(tool_id: int, event: int, func: Callable | None) -> Callable | None
.. function:: register_callback(tool_id: int, event: int, func: Callable | None, /) -> Callable | None

Registers the callable *func* for the *event* with the given *tool_id*

Expand Down

0 comments on commit 0e8e5ec

Please sign in to comment.