Clean up docstrings.

Author: toddbirchard

Makefile

@@ -12,6 +12,7 @@ make update     - Update pip dependencies via Poetry and export output to requir
 make format     - Format code with Python's `Black` library.
 make lint       - Check code formatting with `flake8`.
 make clean      - Remove cached files and lock files.
+
 endef
 export HELP
 
@@ -80,8 +81,9 @@ clean:
 	find . -name '*.log' -delete
 	find . -name '.DS_Store' -delete
 	find . -wholename 'logs/*.json' -delete
-	find . -wholename '.pytest_cache' -delete
+	find . -wholename './.pytest_cache' -delete
+	find . -wholename './.venv' -delete
 	find . -wholename '**/.pytest_cache' -delete
 	find . -wholename './logs/*.json' -delete
 	find . -wholename './logs' -delete
-	find . -wholename '*.html' -delete
+	find . -wholename './export/*.csv' -delete

README.md

@@ -2,8 +2,8 @@
 
 ![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)
-![Aiohttp](https://img.shields.io/badge/Aiohttp-v^3.7.4-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
-![Aiofiles](https://img.shields.io/badge/Aiofiles-v0.7.0-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Aiohttp](https://img.shields.io/badge/Aiohttp-v^3.8.1-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
+![Aiofiles](https://img.shields.io/badge/Aiofiles-v^0.8.0-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)
 ![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c&logo=GitHub)
 [![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/asyncio-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/flask-blueprint-tutorial/issues)
 [![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)

aiohttp_aiofiles_tutorial/__init__.py

@@ -6,7 +6,7 @@
 import aiofiles
 from aiofiles.threadpool.text import AsyncTextIOWrapper
 from aiohttp import ClientSession
-from config import FETCHED_URL_TITLES, HTML_HEADERS
+from config import EXPORT_FILE, HTML_HEADERS
 from logger import LOGGER
 
 from .data import urls
@@ -17,20 +17,20 @@
 async def init_script():
     """Initiate script by preparing an output file prior to executing tasks."""
     start_time = timer()
-    async with aiofiles.open(FETCHED_URL_TITLES, mode="w+") as output_file:
-        await output_file.write("title,url,\n")
-        await create_and_execute_tasks(output_file)
-        await output_file.close()
+    async with aiofiles.open(EXPORT_FILE, mode="w+") as outfile:
+        await outfile.write("title,url,\n")
+        await create_and_execute_tasks(outfile)
+        await outfile.close()
     LOGGER.success(f"Executed {__name__} in {time.perf_counter() - start_time:0.2f} seconds.")
 
 
-async def create_and_execute_tasks(output_file: AsyncTextIOWrapper):
+async def create_and_execute_tasks(outfile: AsyncTextIOWrapper):
     """
     Open async HTTP session & execute created tasks.
 
-    :param AsyncTextIOWrapper output_file: Filepath to local .json file to write output to.
+    :param AsyncTextIOWrapper outfile: Filepath of local .csv file to write to.
     """
     async with ClientSession(headers=HTML_HEADERS) as session:
-        task_list = await create_tasks(session, urls, output_file)
+        task_list = await create_tasks(session, urls, outfile)
         inspect_event_loop()
         await asyncio.gather(*task_list)

aiohttp_aiofiles_tutorial/data/parser.py

@@ -1,4 +1,4 @@
-"""Parse a predetermined CSV of URLs into a Python list."""
+"""Parse a local CSV into a Python list of URLs."""
 import csv
 from typing import List
 

aiohttp_aiofiles_tutorial/data/tests/test_parser.py

@@ -1,12 +1,12 @@
-from typing import List
-
-import pytest
+"""Test reading tutorial sample data URLs."""
 from aiohttp_aiofiles_tutorial.data.parser import parse_urls_from_csv
 from config import CSV_FILEPATH
 
 
 def test_parse_urls():
+    """Ensure URL sample data is parsed correctly."""
 
     urls = parse_urls_from_csv(CSV_FILEPATH)
 
     assert (type(urls)) == list
+    assert "https://" in urls[0]