Improved task name handling

Author: madduck

click_async_plugins/util.py

@@ -22,38 +22,42 @@ class CliContext:
 pass_clictx = click.make_pass_decorator(CliContext)
 
 
+@dataclass
+class TaskWithName:
+    task: PluginTask | None
+    name: str
+
+
 async def sleep_forever(sleep: float = 1, *, forever: bool = True) -> Never | None:
     while await asyncio.sleep(sleep, forever):
         pass
     return None
 
 
 def create_plugin_task[T](
-    task: PluginTask | None,
+    task: TaskWithName,
     *,
-    name: str | None = None,
     create_task_fn: Callable[..., asyncio.Task[T]] = asyncio.create_task,
 ) -> asyncio.Task[T]:
     async def task_wrapper() -> None:
         try:
-            if asyncio.iscoroutine(task):
-                logger.debug(f"Scheduling task for '{name}'")
-                await task
+            if asyncio.iscoroutine(task.task):
+                logger.debug(f"Scheduling task for '{task.name}'")
+                await task.task
 
             else:
-                logger.debug(f"Waiting until programme termination for '{name}'")
+                logger.debug(f"Waiting until programme termination for '{task.name}'")
                 await sleep_forever(3600)
 
         except asyncio.CancelledError:
-            logger.debug(f"Task for '{name}' cancelled")
+            logger.debug(f"Task for '{task.name}' cancelled")
 
-    if task is not None:
-        name = name or task.__name__
-        task_wrapper = update_wrapper(task_wrapper, task)  # type: ignore[arg-type]
+    if task.task is not None:
+        task_wrapper = update_wrapper(task_wrapper, task.task)  # type: ignore[arg-type]
     else:
         task_wrapper = update_wrapper(task_wrapper, sleep_forever)
 
-    return create_task_fn(task_wrapper(), name=name)
+    return create_task_fn(task_wrapper(), name=task.name)
 
 
 def _get_name(plugin_factory: PluginFactory) -> str:
@@ -72,21 +76,19 @@ async def setup_plugins(
     *args: Any,
     stack: AsyncExitStack,
     **kwargs: Any,
-) -> list[PluginTask | None]:
-    tasks: list[PluginTask | None] = []
+) -> list[TaskWithName]:
+    tasks: list[TaskWithName] = []
     for plugin_factory in plugin_factories:
         plugin_fn = plugin_factory(*args, **kwargs)
         name = _get_name(plugin_factory)
         logger.debug(f"Setting up task for '{name}'")
         task = await stack.enter_async_context(plugin_fn)
-        if task is not None and name is not None:
-            task.__name__ = name
-        tasks.append(task)
+        tasks.append(TaskWithName(task=task, name=name))
 
     return tasks
 
 
-async def run_tasks(tasks: list[PluginTask | None]) -> None:
+async def run_tasks(tasks: list[TaskWithName]) -> None:
     try:
         async with asyncio.TaskGroup() as tg:
             plugin_task = partial(create_plugin_task, create_task_fn=tg.create_task)

pyproject.toml

@@ -7,7 +7,7 @@ write_to = "_version.py"
 
 [project]
 name = "click-async-plugins"
-version = "0.4.0"
+version = "0.5.0"
 authors = [
   { name = "martin f. krafft", email = "[email protected]" },
 ]