8000 GH-116090: Fix test and clarify behavior for exception events when exhausting a generator. by markshannon · Pull Request #120697 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

8000 GH-116090: Fix test and clarify behavior for exception events when exhausting a generator. #120697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 26, 2024
Merged
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 @@ -226,6 +226,10 @@ To allow tools to monitor for real exceptions without slowing down generators
and coroutines, the :monitoring-event:`STOP_ITERATION` event is provided.
:monitoring-event:`STOP_ITERATION` can be locally disabled, unlike :monitoring-event:`RAISE`.

Note that the :monitoring-event:`STOP_ITERATION` event and the :monitoring-event:`RAISE`
event for a :exc:`StopIteration` exception are equivalent, and are treated as interchangeable
when generating events. Implementations will favor :monitoring-event:`STOP_ITERATION` for
performance reasons, but may generate a :monitoring-event:`RAISE` event with a :exc:`StopIteration`.

Turning events on and off
-------------------------
Expand Down
35 changes: 29 additions & 6 deletions Lib/test/test_monitoring.py
Original file line number Diff line number Diff line change
Expand Up @@ -832,20 +832,43 @@ def func1():

self.check_events(func1, [("raise", KeyError)])

# gh-116090: This test doesn't really require specialization, but running
# it without specialization exposes a monitoring bug.
@requires_specialization
def test_implicit_stop_iteration(self):
"""Generators are documented as raising a StopIteration
when they terminate.
However, we don't do that if we can avoid it, for speed.
sys.monitoring handles that by injecting a STOP_ITERATION
event when we would otherwise have skip the RAISE event.
This test checks that both paths record an equivalent event.
"""

def gen():
yield 1
return 2

def implicit_stop_iteration():
for _ in gen():
def implicit_stop_iteration(iterator=None):
if iterator is None:
iterator = gen()
for _ in iterator:
pass

self.check_events(implicit_stop_iteration, [("raise", StopIteration)], recorders=(StopiterationRecorder,))
recorders=(ExceptionRecorder, StopiterationRecorder,)
expected = [("raise", StopIteration)]

# Make sure that the loop is unspecialized, and that it will not
# re-specialize immediately, so that we can we can test the
# unspecialized version of the loop first.
# Note: this assumes that we don't specialize loops over sets.
implicit_stop_iteration(set(range(100)))

# This will record a RAISE event for the StopIteration.
self.check_events(implicit_stop_iteration, expected, recorders=recorders)

# Now specialize, so that we see a STOP_ITERATION event.
for _ in range(100):
implicit_stop_iteration()

# This will record a STOP_ITERATION event for the StopIteration.
self.check_events(implicit_stop_iteration, expected, recorders=recorders)

initial = [
("raise", ZeroDivisionError),
Expand Down
Loading
0