How to use ‘yield’ inside async function?

by

Upd:

Starting with Python 3.6 we have asynchronous generators and able to use yield directly inside coroutines.

import asyncio


async def async_generator():
    for i in range(3):
        await asyncio.sleep(1)
        yield i*i


async def main():
    async for i in async_generator():
        print(i)


loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(main())
finally:
    loop.run_until_complete(loop.shutdown_asyncgens())  # see: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.shutdown_asyncgens
    loop.close()

Old answer for Python 3.5:

You can’t yield inside coroutines. Only way is to implement Asynchronous Iterator manually using __aiter__/__anext__ magic methods. In your case:

import asyncio


class async_generator:
    def __init__(self, stop):
        self.i = 0
        self.stop = stop

    async def __aiter__(self):
        return self

    async def __anext__(self):
        i = self.i
        self.i += 1
        if self.i <= self.stop:
            await asyncio.sleep(1)
            return i * i
        else:
            raise StopAsyncIteration


async def main():
    async for i in async_generator(3):
        print(i)


if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Output:

0
1
4

Here’re two more examples: 1, 2

More Related Contents:

  1. When to use and when not to use Python 3.5 `await` ?
  2. “Fire and forget” python async/await
  3. How can I periodically execute a function with asyncio?
  4. How to use asyncio with existing blocking library?
  5. “Asyncio Event Loop is Closed” when getting loop
  6. Does asyncio supports asynchronous I/O for file operations?
  7. asyncio.ensure_future vs. BaseEventLoop.create_task vs. simple coroutine?
  8. How does asyncio actually work?
  9. Resetting generator object in Python
  10. Python 3.7 – asyncio.sleep() and time.sleep()
  11. Return and yield in the same function
  12. RuntimeError: This event loop is already running in python
  13. Python type hinting without cyclic imports
  14. Python simple socket client/server using asyncio
  15. Sharing python objects across multiple workers
  16. Learning asyncio: “coroutine was never awaited” warning error
  17. Process finished with exit code 139 (interrupted by signal 11: SIGSEGV)
  18. What does “SSLError: [SSL] PEM lib (_ssl.c:2532)” mean using the Python ssl library?
  19. asyncio.sleep() vs time.sleep() in Python
  20. Mocking async call in python 3.5
  21. multiprocessing vs multithreading vs asyncio
  22. Why am I getting “invalid syntax” from an f-string? [duplicate]
  23. Use asyncio and Tkinter (or another GUI lib) together without freezing the GUI
  24. How to set Python3.5.2 as default Python version on CentOS?
  25. typing.Any vs object?
  26. Make a Python asyncio call from a Flask route
  27. Create generator that yields coroutine results as the coroutines finish
  28. Is it possible to run only a single step of the asyncio event loop
  29. Handling Timeouts with asyncio
  30. How to combine Celery with asyncio?

Leave a Comment