Updated README, docstrings.

Author: toddbirchard

README.md

@@ -1,4 +1,4 @@
-# Python Asyncio Tutorials
+# Python Asyncio Tutorial
 
 ![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)
@@ -21,7 +21,7 @@ https://hackersandslackers.com/python-concurrency-asyncio/
 
 ### Part II
 
-Make asynchronous HTTP requests and write to disk using **asyncio**, **aiohttp**, & **aiofiles**.
+Make asynchronous HTTP requests and write to disk using [**asyncio**](https://docs.python.org/3/library/asyncio.html), [**aiohttp**](https://docs.aiohttp.org/en/stable/), & [**aiofiles**](https://github.com/Tinche/aiofiles).
 
 https://hackersandslackers.com/async-requests-with-aiohttp/
 

asyncio_tutorial/logger.py

@@ -1,11 +1,8 @@
 """Custom logger."""
-from os import path
 from sys import stdout
 
 from loguru import logger as custom_logger
 
-from config import ENVIRONMENT
-
 
 def formatter(log: dict) -> str:
     """
@@ -49,14 +46,6 @@ def create_logger() -> custom_logger:
     """
     custom_logger.remove()
     custom_logger.add(stdout, colorize=True, format=formatter)
-    if ENVIRONMENT == "production":
-        # Datadog JSON logs
-        custom_logger.add(
-            "/var/log/asyncio_tutorial/info.json",
-            format=formatter,
-            rotation="500 MB",
-            compression="zip",
-        )
     return custom_logger
 
 

asyncio_tutorial/part_I_asyncio_intro/__init__.py

@@ -12,11 +12,11 @@
 async def asyncio_intro_tutorial():
     """Demo of an asynchronous script's lifecycle."""
     LOGGER.info(f"Asyncio tutorial Part I: Intro to Asyncio.")
-    tasks = []
+    task_list = []
     future = register_future()
     for i in range(3):
         task = await create_task(simple_coroutine(i, delay=1))
-        tasks.append(task)
+        task_list.append(task)
     inspect_event_loop()
-    await asyncio.gather(*tasks)
+    await asyncio.gather(*task_list)
     future.set_result("Done")

asyncio_tutorial/part_I_asyncio_intro/futures.py

@@ -1,4 +1,4 @@
-"""Future which executes an action when loop is completed."""
+"""Execute an action upon loop completion with Futures."""
 import asyncio
 from asyncio import Future
 

asyncio_tutorial/part_I_asyncio_intro/tasks.py

@@ -1,13 +1,14 @@
 """Create task from coroutine which displays a value after a delay."""
+from typing import Callable
 import asyncio
 from asyncio import Task
 
 
-async def create_task(coroutine) -> Task:
+async def create_task(coroutine: Callable) -> Task:
     """
     Create asyncio tasks to be executed.
 
-    :param coroutine: Coroutine to create async task from.
+    :param Callable coroutine: Coroutine to create async task from.
 
     :returns: Task
     """

config.py

@@ -17,7 +17,3 @@
     "accept": "*/*",
 }
 
-# Determine environment based on log folder
-ENVIRONMENT = "development"
-if path.isdir("/var/log/asyncio_tutorial"):
-    ENVIRONMENT = "production"

poetry.lock

@@ -11,7 +11,7 @@ chardet==4.0.0; python_version >= "3.6" and python_full_version < "3.0.0" or pyt
 colorama==0.4.4; python_version >= "3.5" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.5" and python_full_version >= "3.5.0"
 idna==3.2; python_version >= "3.6"
 loguru==0.5.3; python_version >= "3.5"
-multidict==5.1.0; python_version >= "3.6"
+multidict==5.2.0; python_version >= "3.6"
 pycares==4.0.0
 pycparser==2.20; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.4.0"
 typing-extensions==3.10.0.2; python_version >= "3.6"