58

I mean what do I get from using async for. Here is the code I write with async for, AIter(10) could be replaced with get_range().

But the code runs like sync not async.

import asyncio

async def get_range():
    for i in range(10):
        print(f"start {i}")
        await asyncio.sleep(1)
        print(f"end {i}")
        yield i

class AIter:
    def __init__(self, N):
        self.i = 0
        self.N = N

    def __aiter__(self):
        return self

    async def __anext__(self):
        i = self.i
        print(f"start {i}")
        await asyncio.sleep(1)
        print(f"end {i}")
        if i >= self.N:
            raise StopAsyncIteration
        self.i += 1
        return i

async def main():
    async for p in AIter(10):
        print(f"finally {p}")

if __name__ == "__main__":
    asyncio.run(main())

The result I excepted should be :

start 1
start 2
start 3
...
end 1
end 2
...
finally 1
finally 2
...

However, the real result is:

start 0
end 0
finally 0
start 1
end 1
finally 1
start 2
end 2

I know I could get the excepted result by using asyncio.gather or asyncio.wait.

But it is hard for me to understand what I got by use async for here instead of simple for.

What is the right way to use async for if I want to loop over several Feature object and use them as soon as one is finished. For example:

async for f in feature_objects:
    data = await f
    with open("file", "w") as fi:
        fi.write()
PaleNeutron
  • 2,015
  • 3
  • 21
  • 40
  • @user4815162342, yes, thanks a lot. But I'm still looking for some example of `async source`. Can you add an example usage of `async for` syntax? – PaleNeutron Jun 03 '19 at 07:50
  • Any async generator can serve as an async source. For a more concrete example, see e.g. [this answer](https://stackoverflow.com/a/56280107/1600898) exposes a sequence of callback invocations as an async iterator which is iterable using `async for`. – user4815162342 Jun 03 '19 at 08:52
  • btw, you can try aiofiles to handle files in asyncio way – Tsonglew Dec 12 '19 at 09:18

1 Answers1

114

But it is hard for me to understand what I got by use async for here instead of simple for.

The underlying misunderstanding is expecting async for to automatically parallelize the iteration. It doesn't do that, it simply allows sequential iteration over an async source. For example, you can use async for to iterate over lines coming from a TCP stream, messages from a websocket, or database records from an async DB driver.

None of the above would work with an ordinary for, at least not without blocking the event loop. This is because for calls __next__ as a blocking function and doesn't await its result. You cannot manually await elements obtained by for because for expects __next__ to signal the end of iteration by raising StopIteration. If __next__ is a coroutine, the StopIteration exception won't be visible before awaiting it. This is why async for was introduced, not just in Python, but also in other languages with async/await and generalized for.

If you want to run the loop iterations in parallel, you need to start them as parallel coroutines and use asyncio.as_completed or equivalent to retrieve their results as they come:

async def x(i):
    print(f"start {i}")
    await asyncio.sleep(1)
    print(f"end {i}")
    return i

# run x(0)..x(10) concurrently and process results as they arrive
for f in asyncio.as_completed([x(i) for i in range(10)]):
    result = await f
    # ... do something with the result ...

If you don't care about reacting to results immediately as they arrive, but you need them all, you can make it even simpler by using asyncio.gather:

# run x(0)..x(10) concurrently and process results when all are done
results = await asyncio.gather(*[x(i) for i in range(10)])
Martin Meeser
  • 2,385
  • 2
  • 24
  • 38
user4815162342
  • 124,516
  • 15
  • 228
  • 298
  • 1
    Checking my understanding -- both of your code snippets (`for f in asyncio.as_completed...` and `results = await ...` would have to be executed within an async function/method, within a call chain kicked off by `asyncio.run(...)`, right? – hBy2Py Mar 10 '21 at 20:17
  • 1
    @hBy2Py Correct. The question (and therefore the answer too) just omits that part for brevity. – user4815162342 Mar 10 '21 at 21:36
  • 1
    I like the explainer, but am missing an example for the `async for` loop – Roelant Mar 21 '21 at 18:28
  • 1
    @Roelant You're right that an example would be useful. This answer tried to address the specific points raised in the question, which made sense at the time, but reduce its value as a general resource. Adding a real-life example at this point would make the answer quite a bit longer than it is now. Hopefully there are other SO questions that clarify the issue and, if not, maybe it's time for a new question. – user4815162342 Mar 21 '21 at 20:27