Merge pull request #82 from realpython/understanding-async-python

Updating code to use Geir's codetiming module rather than my homegrow…

Author: writeson

understanding-asynchronous-programming/example_1.py

@@ -18,10 +18,10 @@ def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = queue.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for work in [15, 10, 5, 2]:
         work_queue.put(work)
 

understanding-asynchronous-programming/example_2.py

@@ -16,10 +16,10 @@ def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = queue.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for work in [15, 10, 5, 2]:
         work_queue.put(work)
 

understanding-asynchronous-programming/example_3.py

@@ -1,44 +1,43 @@
 import time
 import queue
-from lib.elapsed_time import ET
+from codetiming import Timer
 
 
 def task(name, queue):
+    timer = Timer(text=f"Task {name} elapsed time: {{:.1f}}")
     while not queue.empty():
         delay = queue.get()
-        et = ET()
         print(f"Task {name} running")
+        timer.start()
         time.sleep(delay)
-        print(f"Task {name} total elapsed time: {et():.1f}")
+        timer.stop()
         yield
 
 
 def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = queue.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for work in [15, 10, 5, 2]:
         work_queue.put(work)
 
     tasks = [task("One", work_queue), task("Two", work_queue)]
 
     # Run the tasks
-    et = ET()
     done = False
-    while not done:
-        for t in tasks:
-            try:
-                next(t)
-            except StopIteration:
-                tasks.remove(t)
-            if len(tasks) == 0:
-                done = True
-
-    print(f"\nTotal elapsed time: {et():.1f}")
+    with Timer(text="\nTotal elapsed time: {:.1f}"):
+        while not done:
+            for t in tasks:
+                try:
+                    next(t)
+                except StopIteration:
+                    tasks.remove(t)
+                if len(tasks) == 0:
+                    done = True
 
 
 if __name__ == "__main__":

understanding-asynchronous-programming/example_4.py

@@ -1,34 +1,34 @@
 import asyncio
-from lib.elapsed_time import ET
+from codetiming import Timer
 
 
 async def task(name, work_queue):
+    timer = Timer(text=f"Task {name} elapsed time: {{:.1f}}")
     while not work_queue.empty():
         delay = await work_queue.get()
-        et = ET()
         print(f"Task {name} running")
+        timer.start()
         await asyncio.sleep(delay)
-        print(f"Task {name} total elapsed time: {et():.1f}")
+        timer.stop()
 
 
 async def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = asyncio.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for work in [15, 10, 5, 2]:
         await work_queue.put(work)
 
     # Run the tasks
-    et = ET()
-    await asyncio.gather(
-        asyncio.create_task(task("One", work_queue)),
-        asyncio.create_task(task("Two", work_queue)),
-    )
-    print(f"\nTotal elapsed time: {et():.1f}")
+    with Timer(text="\nTotal elapsed time: {:.1f}"):
+        await asyncio.gather(
+            asyncio.create_task(task("One", work_queue)),
+            asyncio.create_task(task("Two", work_queue)),
+        )
 
 
 if __name__ == "__main__":

understanding-asynchronous-programming/example_5.py

@@ -1,27 +1,28 @@
 import queue
 import requests
-from lib.elapsed_time import ET
+from codetiming import Timer
 
 
 def task(name, work_queue):
+    timer = Timer(text=f"Task {name} elapsed time: {{:.1f}}")
     with requests.Session() as session:
         while not work_queue.empty():
             url = work_queue.get()
             print(f"Task {name} getting URL: {url}")
-            et = ET()
+            timer.start()
             session.get(url)
-            print(f"Task {name} total elapsed time: {et():.1f}")
+            timer.stop()
             yield
 
 
 def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = queue.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for url in [
         "http://google.com",
         "http://yahoo.com",
@@ -36,18 +37,16 @@ def main():
     tasks = [task("One", work_queue), task("Two", work_queue)]
 
     # Run the tasks
-    et = ET()
     done = False
-    while not done:
-        for t in tasks:
-            try:
-                next(t)
-            except StopIteration:
-                tasks.remove(t)
-            if len(tasks) == 0:
-                done = True
-
-    print(f"\nTotal elapsed time: {et():.1f}")
+    with Timer(text="\nTotal elapsed time: {:.1f}"):
+        while not done:
+            for t in tasks:
+                try:
+                    next(t)
+                except StopIteration:
+                    tasks.remove(t)
+                if len(tasks) == 0:
+                    done = True
 
 
 if __name__ == "__main__":

understanding-asynchronous-programming/example_6.py

@@ -1,27 +1,28 @@
 import asyncio
 import aiohttp
-from lib.elapsed_time import ET
+from codetiming import Timer
 
 
 async def task(name, work_queue):
+    timer = Timer(text=f"Task {name} elapsed time: {{:.1f}}")
     async with aiohttp.ClientSession() as session:
         while not work_queue.empty():
             url = await work_queue.get()
             print(f"Task {name} getting URL: {url}")
-            et = ET()
+            timer.start()
             async with session.get(url) as response:
                 await response.text()
-            print(f"Task {name} total elapsed time: {et():.1f}")
+            timer.stop()
 
 
 async def main():
     """
     This is the main entry point for the program
     """
-    # Create the queue of 'work'
+    # Create the queue of work
     work_queue = asyncio.Queue()
 
-    # Put some 'work' in the queue
+    # Put some work in the queue
     for url in [
         "http://google.com",
         "http://yahoo.com",
@@ -34,12 +35,11 @@ async def main():
         await work_queue.put(url)
 
     # Run the tasks
-    et = ET()
-    await asyncio.gather(
-        asyncio.create_task(task("One", work_queue)),
-        asyncio.create_task(task("Two", work_queue)),
-    )
-    print(f"\nTotal elapsed time: {et():.1f}")
+    with Timer(text="\nTotal elapsed time: {:.1f}"):
+        await asyncio.gather(
+            asyncio.create_task(task("One", work_queue)),
+            asyncio.create_task(task("Two", work_queue)),
+        )
 
 
 if __name__ == "__main__":

understanding-asynchronous-programming/lib/__init__.py

@@ -3,6 +3,7 @@ async-timeout==3.0.1
 attrs==19.1.0
 certifi==2019.3.9
 chardet==3.0.4
+codetiming==0.1.2
 idna==2.8
 multidict==4.5.2
 requests==2.21.0