50

When I go to the asyncio page, the first example is a hello world program. When I run it on python 3.73, I can't see any different from the normal one, can anyone tell me the difference and give a non-trivial example?

In [1]: import asyncio
   ...:
   ...: async def main():
   ...:     print('Hello ...')
   ...:     await asyncio.sleep(5)
   ...:     print('... World!')
   ...:
   ...: # Python 3.7+
   ...: asyncio.run(main())
Hello ...
... World!

In [2]:

In [2]: import time
   ...:
   ...: def main():
   ...:     print('Hello ...')
   ...:     time.sleep(5)
   ...:     print('... World!')
   ...:
   ...: # Python 3.7+
   ...: main()
Hello ...
... World!

I intentionally increase the time from 1s to 5s, hope to see something special but I didn't.

Nimeshka Srimal
  • 5,544
  • 4
  • 36
  • 49
an offer can't refuse
  • 2,814
  • 3
  • 22
  • 40

1 Answers1

85

You aren't seeing anything special because there's nothing much asynchronous work in your code. However, the main difference is that time.sleep(5) is blocking, and asyncio.sleep(5) is non-blocking.

When time.sleep(5) is called, it will block the entire execution of the script and it will be put on hold, just frozen, doing nothing. But when you call await asyncio.sleep(5), it will ask the event loop to run something else while your await statement finishes its execution.

Here's an improved example.

import asyncio

async def hello():
    print('Hello ...')
    await asyncio.sleep(5)
    print('... World!')

async def main():
    await asyncio.gather(hello(), hello())

asyncio.run(main())

Will output:

~$ python3.7 async.py
Hello ...
Hello ...
... World!
... World!

You can see that await asyncio.sleep(5) is not blocking the execution of the script.

Hope it helps :)

Nimeshka Srimal
  • 5,544
  • 4
  • 36
  • 49
  • 14
    some explanation from me which helped me to understand sync vs. async sleep - if you need pause an entire script (supposed to work concurrently) execution, it is sleep. If you need to pause single coroutine, it is asyncio.sleep – Vladimir Kolenov Jun 24 '19 at 06:38
  • 11
    Correction: You wrote "When time.sleep(5) is called, it will block the entire execution of the script ". This is true only for single threaded script. But for the general case this is incorrect. time.sleep(5) blocks only the current thread. – eyalzba Feb 06 '20 at 10:38
  • 1
    @eyalzba yeah, it makes sense. Thank you for adding this comment :) – Nimeshka Srimal Feb 06 '20 at 10:43
  • 5
    This should be the official "hello world" example. – C S Jul 05 '20 at 04:56
  • 1
    Thanks to stackoverflow.com and programmers like you, so many "holes" in standard PY documentation are covered. (One couldn't dig this out from https://docs.python.org/3/library/asyncio.html!) – Apostolos May 27 '21 at 15:05