Clean up docstrings.

Author: toddbirchard

aiohttp_aiofiles_tutorial/__init__.py

@@ -4,7 +4,7 @@
 from time import perf_counter as timer
 
 import aiofiles
-from aiofiles.threadpool.text import AsyncTextIOWrapper
+from aiofiles.threadpool.text import AsyncTextIOWrapper as AsyncIOFile
 from aiohttp import ClientSession
 from config import EXPORT_FILE, HTML_HEADERS
 from logger import LOGGER
@@ -24,11 +24,11 @@ async def init_script():
     LOGGER.success(f"Executed {__name__} in {time.perf_counter() - start_time:0.2f} seconds.")
 
 
-async def create_and_execute_tasks(outfile: AsyncTextIOWrapper):
+async def create_and_execute_tasks(outfile: AsyncIOFile):
     """
     Open async HTTP session & execute created tasks.
 
-    :param AsyncTextIOWrapper outfile: Filepath of local .csv file to write to.
+    :param AsyncIOFile outfile: Path of local file to write to.
     """
     async with ClientSession(headers=HTML_HEADERS) as session:
         task_list = await create_tasks(session, urls, outfile)

aiohttp_aiofiles_tutorial/fetcher.py

@@ -1,20 +1,20 @@
 """Fetch URLs, extract their contents, and write parsed data to file."""
-from aiofiles.threadpool.text import AsyncTextIOWrapper
+from aiofiles.threadpool.text import AsyncTextIOWrapper as AsyncIOFile
 from aiohttp import ClientError, ClientSession, InvalidURL
 from logger import LOGGER
 
 from .writer import write_to_outfile
 
 
 async def fetch_url_and_save_title(
-    session: ClientSession, url: str, outfile: AsyncTextIOWrapper, total_count: int, i: int
+    session: ClientSession, url: str, outfile: AsyncIOFile, total_count: int, i: int
 ):
     """
     Fetch raw HTML from a URL prior to parsing.
 
     :param ClientSession session: Async HTTP requests session.
     :param str url: Target URL to be fetched.
-    :param AsyncTextIOWrapper outfile: Filepath of local .csv file to write to.
+    :param AsyncIOFile outfile: Path of local file to write to.
     :param int total_count: Total number of URLs to be fetched.
     :param int i: Current iteration of URL out of total URLs.
     """

aiohttp_aiofiles_tutorial/tasks.py

@@ -3,28 +3,24 @@
 from asyncio import Task
 from typing import List
 
-from aiofiles.threadpool.text import AsyncTextIOWrapper
+from aiofiles.threadpool.text import AsyncTextIOWrapper as AsyncIOFile
 from aiohttp import ClientSession
 
 from .fetcher import fetch_url_and_save_title
 
 
-async def create_tasks(
-    session: ClientSession, urls: List[str], outfile: AsyncTextIOWrapper
-) -> List[Task]:
+async def create_tasks(session: ClientSession, urls: List[str], outfile: AsyncIOFile) -> List[Task]:
     """
     Create asyncio tasks to execute the `fetch_url_and_save_title` coroutine.
 
     :param ClientSession session: Async HTTP requests session.
     :param List[str] urls: Resource URLs to fetch.
-    :param AsyncTextIOWrapper outfile: Filepath of local .csv file to write to.
+    :param AsyncIOFile outfile: Path of local file to write to.
 
     :returns: List[Task]
     """
     task_list = []
     for i, url in enumerate(urls):
-        task = asyncio.create_task(
-            fetch_url_and_save_title(session, url, outfile, len(urls), i)
-        )
+        task = asyncio.create_task(fetch_url_and_save_title(session, url, outfile, len(urls), i))
         task_list.append(task)
     return task_list

aiohttp_aiofiles_tutorial/writer.py

@@ -1,18 +1,16 @@
 """Parse data from fetched URL and write to file asynchronously."""
-from aiofiles.threadpool.text import AsyncTextIOWrapper
+from aiofiles.threadpool.text import AsyncTextIOWrapper as AsyncIOFile
 from bs4 import BeautifulSoup
 from logger import LOGGER
 
 
-async def write_to_outfile(
-    html: str, url: str, outfile: AsyncTextIOWrapper, total_count: int, i: int
-):
+async def write_to_outfile(html: str, url: str, outfile: AsyncIOFile, total_count: int, i: int):
     """
     Write contents of fetched URL to new file in local directory.
 
     :param str html: Source HTML of a single fetched URL.
     :param str url: Target URL to be fetched.
-    :param AsyncTextIOWrapper outfile: Filepath of local .csv file to write to.
+    :param AsyncIOFile outfile: Path of local file to write to.
     :param int total_count: Total number of URLs to be fetched.
     :param int i: Current iteration of URL out of total URLs.
     """
@@ -30,6 +28,8 @@ async def get_html_page_title(html: str, url: str) -> str:
 
     :param str html: Raw HTML source of a given fetched URL.
     :param str url: URL associated with the extracted HTML.
+
+    :returns: str
     """
     soup = BeautifulSoup(html, "html.parser")
     return f"{soup.title.string.replace(',', '')}, {url},"