Skip to content
Closed
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
6 changes: 6 additions & 0 deletions Doc/library/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,14 @@ are always available. They are listed here in alphabetical order.
iterator. If *default* is given, it is returned if the iterator is exhausted,
otherwise :exc:`StopAsyncIteration` is raised.

The awaitable returned by :func:`anext` exposes the generator it drives as a
read-only ``ag_gen`` attribute if *async_iterator* is an asynchronous generator.

.. versionadded:: 3.10

.. versionadded:: 3.16
The ``ag_gen`` attribute.

.. function:: any(iterable, /)

Return ``True`` if any element of the *iterable* is true. If the iterable
Expand Down
8 changes: 8 additions & 0 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1238,6 +1238,14 @@ the underlying generator function:
that does nothing.


The awaitables returned by :meth:`~agen.asend`, :meth:`~agen.athrow` and
:meth:`~agen.aclose` expose the generator they drive as a read-only
``ag_gen`` attribute.

.. versionadded:: 3.16
The ``ag_gen`` attribute.


.. _typesseq:

Sequence Types --- :class:`list`, :class:`tuple`, :class:`range`
Expand Down
3 changes: 3 additions & 0 deletions Lib/asyncio/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ def _build_graph_for_future(
# A native async generator or duck-type compatible iterator
st.append(FrameCallGraphEntry(coro.ag_frame))
coro = coro.ag_await
elif hasattr(coro, 'ag_gen'):
# gh-156980, gh-157032: An asend()/athrow()/anext() awaitable: step over it to its generator
coro = coro.ag_gen
else:
break

Expand Down
44 changes: 44 additions & 0 deletions Lib/test/test_asyncgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,50 @@ async def gen():
r"cannot reuse already awaited __anext__\(\)/asend\(\)"):
an.send(None)

def test_async_gen_asend_athrow_ag_gen(self):
# gh-156980: asend()/athrow() awaitables expose the generator they drive
async def gen():
yield 1

g = gen()
asend = g.asend(None)
athrow = g.athrow(ValueError)
try:
self.assertIs(asend.ag_gen, g)
self.assertIs(athrow.ag_gen, g)
with self.assertRaises(AttributeError):
asend.ag_gen = None
finally:
asend.close()
athrow.close()

def test_async_gen_anext_default_ag_gen(self):
# gh-157032: anext(agen, default) awaitables expose the generator they drive
async def gen():
yield 1

g = gen()
an = anext(g, None)
try:
self.assertIs(an.ag_gen, g)
with self.assertRaises(AttributeError):
an.ag_gen = None
finally:
an.close()

# Non-generator async iterator should not have ag_gen
class CustomAsyncIter:
async def __anext__(self):
return 1

c = CustomAsyncIter()
an_custom = anext(c, None)
try:
with self.assertRaises(AttributeError):
_ = an_custom.ag_gen
finally:
an_custom.close()

def test_async_gen_asend_throw_concurrent_with_send(self):
import types

Expand Down
104 changes: 104 additions & 0 deletions Lib/test/test_asyncio/test_graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,110 @@ class FakeCoro:

self.assertEqual(len(result.call_stack), 2)

async def test_stack_async_gen_asend(self):
# gh-156980: an async_generator_asend must not truncate the stack
fut = asyncio.Future()
stack_for_consumer = None

async def deep():
await fut

async def gen():
await deep()
yield 1

async def consumer():
async for _ in gen():
pass

async def main():
nonlocal stack_for_consumer

async with asyncio.TaskGroup() as g:
t = g.create_task(consumer(), name='consumer')
for _ in range(5):
await asyncio.sleep(0)

stack_for_consumer = capture_test_stack(fut=t)
fut.set_result(None)

await main()

self.assertEqual(stack_for_consumer[0][:2], [
'T<consumer>',
['a deep', 'ag gen', 'a consumer'],
])

async def test_stack_async_gen_aclose(self):
# gh-156980: an async_generator_athrow must not truncate the stack
fut = asyncio.Future()
stack_for_consumer = None

async def deep():
await fut

async def gen():
try:
yield 1
finally:
await deep()

async def consumer():
agen = gen()
await anext(agen)
await agen.aclose()

async def main():
nonlocal stack_for_consumer

async with asyncio.TaskGroup() as g:
t = g.create_task(consumer(), name='consumer')
for _ in range(5):
await asyncio.sleep(0)

