removed unused client

Author: Andrei Neagu

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

@@ -1,9 +1,7 @@
 import asyncio
 import functools
 import logging
-from abc import ABC, abstractmethod
 from collections.abc import Awaitable, Callable
-from datetime import timedelta
 from typing import Any, Final
 
 from fastapi import FastAPI, status
@@ -15,15 +13,8 @@
 from tenacity.stop import stop_after_attempt
 from tenacity.wait import wait_exponential
 
-from ...long_running_tasks import lrt_api
 from ...long_running_tasks.errors import GenericClientError
-from ...long_running_tasks.models import (
-    ClientConfiguration,
-    LRTNamespace,
-    TaskId,
-    TaskStatus,
-)
-from ...rabbitmq._client_rpc import RabbitMQRPCClient
+from ...long_running_tasks.models import ClientConfiguration, TaskId, TaskStatus
 
 _DEFAULT_HTTP_REQUESTS_TIMEOUT: Final[PositiveFloat] = 15
 
@@ -97,7 +88,7 @@ def retry_on_http_errors(
     assert asyncio.iscoroutinefunction(request_func)
 
     @functools.wraps(request_func)
-    async def request_wrapper(zelf: "BaseClient", *args, **kwargs) -> Any:
+    async def request_wrapper(zelf: "HttpClient", *args, **kwargs) -> Any:
         async for attempt in AsyncRetrying(
             stop=stop_after_attempt(max_attempt_number=3),
             wait=wait_exponential(min=1),
@@ -115,79 +106,7 @@ async def request_wrapper(zelf: "BaseClient", *args, **kwargs) -> Any:
     return request_wrapper
 
 
-class BaseClient(ABC):
-
-    @property
-    @abstractmethod
-    def external_reference(self) -> str:
-        pass
-
-    @abstractmethod
-    async def get_task_status(
-        self, task_id: TaskId, *, timeout: PositiveFloat | None = None  # noqa: ASYNC109
-    ) -> TaskStatus:
-        pass
-
-    @abstractmethod
-    async def get_task_result(
-        self, task_id: TaskId, *, timeout: PositiveFloat | None = None  # noqa: ASYNC109
-    ) -> Any | None:
-        pass
-
-    @abstractmethod
-    async def remove_task(
-        self, task_id: TaskId, *, timeout: PositiveFloat | None = None  # noqa: ASYNC109
-    ) -> None:
-        pass
-
-
-class RPCClient(BaseClient):
-    def __init__(
-        self, rabbitmq_rpc_client: RabbitMQRPCClient, lrt_namespace: LRTNamespace
-    ):
-        self._rpc_client = rabbitmq_rpc_client
-        self._lrt_namespace = lrt_namespace
-
-    @property
-    def external_reference(self) -> str:
-        return f"LRT_NAMESPACE:{self._lrt_namespace}"
-
-    async def get_task_status(
-        self, task_id: TaskId, *, timeout: PositiveFloat | None = None  # noqa: ASYNC109
-    ) -> TaskStatus:
-        _ = timeout
-        return await lrt_api.get_task_status(
-            self._rpc_client, self._lrt_namespace, {}, task_id
-        )
-
-    async def get_task_result(
-        self, task_id: TaskId, *, timeout: PositiveFloat | None = None  # noqa: ASYNC109
-    ) -> Any | None:
-        _ = timeout
-        return await lrt_api.get_task_result(
-            self._rpc_client, self._lrt_namespace, {}, task_id
-        )
-
-    async def remove_task(
-        self,
-        task_id: TaskId,
-        *,
-        timeout: PositiveFloat | None = None,  # noqa: ASYNC109
-        wait_for_removal: bool = True,
-        cancellation_timeout: timedelta | None = None,
-    ) -> None:
-        _ = timeout
-        return await lrt_api.remove_task(
-            self._rpc_client,
-            self._lrt_namespace,
-            {},
-            task_id,
-            wait_for_removal=wait_for_removal,
-            cancellation_timeout=cancellation_timeout,
-        )
-
-
-class HttpClient(BaseClient):
+class HttpClient:
     """
     This is a client that aims to simplify the requests to get the
     status, result and/or cancel of a long running task.

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

@@ -16,7 +16,7 @@
     TaskId,
     TaskStatus,
 )
-from ._client import BaseClient
+from ._client import HttpClient
 
 _logger = logging.getLogger(__name__)
 
@@ -70,7 +70,7 @@ async def update(
 
 @asynccontextmanager
 async def periodic_task_result(
-    client: BaseClient,
+    client: HttpClient,
     task_id: TaskId,
     *,
     task_timeout: PositiveFloat,

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

@@ -2,14 +2,12 @@
 Provides a convenient way to return the result given a TaskId.
 """
 
-from ._client import BaseClient, HttpClient, RPCClient, setup
+from ._client import HttpClient, setup
 from ._context_manager import periodic_task_result  # attach to the same object!
 
 __all__: tuple[str, ...] = (
-    "BaseClient",
     "HttpClient",
     "periodic_task_result",
-    "RPCClient",
     "setup",
 )
 # nopycln: file

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

@@ -13,9 +13,7 @@
 from servicelib.fastapi.long_running_tasks._context_manager import _ProgressManager
 from servicelib.fastapi.long_running_tasks._manager import FastAPILongRunningManager
 from servicelib.fastapi.long_running_tasks.client import (
-    BaseClient,
     HttpClient,
-    RPCClient,
     periodic_task_result,
 )
 from servicelib.fastapi.long_running_tasks.client import setup as setup_client
@@ -48,7 +46,7 @@
 
 
 async def _assert_task_removed(
-    base_client: BaseClient, task_id: TaskId, router_prefix: str
+    base_client: HttpClient, task_id: TaskId, router_prefix: str
 ) -> None:
     with pytest.raises(
         (GenericClientError, TaskNotFoundError), match=f"No task with {task_id} found"
@@ -139,28 +137,10 @@ def mock_task_id() -> TaskId:
     return TypeAdapter(TaskId).validate_python("fake_task_id")
 
 
-@pytest.fixture(params=[RPCClient.__name__, HttpClient.__name__])
-def base_client(
-    request: pytest.FixtureRequest, bg_task_app: FastAPI, async_client: AsyncClient
-) -> BaseClient:
-    match request.param:
-        case RPCClient.__name__:
-            long_running_manager: FastAPILongRunningManager = (
-                bg_task_app.state.long_running_manager
-            )
-            return RPCClient(
-                long_running_manager.rpc_client, long_running_manager.lrt_namespace
-            )
-        case HttpClient.__name__:
-            url = TypeAdapter(AnyHttpUrl).validate_python(
-                "http://backgroud.testserver.io/"
-            )
-            return HttpClient(
-                app=bg_task_app, async_client=async_client, base_url=f"{url}"
-            )
-        case _:
-            msg = f"Client {request.param} not implemented"
-            raise NotImplementedError(msg)
+@pytest.fixture()
+def base_client(bg_task_app: FastAPI, async_client: AsyncClient) -> HttpClient:
+    url = TypeAdapter(AnyHttpUrl).validate_python("http://backgroud.testserver.io/")
+    return HttpClient(app=bg_task_app, async_client=async_client, base_url=f"{url}")
 
 
 async def _create_and_get_taskid(async_client: AsyncClient, *, endpoint: str) -> TaskId:
@@ -172,7 +152,7 @@ async def _create_and_get_taskid(async_client: AsyncClient, *, endpoint: str) ->
 
 async def test_task_result(
     async_client: AsyncClient,
-    base_client: BaseClient,
+    base_client: HttpClient,
     router_prefix: str,
 ) -> None:
     task_id = await _create_and_get_taskid(async_client, endpoint="success")
@@ -190,7 +170,7 @@ async def test_task_result(
 
 async def test_task_result_times_out(
     async_client: AsyncClient,
-    base_client: BaseClient,
+    base_client: HttpClient,
     router_prefix: str,
 ) -> None:
     task_id = await _create_and_get_taskid(async_client, endpoint="success")
@@ -215,7 +195,7 @@ async def test_task_result_times_out(
 async def test_task_result_task_result_is_an_error(
     bg_task_app: FastAPI,
     async_client: AsyncClient,
-    base_client: BaseClient,
+    base_client: HttpClient,
     router_prefix: str,
 ) -> None:
     task_id = await _create_and_get_taskid(async_client, endpoint="failing")