Expand scope of repo to include all H&N Asyncio tutorials.

Author: toddbirchard

README.md

@@ -1,4 +1,4 @@
-# Asyncio Tutorial
+# Asyncio Tutorials
 
 ![Python](https://img.shields.io/badge/Python-v^3.9-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)
 ![Asyncio](https://img.shields.io/badge/Asyncio-v^3.4.3-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
@@ -9,10 +9,20 @@
 [![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/asyncio-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-blueprint-tutorial/stargazers)
 [![GitHub Forks](https://img.shields.io/github/forks/hackersandslackers/asyncio-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-blueprint-tutorial/network)
 
+
+Source code demonstrating asynchronous Python for the corresponding Hackersandslackers posts.
+
+### Part I
+
+Introduction to asynchronous Python with Asyncio.
+
+https://hackersandslackers.com/python-concurrency-asyncio/
+
+### Part II
+
 Make asynchronous HTTP requests and write to disk using **asyncio**, **aiohttp**, & **aiofiles**.
 
-* **Tutorial**: https://hackersandslackers.com/async-requests-with-aiohttp/
-* **Demo**: TBD
+https://hackersandslackers.com/async-requests-with-aiohttp/
 
 
 # Getting Started

asyncio_tutorial/__init__.py

@@ -1,35 +1,12 @@
-"""Script initialization."""
+"""Demonstrate Parts 1 and 2 of Hackersandslackers Asyncio tutorial series"""
 import asyncio
 
-from aiohttp import ClientSession
-
 from asyncio_tutorial.logger import LOGGER
-from asyncio_tutorial.tasks import create_tasks
-from config import EXPORT_DIR, HTML_HEADERS
-from data import parse_urls
-
-from .logger import LOGGER
-
-
-async def init_script():
-    """Open async HTTP session & execute created tasks."""
-    urls = parse_urls()
-    async with ClientSession(headers=HTML_HEADERS) as session:
-        tasks = await create_tasks(session, urls, EXPORT_DIR)
-        await asyncio.gather(*tasks)
-        await inspect_loop()
-        LOGGER.success(
-            f"Saved {len(urls)} files to `{EXPORT_DIR}`"
-        )
-
 
-async def inspect_loop() -> str:
-    """
-    Get event loop info.
+from .part_I_asyncio_intro import intro_tutorial
+from .part_II_aiohttp_aiofiles import aiohttp_aiofiles_tutorial
 
-    :param: List[Task] tasks
 
-    :return: str
-    """
-    loop = asyncio.get_event_loop()
-    return LOGGER.info(f"Loop finished in {loop.time()} seconds.")
+def init_script():
+    asyncio.run(intro_tutorial())
+    asyncio.run(aiohttp_aiofiles_tutorial())

asyncio_tutorial/part_II_aiohttp_aiofiles/__init__.py

@@ -0,0 +1,33 @@
+"""Script initialization."""
+import asyncio
+
+from aiohttp import ClientSession
+
+from asyncio_tutorial.logger import LOGGER
+from config import EXPORT_DIR, HTML_HEADERS
+from data import parse_urls
+
+from .tasks import create_tasks
+
+
+async def aiohttp_aiofiles_tutorial():
+    """Open async HTTP session & execute created tasks."""
+    LOGGER.info(f"Asyncio tutorial Part II: HTTP Requests with Aiohttp & Aiofiles.")
+    urls = parse_urls()
+    async with ClientSession(headers=HTML_HEADERS) as session:
+        tasks = await create_tasks(session, urls, EXPORT_DIR)
+        await asyncio.gather(*tasks)
+        await inspect_loop()
+        LOGGER.success(f"Saved {len(urls)} files to `{EXPORT_DIR}`")
+
+
+async def inspect_loop() -> str:
+    """
+    Get event loop info.
+
+    :param: List[Task] tasks
+
+    :return: str
+    """
+    loop = asyncio.get_event_loop()
+    return LOGGER.info(f"Loop finished in {loop.time()} seconds.")

asyncio_tutorial/fetcher.py …rial/part_II_aiohttp_aiofiles/fetcher.pyasyncio_tutorial/fetcher.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/fetcher.py asyncio_tutorial/fetcher.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/fetcher.py

@@ -2,7 +2,8 @@
 from aiohttp import ClientError, ClientSession, InvalidURL
 
 from asyncio_tutorial.logger import LOGGER
-from asyncio_tutorial.writer import write_file
+
+from .writer import write_file
 
 
 async def fetch_and_save_url(

asyncio_tutorial/tasks.py …torial/part_II_aiohttp_aiofiles/tasks.pyasyncio_tutorial/tasks.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/tasks.py asyncio_tutorial/tasks.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/tasks.py

@@ -1,7 +1,7 @@
 """Write to disk asynchronously."""
 import aiofiles
 
-from .logger import LOGGER
+from asyncio_tutorial.logger import LOGGER
 
 
 async def write_file(url: str, body: bytes, filetype: str, directory: str):

asyncio_tutorial/writer.py …orial/part_II_aiohttp_aiofiles/writer.pyasyncio_tutorial/writer.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/writer.py asyncio_tutorial/writer.py renamed to asyncio_tutorial/part_II_aiohttp_aiofiles/writer.py

@@ -0,0 +1,19 @@
+"""Simple script to create and execute tasks in a loop"""
+import asyncio
+
+from asyncio_tutorial.logger import LOGGER
+
+from .coroutines import simple_coroutine
+from .tasks import create_task
+
+
+async def intro_tutorial():
+    """Simple demonstration of a async script lifecycle"""
+    LOGGER.info(f"Asyncio tutorial Part I: Intro to Asyncio.")
+    tasks = []
+    for i in range(3):
+        task = await create_task(simple_coroutine(i, delay=1))
+        tasks.append(task)
+        LOGGER.info(type(task))
+    await asyncio.gather(*tasks)
+    LOGGER.info("-------------------------------------------")

asyncio_tutorial/part_I_asyncio_intro/__init__.py

@@ -0,0 +1,15 @@
+"""Create a coroutine containing the business logic of our task."""
+import asyncio
+
+from asyncio_tutorial.logger import LOGGER
+
+
+async def simple_coroutine(number: int, delay=1):
+    """
+    Wait for a period of time before logging the coro number.
+
+    :param int number: Number to identify the current coroutine.
+    :param int delay: Time delay to simulate a function which takes time to complete.
+    """
+    await asyncio.sleep(delay)
+    LOGGER.info(f"This is Coroutine {number} being executed.")

asyncio_tutorial/part_I_asyncio_intro/coroutines.py

@@ -0,0 +1,17 @@
+"""Create task from provided coroutine."""
+import asyncio
+from asyncio import Task
+
+from asyncio_tutorial.logger import LOGGER
+
+
+async def create_task(coroutine) -> Task:
+    """
+    Create asyncio tasks to be executed.
+
+    :param coroutine: Coroutine to create async task from.
+
+    :returns: Task
+    """
+    LOGGER.info(type(coroutine))
+    return asyncio.create_task(coroutine)

asyncio_tutorial/part_I_asyncio_intro/tasks.py

@@ -1,7 +1,5 @@
 """Script entry point."""
-import asyncio
-
 from asyncio_tutorial import init_script
 
 if __name__ == "__main__":
-    asyncio.run(init_script())
+    init_script()