@pcrespov review: rename

sanderegg · sanderegg · commit 9eff90daebaf · 2025-01-09T17:55:04.000+01:00
diff --git a/packages/service-library/src/servicelib/background_task.py b/packages/service-library/src/servicelib/background_task.py
@@ -115,7 +115,7 @@ async def _periodic_scheduled_task(
             raise TryAgain
 
 
-def start_periodic_task(
+def create_periodic_task(
     task: Callable[..., Awaitable[None]],
     *,
     interval: datetime.timedelta,
@@ -167,7 +167,7 @@ async def periodic_task(
 ) -> AsyncIterator[asyncio.Task]:
     asyncio_task: asyncio.Task | None = None
     try:
-        asyncio_task = start_periodic_task(
+        asyncio_task = create_periodic_task(
             task,
             interval=interval,
             task_name=task_name,
diff --git a/packages/service-library/tests/test_background_task.py b/packages/service-library/tests/test_background_task.py
@@ -15,9 +15,9 @@
 from faker import Faker
 from pytest_mock.plugin import MockerFixture
 from servicelib.background_task import (  # Assuming the module is imported correctly
+    create_periodic_task,
     periodic,
     periodic_task,
-    start_periodic_task,
     stop_periodic_task,
 )
 
@@ -60,7 +60,7 @@ async def _creator(
         task: Callable[..., Awaitable],
         early_wake_up_event: asyncio.Event | None,
     ) -> asyncio.Task:
-        background_task = start_periodic_task(
+        background_task = create_periodic_task(
             task,
             interval=interval,
             task_name=faker.pystr(),
diff --git a/services/agent/src/simcore_service_agent/services/volumes_manager.py b/services/agent/src/simcore_service_agent/services/volumes_manager.py
@@ -9,7 +9,7 @@
 from fastapi import FastAPI
 from models_library.projects_nodes_io import NodeID
 from pydantic import NonNegativeFloat
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.fastapi.app_state import SingletonInAppStateMixin
 from servicelib.logging_utils import log_context
 from servicelib.rabbitmq.rpc_interfaces.agent.errors import (
@@ -45,12 +45,12 @@ class VolumesManager(  # pylint:disable=too-many-instance-attributes
     app_state_name: str = "volumes_manager"
 
     async def setup(self) -> None:
-        self._task_bookkeeping = start_periodic_task(
+        self._task_bookkeeping = create_periodic_task(
             self._bookkeeping_task,
             interval=self.book_keeping_interval,
             task_name="volumes bookkeeping",
         )
-        self._task_periodic_volume_cleanup = start_periodic_task(
+        self._task_periodic_volume_cleanup = create_periodic_task(
             self._bookkeeping_task,
             interval=self.volume_cleanup_interval,
             task_name="volume cleanup",
diff --git a/services/api-server/src/simcore_service_api_server/core/_prometheus_instrumentation.py b/services/api-server/src/simcore_service_api_server/core/_prometheus_instrumentation.py
@@ -6,7 +6,7 @@
 from fastapi import FastAPI
 from prometheus_client import CollectorRegistry, Gauge
 from pydantic import PositiveInt
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.fastapi.prometheus_instrumentation import (
     setup_prometheus_instrumentation as setup_rest_instrumentation,
 )
@@ -67,7 +67,7 @@ async def on_startup() -> None:
             registry=instrumentator.registry
         )
         await wait_till_log_distributor_ready(app)
-        app.state.instrumentation_task = start_periodic_task(
+        app.state.instrumentation_task = create_periodic_task(
             task=_collect_prometheus_metrics_task,
             interval=timedelta(
                 seconds=app.state.settings.API_SERVER_PROMETHEUS_INSTRUMENTATION_COLLECT_SECONDS
diff --git a/services/api-server/src/simcore_service_api_server/core/health_checker.py b/services/api-server/src/simcore_service_api_server/core/health_checker.py
@@ -9,7 +9,7 @@
 from models_library.rabbitmq_messages import LoggerRabbitMessage
 from models_library.users import UserID
 from pydantic import NonNegativeInt, PositiveFloat, PositiveInt
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.fastapi.dependencies import get_app
 from servicelib.logging_utils import log_catch
 from servicelib.rabbitmq import RabbitMQClient
@@ -53,7 +53,7 @@ async def setup(self, health_check_task_period_seconds: PositiveFloat):
         await self._log_distributor.register(
             job_id=self._dummy_job_id, queue=self._dummy_queue
         )
-        self._background_task = start_periodic_task(
+        self._background_task = create_periodic_task(
             task=self._background_task_method,
             interval=timedelta(seconds=health_check_task_period_seconds),
             task_name="api_server_health_check_task",
diff --git a/services/autoscaling/src/simcore_service_autoscaling/modules/auto_scaling_task.py b/services/autoscaling/src/simcore_service_autoscaling/modules/auto_scaling_task.py
@@ -3,7 +3,7 @@
 from typing import Final
 
 from fastapi import FastAPI
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.redis import exclusive
 
 from ..core.settings import ApplicationSettings
@@ -24,7 +24,7 @@ async def _startup() -> None:
         lock_key, lock_value = create_lock_key_and_value(app)
         assert lock_key  # nosec
         assert lock_value  # nosec
-        app.state.autoscaler_task = start_periodic_task(
+        app.state.autoscaler_task = create_periodic_task(
             exclusive(get_redis_client(app), lock_key=lock_key, lock_value=lock_value)(
                 auto_scale_cluster
             ),
diff --git a/services/autoscaling/src/simcore_service_autoscaling/modules/buffer_machines_pool_task.py b/services/autoscaling/src/simcore_service_autoscaling/modules/buffer_machines_pool_task.py
@@ -3,7 +3,7 @@
 from typing import Final
 
 from fastapi import FastAPI
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.redis import exclusive
 
 from ..core.settings import ApplicationSettings
@@ -25,7 +25,7 @@ async def _startup() -> None:
         assert lock_value  # nosec
 
         assert app_settings.AUTOSCALING_EC2_INSTANCES  # nosec
-        app.state.buffers_pool_task = start_periodic_task(
+        app.state.buffers_pool_task = create_periodic_task(
             exclusive(
                 get_redis_client(app),
                 lock_key=f"{lock_key}_buffers_pool",
diff --git a/services/clusters-keeper/src/simcore_service_clusters_keeper/modules/clusters_management_task.py b/services/clusters-keeper/src/simcore_service_clusters_keeper/modules/clusters_management_task.py
@@ -3,7 +3,7 @@
 from collections.abc import Awaitable, Callable
 
 from fastapi import FastAPI
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.redis import exclusive
 
 from .._meta import APP_NAME
@@ -22,7 +22,7 @@ async def _startup() -> None:
 
         lock_key = f"{APP_NAME}:clusters-management_lock"
         lock_value = json.dumps({})
-        app.state.clusters_cleaning_task = start_periodic_task(
+        app.state.clusters_cleaning_task = create_periodic_task(
             exclusive(get_redis_client(app), lock_key=lock_key, lock_value=lock_value)(
                 check_clusters
             ),
diff --git a/services/director-v2/src/simcore_service_director_v2/modules/comp_scheduler/_manager.py b/services/director-v2/src/simcore_service_director_v2/modules/comp_scheduler/_manager.py
@@ -6,7 +6,7 @@
 from fastapi import FastAPI
 from models_library.projects import ProjectID
 from models_library.users import UserID
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.exception_utils import silence_exceptions
 from servicelib.logging_utils import log_context
 from servicelib.redis import CouldNotAcquireLockError, exclusive
@@ -155,7 +155,7 @@ async def schedule_all_pipelines(app: FastAPI) -> None:
 
 
 async def setup_manager(app: FastAPI) -> None:
-    app.state.scheduler_manager = start_periodic_task(
+    app.state.scheduler_manager = create_periodic_task(
         silence_exceptions((CouldNotAcquireLockError,))(schedule_all_pipelines),
         interval=SCHEDULER_INTERVAL,
         task_name=MODULE_NAME_SCHEDULER,
diff --git a/services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_scheduler.py b/services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_scheduler.py
@@ -42,7 +42,7 @@
 from models_library.wallets import WalletID
 from pydantic import NonNegativeFloat
 from servicelib.async_utils import retried_cancel_task
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.fastapi.long_running_tasks.client import ProgressCallback
 from servicelib.fastapi.long_running_tasks.server import TaskProgress
 from servicelib.redis import RedisClientsManager, exclusive
@@ -104,7 +104,7 @@ async def start(self) -> None:
         settings: DynamicServicesSchedulerSettings = (
             self.app.state.settings.DYNAMIC_SERVICES.DYNAMIC_SCHEDULER
         )
-        self._scheduler_task = start_periodic_task(
+        self._scheduler_task = create_periodic_task(
             exclusive(
                 redis_clients_manager.client(RedisDatabase.LOCKS),
                 lock_key=f"{__name__}.{self.__class__.__name__}",
diff --git a/services/director-v2/src/simcore_service_director_v2/utils/base_distributed_identifier.py b/services/director-v2/src/simcore_service_director_v2/utils/base_distributed_identifier.py
@@ -5,7 +5,7 @@
 from typing import Final, Generic, TypeVar
 
 from pydantic import NonNegativeInt
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.logging_utils import log_catch, log_context
 from servicelib.redis import RedisClientSDK
 from servicelib.utils import logged_gather
@@ -67,7 +67,7 @@ def __init__(
         self._cleanup_task: Task | None = None
 
     async def setup(self) -> None:
-        self._cleanup_task = start_periodic_task(
+        self._cleanup_task = create_periodic_task(
             self._cleanup_unused_identifiers,
             interval=self.cleanup_interval,
             task_name="cleanup_unused_identifiers_task",
@@ -170,9 +170,12 @@ async def remove(self, identifier: Identifier, *, reraise: bool = False) -> None
             )
             return
 
-        with log_context(
-            _logger, logging.DEBUG, f"{self.__class__}: removing {identifier}"
-        ), log_catch(_logger, reraise=reraise):
+        with (
+            log_context(
+                _logger, logging.DEBUG, f"{self.__class__}: removing {identifier}"
+            ),
+            log_catch(_logger, reraise=reraise),
+        ):
             await self._destroy(identifier, cleanup_context)
 
         await self._redis_client_sdk.redis.delete(self._to_redis_key(identifier))
diff --git a/services/director/src/simcore_service_director/registry_proxy.py b/services/director/src/simcore_service_director/registry_proxy.py
@@ -10,7 +10,7 @@
 import httpx
 from aiocache import Cache, SimpleMemoryCache  # type: ignore[import-untyped]
 from fastapi import FastAPI, status
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.logging_utils import log_catch, log_context
 from servicelib.utils import limited_as_completed
 from tenacity import retry
@@ -247,7 +247,7 @@ async def on_startup() -> None:
         app_settings = get_application_settings(app)
         app.state.auto_cache_task = None
         if app_settings.DIRECTOR_REGISTRY_CACHING:
-            app.state.auto_cache_task = start_periodic_task(
+            app.state.auto_cache_task = create_periodic_task(
                 _list_all_services_task,
                 interval=app_settings.DIRECTOR_REGISTRY_CACHING_TTL / 2,
                 task_name="director-auto-cache-task",
@@ -594,7 +594,6 @@ async def get_service_extras(
                 # discrete resources (custom made ones) ---
                 # check if the service requires GPU support
                 if not invalid_with_msg and _validate_kind(entry, "VRAM"):
-
                     result["node_requirements"]["GPU"] = 1
                 if not invalid_with_msg and _validate_kind(entry, "MPI"):
                     result["node_requirements"]["MPI"] = 1
diff --git a/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/outputs/_manager.py b/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/outputs/_manager.py
@@ -12,7 +12,7 @@
 from models_library.rabbitmq_messages import ProgressType
 from pydantic import PositiveFloat
 from servicelib import progress_bar
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.logging_utils import log_catch, log_context
 from simcore_sdk.node_ports_common.file_io_utils import LogRedirectCB
 
@@ -194,7 +194,7 @@ def set_all_ports_for_upload(self) -> None:
         self._schedule_all_ports_for_upload = True
 
     async def start(self) -> None:
-        self._task_scheduler_worker = start_periodic_task(
+        self._task_scheduler_worker = create_periodic_task(
             self._scheduler_worker,
             interval=timedelta(seconds=self.task_monitor_interval_s),
             task_name="outputs_manager_scheduler_worker",
diff --git a/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/resource_tracking/_core.py b/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/resource_tracking/_core.py
@@ -14,7 +14,7 @@
 from models_library.services import ServiceType
 from models_library.services_creation import CreateServiceMetricsAdditionalParams
 from pydantic import NonNegativeFloat
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.logging_utils import log_context
 
 from ...core.docker_utils import (
@@ -49,7 +49,7 @@ async def _start_heart_beat_task(app: FastAPI) -> None:
         raise RuntimeError(msg)
 
     with log_context(_logger, logging.DEBUG, "starting heart beat task"):
-        resource_tracking.heart_beat_task = start_periodic_task(
+        resource_tracking.heart_beat_task = create_periodic_task(
             _heart_beat_task,
             app=app,
             interval=resource_tracking_settings.RESOURCE_TRACKING_HEARTBEAT_INTERVAL,
diff --git a/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/system_monitor/_disk_usage.py b/services/dynamic-sidecar/src/simcore_service_dynamic_sidecar/modules/system_monitor/_disk_usage.py
@@ -14,7 +14,7 @@
 )
 from models_library.projects_nodes_io import NodeID
 from models_library.users import UserID
-from servicelib.background_task import start_periodic_task, stop_periodic_task
+from servicelib.background_task import create_periodic_task, stop_periodic_task
 from servicelib.logging_utils import log_context
 from servicelib.utils import logged_gather
 
@@ -120,7 +120,7 @@ def _replace_incoming_usage(
 
     @staticmethod
     def _get_grouped_usage_to_folder_names(
-        local_disk_usage: dict[str, DiskUsage]
+        local_disk_usage: dict[str, DiskUsage],
     ) -> dict[DiskUsage, set[str]]:
         """Groups all paths that have the same metrics together"""
         usage_to_folder_names: dict[DiskUsage, set[str]] = {}
@@ -174,7 +174,7 @@ async def _monitor(self) -> None:
             self._last_usage = supported_usage
 
     async def setup(self) -> None:
-        self._monitor_task = start_periodic_task(
+        self._monitor_task = create_periodic_task(
             self._monitor, interval=self.interval, task_name="monitor_disk_usage"
         )
 
