Skip to content
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

gh-101892: Fix SystemError when a callable iterator call exhausts the iterator #101896

Merged
merged 19 commits into from
Mar 4, 2023
Merged
Show file tree
Hide file tree
Changes from 11 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
17 changes: 17 additions & 0 deletions Lib/test/test_iter.py
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,23 @@ def spam(state=[0]):
return i
self.check_iterator(iter(spam, 20), list(range(10)), pickle=False)

# Test two-argument iter() with function that empties its associated
# iterator via list() (or anything else but next()) but returns
# a non-sentinel value thus claiming that the iterator can yield more.
def test_iter_function_concealing_reentrant_exhaustion(self):
HAS_MORE = 1
NO_MORE = 2
def spam():
if spam.need_reentrance:
spam.need_reentrance = False
list(spam.iterator) # Implicitly call ourselves
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This evening (after getting access to my dev machine) I'll check whether the inner list() is required to throw StopIteration to trigger the bug. If no, I will simplify the test:

Suggested change
list(spam.iterator) # Implicitly call ourselves
try:
list(spam.iterator) # Implicitly call ourselves.
except StopIteration:
pass

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got it wrong. list() cannot throw an exception because it returns a ready-to-use list (possibly empty) processing StopIteration by itself.

return HAS_MORE
return NO_MORE
spam.need_reentrance = True
spam.iterator = iter(spam, NO_MORE)
with self.assertRaises(StopIteration):
next(spam.iterator)

# Test exception propagation through function iterator
def test_exception_function(self):
def spam(state=[0]):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Callable iterators no longer raise :class:`SystemError` by exhausting themselves.
4 changes: 2 additions & 2 deletions Objects/iterobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -214,15 +214,14 @@ calliter_iternext(calliterobject *it)
}

result = _PyObject_CallNoArgs(it->it_callable);
if (result != NULL) {
if (result != NULL && it->it_sentinel != NULL){
int ok;

ok = PyObject_RichCompareBool(it->it_sentinel, result, Py_EQ);
if (ok == 0) {
return result; /* Common case, fast path */
}

Py_DECREF(result);
if (ok > 0) {
Py_CLEAR(it->it_callable);
Py_CLEAR(it->it_sentinel);
Expand All @@ -233,6 +232,7 @@ calliter_iternext(calliterobject *it)
Py_CLEAR(it->it_callable);
Py_CLEAR(it->it_sentinel);
}
Py_XDECREF(result);
return NULL;
}

Expand Down