Fix test import and address pre-commit checks (#2)

* Fix import in test_utils

* Tweak readme

Author: CelestineKao

README.md

@@ -51,7 +51,7 @@ task_queue = AsyncTaskQueue(
 # Add async tasks to the queue
 task_queue.enqueue(
     [
-        AsyncTask(some_coroutine, arg) for arg in some_args
+        AsyncTask(some_coroutine, *args, **kwargs) for args, kwargs in some_args_kwargs
     ]
 )
 

src/async_task_queue/async_task_queue.py

@@ -26,6 +26,7 @@ async def execute(self) -> None:
             self.result = e
 
     def __repr__(self) -> str:
+        """Object representation for debugging"""
         return render(self, treelike_whitelist=(AsyncTask,))
 
 
@@ -259,4 +260,5 @@ async def _execute_task(self, task: AsyncTask, queue: deque) -> None:
             self._enqueue([task], queue=self.succeeded_tasks)
 
     def __repr__(self) -> str:
+        """Object representation for debugging"""
         return render(self, treelike_whitelist=(AsyncTaskQueue,))

src/async_task_queue/render.py

@@ -1,8 +1,9 @@
+"""Module for rendering output of python objects"""
+
 import inspect
 from typing import Any, Callable, Dict, Set, Tuple, Type
 from unittest.mock import Mock
 
-
 COLOR_CODES = {
     "blue": "\033[94m",
     "green": "\033[92m",
@@ -81,7 +82,8 @@ def _render(
         level: The level in the tree at which the `obj` is rendered.
         indent: What represents a single indentation.
         treelike_whitelist: Classes to render in a tree-like fashion.
-        attr_blacklist: attributes to exclude
+        treelike_blacklist: Classes to render with the typename only.
+        attr_blacklist: Attributes to exclude from rendering
         renderer_overrides: a mapping from classes to functions that should be used
             to render those classes. The function should take an instance of the class
             and return the rendered string
@@ -166,6 +168,7 @@ def _get_default_arguments(obj: Any) -> Set[str]:
 
     Returns:
         the set of default arguments
+
     """
     cls = type(obj)
     obj_sig = inspect.signature(cls.__init__)
@@ -200,7 +203,6 @@ def render(
     """Render any object in tree form.
 
     Example:
-
         Class(
             arg1=val1,
             arg2=[
@@ -217,8 +219,8 @@ def render(
         indent: What represents a single indentation.
         treelike_whitelist: Classes to render in a tree-like fashion.
         treelike_blacklist: Classes to render with the typename only.
-        attr_blacklist: attributes to exclude
-        renderer_overrides: a mapping from classes to functions that should be used
+        attr_blacklist: Attributes to exclude from rendering
+        renderer_overrides: A mapping from classes to functions that should be used
             to render those classes. The function should take an instance of the class
             and return the rendered string
 

tests/test_utils.py

@@ -1,7 +1,8 @@
 """Contains test utilities"""
 
 import asyncio
-from typing import Any, Callable
+from typing import Callable
+from unittest.mock import MagicMock
 
 
 def async_test(async_test_func: Callable[..., None]) -> Callable[..., None]: