diff options
| author | Irit Katriel <1055913+iritkatriel@users.noreply.github.com> | 2024-05-21 20:42:51 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-21 20:42:51 (GMT) |
| commit | 6e9863d7a3516cc76d6ce13923b15620499f3855 (patch) | |
| tree | 06894f78bbed5cb71c0180e1f9355939a622d7a4 /Doc | |
| parent | b64182550f73e556344bd754d32e3be5d22a74e1 (diff) | |
| download | cpython-6e9863d7a3516cc76d6ce13923b15620499f3855.zip cpython-6e9863d7a3516cc76d6ce13923b15620499f3855.tar.gz cpython-6e9863d7a3516cc76d6ce13923b15620499f3855.tar.bz2 | |
gh-118692: Avoid creating unnecessary StopIteration instances for monitoring (#119216)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/c-api/monitoring.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst index 763ec8e..ec743b9 100644 --- a/Doc/c-api/monitoring.rst +++ b/Doc/c-api/monitoring.rst @@ -121,10 +121,10 @@ See :mod:`sys.monitoring` for descriptions of the events. :c:func:`PyErr_GetRaisedException`). -.. c:function:: int PyMonitoring_FireStopIterationEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset) +.. c:function:: int PyMonitoring_FireStopIterationEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *value) - Fire a ``STOP_ITERATION`` event with the current exception (as returned by - :c:func:`PyErr_GetRaisedException`). + Fire a ``STOP_ITERATION`` event. If ``value`` is an instance of :exc:`StopIteration`, it is used. Otherwise, + a new :exc:`StopIteration` instance is created with ``value`` as its argument. Managing the Monitoring State |