using common renaming

Author: Andrei Neagu

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_server.py

@@ -129,8 +129,8 @@ def setup(
     router_prefix: str,
     handler_check_decorator: Callable = no_ops_decorator,
     task_request_context_decorator: Callable = no_task_context_decorator,
-    stale_task_check_interval_s: datetime.timedelta = DEFAULT_STALE_TASK_CHECK_INTERVAL,
-    stale_task_detect_timeout_s: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
+    stale_task_check_interval: datetime.timedelta = DEFAULT_STALE_TASK_CHECK_INTERVAL,
+    stale_task_detect_timeout: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
 ) -> None:
     """
     - `router_prefix` APIs are mounted on `/...`, this
@@ -146,8 +146,8 @@ async def on_cleanup_ctx(app: web.Application) -> AsyncGenerator[None, None]:
         # add components to state
         app[APP_LONG_RUNNING_TASKS_MANAGER_KEY] = long_running_task_manager = (
             TasksManager(
-                stale_task_check_interval_s=stale_task_check_interval_s,
-                stale_task_detect_timeout_s=stale_task_detect_timeout_s,
+                stale_task_check_interval=stale_task_check_interval,
+                stale_task_detect_timeout=stale_task_detect_timeout,
             )
         )
 

packages/service-library/src/servicelib/fastapi/long_running_tasks/_server.py

@@ -16,8 +16,8 @@ def setup(
     app: FastAPI,
     *,
     router_prefix: str = "",
-    stale_task_check_interval_s: datetime.timedelta = DEFAULT_STALE_TASK_CHECK_INTERVAL,
-    stale_task_detect_timeout_s: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
+    stale_task_check_interval: datetime.timedelta = DEFAULT_STALE_TASK_CHECK_INTERVAL,
+    stale_task_detect_timeout: datetime.timedelta = DEFAULT_STALE_TASK_DETECT_TIMEOUT,
 ) -> None:
     """
     - `router_prefix` APIs are mounted on `/task/...`, this
@@ -37,8 +37,8 @@ async def on_startup() -> None:
 
         # add components to state
         app.state.long_running_task_manager = TasksManager(
-            stale_task_check_interval_s=stale_task_check_interval_s,
-            stale_task_detect_timeout_s=stale_task_detect_timeout_s,
+            stale_task_check_interval=stale_task_check_interval,
+            stale_task_detect_timeout=stale_task_detect_timeout,
         )
 
     async def on_shutdown() -> None:

packages/service-library/src/servicelib/long_running_tasks/models.py

@@ -2,7 +2,7 @@
 from asyncio import Task
 from collections.abc import Awaitable, Callable, Coroutine
 from dataclasses import dataclass
-from datetime import datetime
+from datetime import UTC, datetime
 from typing import Any, TypeAlias
 
 from models_library.api_schemas_long_running_tasks.base import (
@@ -42,7 +42,7 @@ class TrackedTask(BaseModel):
         description="if True then the task will not be auto-cancelled if no one enquires of its status",
     )
 
