renamed module

Author: Andrei Neagu

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

@@ -4,7 +4,7 @@
 from pydantic import BaseModel
 from servicelib.aiohttp import status
 
-from ...long_running_tasks import http_endpoint_responses
+from ...long_running_tasks import lrt_api
 from ...long_running_tasks.models import TaskGet, TaskId, TaskStatus
 from ..requests_validation import parse_request_path_parameters_as
 from ..rest_responses import create_data_response
@@ -28,7 +28,7 @@ async def list_tasks(request: web.Request) -> web.Response:
                 result_href=f"{request.app.router['get_task_result'].url_for(task_id=t.task_id)}",
                 abort_href=f"{request.app.router['cancel_and_delete_task'].url_for(task_id=t.task_id)}",
             )
-            for t in http_endpoint_responses.list_tasks(
+            for t in lrt_api.list_tasks(
                 long_running_manager.tasks_manager,
                 long_running_manager.get_task_context(request),
             )
@@ -41,7 +41,7 @@ async def get_task_status(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(_PathParam, request)
     long_running_manager = get_long_running_manager(request.app)
 
-    task_status: TaskStatus = http_endpoint_responses.get_task_status(
+    task_status: TaskStatus = lrt_api.get_task_status(
         long_running_manager.tasks_manager,
         long_running_manager.get_task_context(request),
         path_params.task_id,
@@ -55,7 +55,7 @@ async def get_task_result(request: web.Request) -> web.Response | Any:
     long_running_manager = get_long_running_manager(request.app)
 
     # NOTE: this might raise an exception that will be catched by the _error_handlers
-    return await http_endpoint_responses.get_task_result(
+    return await lrt_api.get_task_result(
         long_running_manager.tasks_manager,
         long_running_manager.get_task_context(request),
         path_params.task_id,
@@ -67,7 +67,7 @@ async def cancel_and_delete_task(request: web.Request) -> web.Response:
     path_params = parse_request_path_parameters_as(_PathParam, request)
     long_running_manager = get_long_running_manager(request.app)
 
-    await http_endpoint_responses.remove_task(
+    await lrt_api.remove_task(
         long_running_manager.tasks_manager,
         long_running_manager.get_task_context(request),
         path_params.task_id,

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

@@ -9,7 +9,7 @@
 from pydantic import AnyHttpUrl, TypeAdapter
 
 from ...aiohttp import status
-from ...long_running_tasks import http_endpoint_responses
+from ...long_running_tasks import lrt_api
 from ...long_running_tasks.constants import (
     DEFAULT_STALE_TASK_CHECK_INTERVAL,
     DEFAULT_STALE_TASK_DETECT_TIMEOUT,
@@ -56,7 +56,7 @@ async def start_long_running_task(
     task_name = _create_task_name_from_request(request_)
     task_id = None
     try:
-        task_id = await http_endpoint_responses.start_task(
+        task_id = await lrt_api.start_task(
             long_running_manager.tasks_manager,
             registerd_task_name,
             fire_and_forget=fire_and_forget,

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

@@ -2,7 +2,7 @@
 
 from fastapi import APIRouter, Depends, Request, status
 
-from ...long_running_tasks import http_endpoint_responses
+from ...long_running_tasks import lrt_api
 from ...long_running_tasks.models import TaskGet, TaskId, TaskResult, TaskStatus
 from ..requests_decorators import cancel_on_disconnect
 from ._dependencies import get_long_running_manager
@@ -29,7 +29,7 @@ async def list_tasks(
                 request.url_for("cancel_and_delete_task", task_id=t.task_id)
             ),
         )
-        for t in http_endpoint_responses.list_tasks(
+        for t in lrt_api.list_tasks(
             long_running_manager.tasks_manager, task_context=None
         )
     ]
@@ -51,7 +51,7 @@ async def get_task_status(
     ],
 ) -> TaskStatus:
     assert request  # nosec
-    return http_endpoint_responses.get_task_status(
+    return lrt_api.get_task_status(
         long_running_manager.tasks_manager, task_context=None, task_id=task_id
     )
 
@@ -74,7 +74,7 @@ async def get_task_result(
     ],
 ) -> TaskResult | Any:
     assert request  # nosec
-    return await http_endpoint_responses.get_task_result(
+    return await lrt_api.get_task_result(
         long_running_manager.tasks_manager, task_context=None, task_id=task_id
     )
 
@@ -97,6 +97,6 @@ async def cancel_and_delete_task(
     ],
 ) -> None:
     assert request  # nosec
-    await http_endpoint_responses.remove_task(
+    await lrt_api.remove_task(
         long_running_manager.tasks_manager, task_context=None, task_id=task_id
     )

packages/service-library/src/servicelib/long_running_tasks/http_endpoint_responses.py renamed to packages/service-library/src/servicelib/long_running_tasks/lrt_api.py

@@ -25,7 +25,7 @@
     get_long_running_manager,
 )
 from servicelib.fastapi.long_running_tasks.server import setup as setup_server
-from servicelib.long_running_tasks import http_endpoint_responses
+from servicelib.long_running_tasks import lrt_api
 from servicelib.long_running_tasks.models import (
     TaskGet,
     TaskId,
@@ -79,7 +79,7 @@ async def create_string_list_task(
         *,
         fail: bool = False,
     ) -> TaskId:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager,
             _string_list_task.__name__,
             num_strings=num_strings,

packages/service-library/tests/fastapi/long_running_tasks/test_long_running_tasks.py

@@ -16,7 +16,7 @@
 from servicelib.fastapi.long_running_tasks.client import setup as setup_client
 from servicelib.fastapi.long_running_tasks.server import get_long_running_manager
 from servicelib.fastapi.long_running_tasks.server import setup as setup_server
-from servicelib.long_running_tasks import http_endpoint_responses
+from servicelib.long_running_tasks import lrt_api
 from servicelib.long_running_tasks.errors import (
     TaskClientTimeoutError,
 )
@@ -69,7 +69,7 @@ async def create_task_user_defined_route(
             FastAPILongRunningManager, Depends(get_long_running_manager)
         ],
     ) -> TaskId:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager, a_test_task.__name__
         )
 
@@ -79,7 +79,7 @@ async def create_task_which_fails(
             FastAPILongRunningManager, Depends(get_long_running_manager)
         ],
     ) -> TaskId:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager, a_failing_test_task.__name__
         )
 

packages/service-library/tests/fastapi/long_running_tasks/test_long_running_tasks_context_manager.py

@@ -12,7 +12,7 @@
 
 import pytest
 from faker import Faker
-from servicelib.long_running_tasks import http_endpoint_responses
+from servicelib.long_running_tasks import lrt_api
 from servicelib.long_running_tasks.errors import (
     TaskAlreadyRunningError,
     TaskCancelledError,
@@ -85,7 +85,7 @@ async def tasks_manager() -> AsyncIterator[TasksManager]:
 async def test_task_is_auto_removed(
     tasks_manager: TasksManager, check_task_presence_before: bool
 ):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -112,7 +112,7 @@ async def test_task_is_auto_removed(
 
 
 async def test_checked_task_is_not_auto_removed(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -127,7 +127,7 @@ async def test_checked_task_is_not_auto_removed(tasks_manager: TasksManager):
 
 
 async def test_fire_and_forget_task_is_not_auto_removed(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -146,7 +146,7 @@ async def test_fire_and_forget_task_is_not_auto_removed(tasks_manager: TasksMana
 
 
 async def test_get_result_of_unfinished_task_raises(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -163,15 +163,11 @@ async def unique_task(progress: TaskProgress):
 
     TaskRegistry.register(unique_task)
 
-    await http_endpoint_responses.start_task(
-        tasks_manager, unique_task.__name__, unique=True
-    )
+    await lrt_api.start_task(tasks_manager, unique_task.__name__, unique=True)
 
     # ensure unique running task regardless of how many times it gets started
     with pytest.raises(TaskAlreadyRunningError) as exec_info:
-        await http_endpoint_responses.start_task(
-            tasks_manager, unique_task.__name__, unique=True
-        )
+        await lrt_api.start_task(tasks_manager, unique_task.__name__, unique=True)
     assert "must be unique, found: " in f"{exec_info.value}"
 
     TaskRegistry.unregister(unique_task)
@@ -184,9 +180,7 @@ async def not_unique_task(progress: TaskProgress):
     TaskRegistry.register(not_unique_task)
 
     for _ in range(5):
-        await http_endpoint_responses.start_task(
-            tasks_manager, not_unique_task.__name__
-        )
+        await lrt_api.start_task(tasks_manager, not_unique_task.__name__)
 
     TaskRegistry.unregister(not_unique_task)
 
@@ -199,7 +193,7 @@ def test_get_task_id(tasks_manager: TasksManager, faker: Faker, is_unique: bool)
 
 
 async def test_get_status(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -220,9 +214,7 @@ async def test_get_status_missing(tasks_manager: TasksManager):
 
 
 async def test_get_result(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
-        tasks_manager, fast_background_task.__name__
-    )
+    task_id = await lrt_api.start_task(tasks_manager, fast_background_task.__name__)
     await asyncio.sleep(0.1)
     result = tasks_manager.get_task_result(task_id, with_task_context=None)
     assert result == 42
@@ -235,9 +227,7 @@ async def test_get_result_missing(tasks_manager: TasksManager):
 
 
 async def test_get_result_finished_with_error(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
-        tasks_manager, failing_background_task.__name__
-    )
+    task_id = await lrt_api.start_task(tasks_manager, failing_background_task.__name__)
     # wait for result
     async for attempt in AsyncRetrying(**_RETRY_PARAMS):
         with attempt:
@@ -250,7 +240,7 @@ async def test_get_result_finished_with_error(tasks_manager: TasksManager):
 async def test_get_result_task_was_cancelled_multiple_times(
     tasks_manager: TasksManager,
 ):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -266,7 +256,7 @@ async def test_get_result_task_was_cancelled_multiple_times(
 
 
 async def test_remove_task(tasks_manager: TasksManager):
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -282,7 +272,7 @@ async def test_remove_task(tasks_manager: TasksManager):
 
 async def test_remove_task_with_task_context(tasks_manager: TasksManager):
     TASK_CONTEXT = {"some_context": "some_value"}
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -315,7 +305,7 @@ async def test_remove_unknown_task(tasks_manager: TasksManager):
 
 async def test_cancel_task_with_task_context(tasks_manager: TasksManager):
     TASK_CONTEXT = {"some_context": "some_value"}
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -342,7 +332,7 @@ async def test_list_tasks(tasks_manager: TasksManager):
     task_ids = []
     for _ in range(NUM_TASKS):
         task_ids.append(  # noqa: PERF401
-            await http_endpoint_responses.start_task(
+            await lrt_api.start_task(
                 tasks_manager,
                 a_background_task.__name__,
                 raise_when_finished=False,
@@ -358,20 +348,20 @@ async def test_list_tasks(tasks_manager: TasksManager):
 
 
 async def test_list_tasks_filtering(tasks_manager: TasksManager):
-    await http_endpoint_responses.start_task(
+    await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
         total_sleep=10,
     )
-    await http_endpoint_responses.start_task(
+    await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
         total_sleep=10,
         task_context={"user_id": 213},
     )
-    await http_endpoint_responses.start_task(
+    await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -400,7 +390,7 @@ async def test_list_tasks_filtering(tasks_manager: TasksManager):
 
 async def test_define_task_name(tasks_manager: TasksManager, faker: Faker):
     task_name = faker.name()
-    task_id = await http_endpoint_responses.start_task(
+    task_id = await lrt_api.start_task(
         tasks_manager,
         a_background_task.__name__,
         raise_when_finished=False,
@@ -412,4 +402,4 @@ async def test_define_task_name(tasks_manager: TasksManager, faker: Faker):
 
 async def test_start_not_registered_task(tasks_manager: TasksManager):
     with pytest.raises(TaskNotRegisteredError):
-        await http_endpoint_responses.start_task(tasks_manager, "not_registered_task")
+        await lrt_api.start_task(tasks_manager, "not_registered_task")

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

@@ -6,7 +6,7 @@
 from pydantic import BaseModel, PositiveInt
 from servicelib.fastapi.long_running_tasks._manager import FastAPILongRunningManager
 from servicelib.fastapi.long_running_tasks.server import get_long_running_manager
-from servicelib.long_running_tasks import http_endpoint_responses
+from servicelib.long_running_tasks import lrt_api
 from servicelib.long_running_tasks.errors import TaskAlreadyRunningError
 from servicelib.long_running_tasks.models import (
     ProgressMessage,
@@ -115,7 +115,7 @@ async def _progress_callback(
     TaskRegistry.register(_task_remove_service_containers)
 
     try:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager,
             _task_remove_service_containers.__name__,
             unique=True,
@@ -180,7 +180,7 @@ async def _progress_callback(
     TaskRegistry.register(_task_save_service_state)
 
     try:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager,
             _task_save_service_state.__name__,
             unique=True,
@@ -227,7 +227,7 @@ async def _progress_callback(
     TaskRegistry.register(_task_push_service_outputs)
 
     try:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager,
             _task_push_service_outputs.__name__,
             unique=True,
@@ -269,7 +269,7 @@ async def _task_cleanup_service_docker_resources(
     TaskRegistry.register(_task_cleanup_service_docker_resources)
 
     try:
-        return await http_endpoint_responses.start_task(
+        return await lrt_api.start_task(
             long_running_manager.tasks_manager,
             _task_cleanup_service_docker_resources.__name__,
             unique=True,