@pcrespov review: renaming things

Author: sanderegg

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

@@ -214,22 +214,22 @@ async def worker(in_q: Queue[QueueElement], out_q: Queue) -> None:
     return decorator
 
 
-def with_delay(
+def delayed_start(
     delay: datetime.timedelta,
 ) -> Callable[
     [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]
 ]:
-    def decorator(
+    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:
+        async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             await asyncio.sleep(delay.total_seconds())
             return await func(*args, **kwargs)
 
-        return wrapper
+        return _wrapper
 
-    return decorator
+    return _decorator
 
 
 async def cancel_wait_task(

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

@@ -9,7 +9,7 @@
 from tenacity import TryAgain, before_sleep_log, retry, retry_if_exception_type
 from tenacity.wait import wait_fixed
 
-from .async_utils import cancel_wait_task, with_delay
+from .async_utils import cancel_wait_task, delayed_start
 from .logging_utils import log_context
 
 _logger = logging.getLogger(__name__)
@@ -97,7 +97,7 @@ def create_periodic_task(
     early_wake_up_event: asyncio.Event | None = None,
     **kwargs,
 ) -> asyncio.Task:
-    @with_delay(wait_before_running)
+    @delayed_start(wait_before_running)
     @periodic(
         interval=interval,
         raise_on_error=raise_on_error,

packages/service-library/tests/test_async_utils.py

@@ -15,8 +15,8 @@
 from faker import Faker
 from servicelib.async_utils import (
     _sequential_jobs_contexts,
+    delayed_start,
     run_sequentially_in_context,
-    with_delay,
 )
 
 RETRIES = 10
@@ -228,7 +228,7 @@ async def test_multiple_context_calls(context_param: int) -> int:
 
 
 async def test_with_delay():
-    @with_delay(timedelta(seconds=0.2))
+    @delayed_start(timedelta(seconds=0.2))
     async def decorated_awaitable() -> int:
         return 42
 
@@ -237,6 +237,8 @@ async def decorated_awaitable() -> int:
     async def another_awaitable() -> int:
         return 42
 
-    decorated_another_awaitable = with_delay(timedelta(seconds=0.2))(another_awaitable)
+    decorated_another_awaitable = delayed_start(timedelta(seconds=0.2))(
+        another_awaitable
+    )
 
     assert await decorated_another_awaitable() == 42