-    started: datetime = Field(default_factory=datetime.utcnow)
+    started: datetime = Field(default_factory=lambda: datetime.now(UTC))
     last_status_check: datetime | None = Field(
         default=None,
         description=(
@@ -76,10 +76,10 @@ async def result(self) -> Any:
 
 
 __all__: tuple[str, ...] = (
-    "TaskGetWithoutHref",
     "ProgressMessage",
     "ProgressPercent",
     "TaskGet",
+    "TaskGetWithoutHref",
     "TaskId",
     "TaskProgress",
     "TaskResult",

packages/service-library/src/servicelib/long_running_tasks/task.py

@@ -9,10 +9,7 @@
 from typing import Any, Final, Protocol
 from uuid import uuid4
 
-from models_library.api_schemas_long_running_tasks.base import (
-    ProgressPercent,
-    TaskProgress,
-)
+from models_library.api_schemas_long_running_tasks.base import TaskProgress
 from pydantic import PositiveFloat
 
 from .errors import (
@@ -24,7 +21,7 @@
 )
 from .models import TaskId, TaskName, TaskStatus, TrackedTask
 
-logger = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 _CANCEL_TASK_TIMEOUT: Final[PositiveFloat] = datetime.timedelta(
     seconds=1
@@ -68,22 +65,23 @@ class TasksManager:
 
     def __init__(
         self,
-        stale_task_check_interval_s: datetime.timedelta,
-        stale_task_detect_timeout_s: datetime.timedelta,
+        stale_task_check_interval: datetime.timedelta,
+        stale_task_detect_timeout: datetime.timedelta,
     ):
         # Task groups: Every taskname maps to multiple asyncio.Task within TrackedTask model
         self._tasks_groups: dict[TaskName, TrackedTaskGroupDict] = {}
 
         self.stale_task_check_interval_s: PositiveFloat = (
-            stale_task_check_interval_s.total_seconds()
+            stale_task_check_interval.total_seconds()
         )
         self.stale_task_detect_timeout_s: PositiveFloat = (
-            stale_task_detect_timeout_s.total_seconds()
+            stale_task_detect_timeout.total_seconds()
         )
         self._stale_tasks_monitor_task: asyncio.Task = asyncio.create_task(
             self._stale_tasks_monitor_worker(),
             name=f"{__name__}.stale_task_monitor_worker",
         )
+        # TODO: add setup and teardown and also use periodic
 
     def get_task_group(self, task_name: TaskName) -> TrackedTaskGroupDict:
         return self._tasks_groups[task_name]
@@ -126,7 +124,7 @@ async def _stale_tasks_monitor_worker(self) -> None:
                 # - finished with a result
                 # - finished with errors
                 # we just print the status from where one can infer the above
-                logger.warning(
+                _logger.warning(
                     "Removing stale task '%s' with status '%s'",
                     task_id,
                     self.get_task_status(
@@ -269,7 +267,7 @@ async def _cancel_asyncio_task(
                         _await_task(task), timeout=_CANCEL_TASK_TIMEOUT
                     )
                 except TimeoutError:
-                    logger.warning(
+                    _logger.warning(
                         "Timed out while awaiting for cancellation of '%s'", reference
                     )
             except Exception:  # pylint:disable=broad-except
@@ -395,11 +393,11 @@ def start_task(
 
     # bind the task with progress 0 and 1
     async def _progress_task(progress: TaskProgress, handler: TaskProtocol):
-        progress.update(message="starting", percent=ProgressPercent(0))
+        progress.update(message="starting", percent=0)
         try:
             return await handler(progress, **task_kwargs)
         finally:
-            progress.update(message="finished", percent=ProgressPercent(1))
+            progress.update(message="finished", percent=1)
 
     async_task = asyncio.create_task(
         _progress_task(task_progress, task), name=f"{task_name}"
@@ -421,9 +419,9 @@ async def _progress_task(progress: TaskProgress, handler: TaskProtocol):
     "TaskAlreadyRunningError",
     "TaskCancelledError",
     "TaskId",
-    "TasksManager",
     "TaskProgress",
     "TaskProtocol",
     "TaskStatus",
+    "TasksManager",
     "TrackedTask",
 )

packages/service-library/tests/long_running_tasks/test_long_running_tasks_task.py

@@ -7,7 +7,7 @@
 import asyncio
 import urllib.parse
 from collections.abc import AsyncIterator
-from datetime import datetime
+from datetime import datetime, timedelta
 from typing import Any, Final
 
 import pytest
@@ -71,8 +71,8 @@ async def failing_background_task(task_progress: TaskProgress):
 @pytest.fixture
 async def tasks_manager() -> AsyncIterator[TasksManager]:
     tasks_manager = TasksManager(
-        stale_task_check_interval_s=TEST_CHECK_STALE_INTERVAL_S,
-        stale_task_detect_timeout_s=TEST_CHECK_STALE_INTERVAL_S,
+        stale_task_check_interval=timedelta(seconds=TEST_CHECK_STALE_INTERVAL_S),
+        stale_task_detect_timeout=timedelta(seconds=TEST_CHECK_STALE_INTERVAL_S),
     )
     yield tasks_manager
     await tasks_manager.close()