Merge branch 'development' into feat/91-streaming-downloads

Author: adubovik

README.md

@@ -17,6 +17,7 @@
   - [Authentication](#authentication)
       - [API Keys](#api-keys)
       - [Bearer Token](#bearer-token)
+  - [Lifecycle Management](#lifecycle-management)
   - [Deployments](#deployments)
       - [List Deployments](#list-deployments)
       - [Get Deployment by Id](#get-deployment-by-id)
@@ -121,6 +122,45 @@ async_client = AsyncDial(
 )
 ```
 
+### Lifecycle Management
+
+For deterministic shutdown of underlying HTTP clients, both client types and
+client pools expose lifecycle APIs.
+
+```python
+from aidial_client import AsyncDial, AsyncDialClientPool, Dial, DialClientPool
+
+# Sync client
+with Dial(api_key="your_api_key", base_url="https://your-dial-instance.com") as client:
+    ...
+
+client = Dial(api_key="your_api_key", base_url="https://your-dial-instance.com")
+client.close()
+
+# Async client
+async with AsyncDial(
+    api_key="your_api_key", base_url="https://your-dial-instance.com"
+) as async_client:
+    ...
+
+async_client = AsyncDial(
+    api_key="your_api_key", base_url="https://your-dial-instance.com"
+)
+await async_client.aclose()
+
+# Sync pool
+with DialClientPool() as pool:
+    pooled_client = pool.create_client(
+        base_url="https://your-dial-instance.com", api_key="your-api-key"
+    )
+
+# Async pool
+async with AsyncDialClientPool() as async_pool:
+    pooled_async_client = async_pool.create_client(
+        base_url="https://your-dial-instance.com", api_key="your-api-key"
+    )
+```
+
 You can also pass `bearer_token` as a function without parameters, that returns a `string`:
 
 ```python
@@ -945,7 +985,7 @@ second_client = client_pool.create_client(
 #### Asynchronous Client Pool
 
 ```python
-from dial_client import (
+from aidial_client import (
     AsyncDialClientPool,
 )
 

aidial_client/_client.py

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
 from pathlib import PurePosixPath
+from types import TracebackType
 from typing import Generic, TypeVar
 from urllib.parse import urljoin
 
@@ -164,6 +165,20 @@ def my_appdata_home(self) -> PurePosixPath | None:
     def auth_headers(self) -> dict[str, str]:
         return self._http_client.auth_headers()
 
+    def close(self) -> None:
+        self._http_client.internal_http_client.close()
+
+    def __enter__(self) -> "Dial":
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        self.close()
+
 
 class AsyncDial(BaseDialClient[AsyncHTTPClient, AsyncAuthValue]):
     def _init_resources(self) -> None:
@@ -253,3 +268,17 @@ async def my_appdata_home(self) -> PurePosixPath | None:
 
     async def auth_headers(self) -> dict[str, str]:
         return await self._http_client.auth_headers()
+
+    async def aclose(self) -> None:
+        await self._http_client.internal_http_client.aclose()
+
+    async def __aenter__(self) -> "AsyncDial":
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        await self.aclose()

aidial_client/_client_pool.py

@@ -1,3 +1,5 @@
+from types import TracebackType
+
 import httpx
 
 from aidial_client._auth import AsyncAuthValue, SyncAuthValue
@@ -44,6 +46,20 @@ def create_client(
             ),
         )
 
+    def close(self) -> None:
+        self._internal_http_client.close()
+
+    def __enter__(self) -> "DialClientPool":
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        self.close()
+
 
 class AsyncDialClientPool:
     def __init__(
@@ -78,3 +94,17 @@ def create_client(
                 internal_http_client=self._internal_http_client,
             ),
         )
+
+    async def aclose(self) -> None:
+        await self._internal_http_client.aclose()
+
+    async def __aenter__(self) -> "AsyncDialClientPool":
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        await self.aclose()

tests/test_lifecycle.py

@@ -0,0 +1,98 @@
+from unittest.mock import patch
+
+import pytest
+
+from aidial_client import AsyncDialClientPool, Dial, DialClientPool
+from aidial_client._client import AsyncDial
+
+
+def test_dial_close():
+    client = Dial(api_key="dummy", base_url="http://dial.core")
+
+    with patch.object(
+        client._http_client.internal_http_client, "close"
+    ) as close_mock:
+        client.close()
+
+    close_mock.assert_called_once()
+
+
+def test_dial_context_manager():
+    client = Dial(api_key="dummy", base_url="http://dial.core")
+
+    with (
+        patch.object(
+            client._http_client.internal_http_client, "close"
+        ) as close_mock,
+        client as managed_client,
+    ):
+        assert managed_client is client
+
+    close_mock.assert_called_once()
+
+
+@pytest.mark.asyncio
+async def test_async_dial_aclose():
+    client = AsyncDial(api_key="dummy", base_url="http://dial.core")
+
+    with patch.object(
+        client._http_client.internal_http_client, "aclose"
+    ) as aclose_mock:
+        await client.aclose()
+
+    aclose_mock.assert_awaited_once()
+
+
+@pytest.mark.asyncio
+async def test_async_dial_context_manager():
+    client = AsyncDial(api_key="dummy", base_url="http://dial.core")
+
+    with patch.object(
+        client._http_client.internal_http_client, "aclose"
+    ) as aclose_mock:
+        async with client as managed_client:
+            assert managed_client is client
+
+    aclose_mock.assert_awaited_once()
+
+
+def test_dial_client_pool_close():
+    pool = DialClientPool()
+
+    with patch.object(pool._internal_http_client, "close") as close_mock:
+        pool.close()
+
+    close_mock.assert_called_once()
+
+
+def test_dial_client_pool_context_manager():
+    pool = DialClientPool()
+
+    with (
+        patch.object(pool._internal_http_client, "close") as close_mock,
+        pool as managed_pool,
+    ):
+        assert managed_pool is pool
+
+    close_mock.assert_called_once()
+
+
+@pytest.mark.asyncio
+async def test_async_dial_client_pool_aclose():
+    pool = AsyncDialClientPool()
+
+    with patch.object(pool._internal_http_client, "aclose") as aclose_mock:
+        await pool.aclose()
+
+    aclose_mock.assert_awaited_once()
+
+
+@pytest.mark.asyncio
+async def test_async_dial_client_pool_context_manager():
+    pool = AsyncDialClientPool()
+
+    with patch.object(pool._internal_http_client, "aclose") as aclose_mock:
+        async with pool as managed_pool:
+            assert managed_pool is pool
+
+    aclose_mock.assert_awaited_once()