stack_for_consumer = capture_test_stack(fut=t)
fut.set_result(None)

await main()

self.assertEqual(stack_for_consumer[0][:2], [
'T<consumer>',
['a deep', 'ag gen', 'a consumer'],
])

async def test_stack_async_gen_anext_default(self):
# gh-157032: an anext(agen, default) awaitable must not truncate the stack
fut = asyncio.Future()
stack_for_consumer = None

async def deep():
await fut

async def gen():
await deep()
yield 1

async def consumer():
await anext(gen(), None)

async def main():
nonlocal stack_for_consumer

async with asyncio.TaskGroup() as g:
t = g.create_task(consumer(), name='consumer')
for _ in range(5):
await asyncio.sleep(0)

stack_for_consumer = capture_test_stack(fut=t)
fut.set_result(None)

await main()

self.assertEqual(stack_for_consumer[0][:2], [
'T<consumer>',
['a deep', 'ag gen', 'a consumer'],
])

async def test_stack_gather(self):

stack_for_deep = None
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:func:`asyncio.print_call_graph` no longer truncates the call stack of a
task suspended inside an asynchronous generator.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:func:`asyncio.print_call_graph` no longer loses the call stack of a task
waiting on :func:`anext` with a default value. The awaitable returned by
``anext(agen, default)`` now exposes the underlying generator as ``ag_gen``.
14 changes: 12 additions & 2 deletions Objects/genobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -2171,6 +2171,11 @@ async_gen_asend_finalize(PyObject *self)
}
}

static PyMemberDef async_gen_asend_memberlist[] = {
{"ag_gen", Py_T_OBJECT_EX, offsetof(PyAsyncGenASend, ags_gen), Py_READONLY},
{NULL} /* Sentinel */
};

static PyMethodDef async_gen_asend_methods[] = {
{"send", async_gen_asend_send, METH_O, send_doc},
{"throw", _PyCFunction_CAST(async_gen_asend_throw), METH_FASTCALL, throw_doc},
Expand Down Expand Up @@ -2215,7 +2220,7 @@ PyTypeObject _PyAsyncGenASend_Type = {
PyObject_SelfIter, /* tp_iter */
async_gen_asend_iternext, /* tp_iternext */
async_gen_asend_methods, /* tp_methods */
0, /* tp_members */
async_gen_asend_memberlist, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
Expand Down Expand Up @@ -2634,6 +2639,11 @@ async_gen_athrow_finalize(PyObject *op)
}
}

static PyMemberDef async_gen_athrow_memberlist[] = {
{"ag_gen", Py_T_OBJECT_EX, offsetof(PyAsyncGenAThrow, agt_gen), Py_READONLY},
{NULL} /* Sentinel */
};

static PyMethodDef async_gen_athrow_methods[] = {
{"send", async_gen_athrow_send, METH_O, send_doc},
{"throw", _PyCFunction_CAST(async_gen_athrow_throw),
Expand Down Expand Up @@ -2681,7 +2691,7 @@ PyTypeObject _PyAsyncGenAThrow_Type = {
PyObject_SelfIter, /* tp_iter */
async_gen_athrow_iternext, /* tp_iternext */
async_gen_athrow_methods, /* tp_methods */
0, /* tp_members */
async_gen_athrow_memberlist, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
Expand Down
15 changes: 15 additions & 0 deletions Objects/iterobject.c
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,19 @@ static PyMethodDef anextawaitable_methods[] = {
};


static PyObject *
anextawaitable_getag_gen(PyObject *op, void *Py_UNUSED(ignored))
{
anextawaitableobject *obj = anextawaitableobject_CAST(op);
return PyObject_GetAttrString(obj->wrapped, "ag_gen");
}

static PyGetSetDef anextawaitable_getsetlist[] = {
{"ag_gen", anextawaitable_getag_gen, NULL, NULL},
{NULL} /* Sentinel */
};


static PyAsyncMethods anextawaitable_as_async = {
PyObject_SelfIter, /* am_await */
0, /* am_aiter */
Expand Down Expand Up @@ -619,6 +632,8 @@ PyTypeObject _PyAnextAwaitable_Type = {
PyObject_SelfIter, /* tp_iter */
anextawaitable_iternext, /* tp_iternext */
anextawaitable_methods, /* tp_methods */
0, /* tp_members */
anextawaitable_getsetlist, /* tp_getset */
};

PyObject *
Expand Down
Loading