@sanderegg review: moving to async_tools

Author: pcrespov

packages/common-library/src/common_library/async_tools.py

@@ -1,10 +1,12 @@
 import asyncio
+import datetime
 import functools
 import logging
-from collections.abc import Awaitable, Callable
+from collections.abc import Awaitable, Callable, Coroutine
 from concurrent.futures import Executor
+from functools import wraps
 from inspect import isawaitable
-from typing import ParamSpec, TypeVar, overload
+from typing import Any, ParamSpec, TypeVar, overload
 
 _logger = logging.getLogger(__name__)
 
@@ -110,3 +112,21 @@ async def cancel_and_wait(
             "Task %s cancellation is complete",
             task.get_name(),
         )
+
+
+def delayed_start(
+    delay: datetime.timedelta,
+) -> Callable[
+    [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]
+]:
+    def _decorator(
+        func: Callable[P, Coroutine[Any, Any, R]],
+    ) -> Callable[P, Coroutine[Any, Any, R]]:
+        @wraps(func)
+        async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+            await asyncio.sleep(delay.total_seconds())
+            return await func(*args, **kwargs)
+
+        return _wrapper
+
+    return _decorator

packages/common-library/tests/test_async_tools.py

@@ -1,10 +1,16 @@
 import asyncio
 import time
 from concurrent.futures import ThreadPoolExecutor
+from datetime import timedelta
 from typing import Any
 
 import pytest
-from common_library.async_tools import cancel_and_wait, make_async, maybe_await
+from common_library.async_tools import (
+    cancel_and_wait,
+    delayed_start,
+    make_async,
+    maybe_await,
+)
 
 
 @make_async()
@@ -193,3 +199,20 @@ async def slow_cleanup_coro():
         )  # 0.2 seconds < 2 seconds cleanup
 
     assert task.cancelled()
+
+
+async def test_with_delay():
+    @delayed_start(timedelta(seconds=0.2))
+    async def decorated_awaitable() -> int:
+        return 42
+
+    assert await decorated_awaitable() == 42
+
+    async def another_awaitable() -> int:
+        return 42
+
+    decorated_another_awaitable = delayed_start(timedelta(seconds=0.2))(
+        another_awaitable
+    )
+
+    assert await decorated_another_awaitable() == 42

packages/service-library/src/servicelib/async_utils.py

@@ -1,8 +1,7 @@
 import asyncio
-import datetime
 import logging
 from collections import deque
-from collections.abc import Awaitable, Callable, Coroutine
+from collections.abc import Awaitable, Callable
 from contextlib import suppress
 from dataclasses import dataclass
 from functools import wraps
@@ -211,21 +210,3 @@ async def worker(in_q: Queue[QueueElement], out_q: Queue) -> None:
         return wrapper
 
     return decorator
-
-
-def delayed_start(
-    delay: datetime.timedelta,
-) -> Callable[
-    [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]
-]:
-    def _decorator(
-        func: Callable[P, Coroutine[Any, Any, R]],
-    ) -> Callable[P, Coroutine[Any, Any, R]]:
-        @wraps(func)
-        async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-            await asyncio.sleep(delay.total_seconds())
-            return await func(*args, **kwargs)
-
-        return _wrapper
-
-    return _decorator

packages/service-library/src/servicelib/background_task.py

@@ -6,10 +6,10 @@
 from collections.abc import AsyncIterator, Awaitable, Callable, Coroutine
 from typing import Any, Final, ParamSpec, TypeVar
 
+from common_library.async_tools import cancel_and_wait, delayed_start
 from tenacity import TryAgain, before_sleep_log, retry, retry_if_exception_type
 from tenacity.wait import wait_fixed
 
-from .async_utils import cancel_and_wait, delayed_start
 from .logging_utils import log_catch, log_context
 
 _logger = logging.getLogger(__name__)

packages/service-library/tests/test_async_utils.py

@@ -7,15 +7,13 @@
 import random
 from collections import deque
 from dataclasses import dataclass
-from datetime import timedelta
 from time import time
 from typing import Any
 
 import pytest
 from faker import Faker
 from servicelib.async_utils import (
     _sequential_jobs_contexts,
-    delayed_start,
     run_sequentially_in_context,
 )
 
@@ -225,20 +223,3 @@ async def test_multiple_context_calls(context_param: int) -> int:
             assert i == await test_multiple_context_calls(i)
 
     assert len(_sequential_jobs_contexts) == RETRIES
-
-
-async def test_with_delay():
-    @delayed_start(timedelta(seconds=0.2))
-    async def decorated_awaitable() -> int:
-        return 42
-
-    assert await decorated_awaitable() == 42
-
-    async def another_awaitable() -> int:
-        return 42
-
-    decorated_another_awaitable = delayed_start(timedelta(seconds=0.2))(
-        another_awaitable
-    )
-
-    assert await decorated_another_awaitable() == 42