aidial-client 0.11.0.dev3__tar.gz → 0.11.0.dev6__tar.gz

{aidial_client-0.11.0.dev3 → aidial_client-0.11.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.11.0.dev3
+Version: 0.11.0.dev6
 Summary: A Python client library for the AI DIAL API
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -39,6 +39,7 @@ Description-Content-Type: text/markdown
   - [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)
@@ -143,6 +144,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
@@ -530,6 +570,13 @@ all_content = result.get_content()
 all_content = await result.aget_content()
 ```
 
+or access response metadata:
+
+```python
+headers = result.headers
+content_type = result.content_type
+```
+
 or write it to the file:
 
 ```python
@@ -950,7 +997,7 @@ second_client = client_pool.create_client(
 #### Asynchronous Client Pool
 
 ```python
-from dial_client import (
+from aidial_client import (
     AsyncDialClientPool,
 )
 

{aidial_client-0.11.0.dev3 → aidial_client-0.11.0.dev6}/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
@@ -508,6 +548,13 @@ all_content = result.get_content()
 all_content = await result.aget_content()
 ```
 
+or access response metadata:
+
+```python
+headers = result.headers
+content_type = result.content_type
+```
+
 or write it to the file:
 
 ```python
@@ -928,7 +975,7 @@ second_client = client_pool.create_client(
 #### Asynchronous Client Pool
 
 ```python
-from dial_client import (
+from aidial_client import (
     AsyncDialClientPool,
 )
 

{aidial_client-0.11.0.dev3 → aidial_client-0.11.0.dev6}/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 @@ class Dial(BaseDialClient[SyncHTTPClient, SyncAuthValue]):
     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 @@ class AsyncDial(BaseDialClient[AsyncHTTPClient, AsyncAuthValue]):
 
     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-0.11.0.dev3 → aidial_client-0.11.0.dev6}/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 @@ class DialClientPool:
             ),
         )
 
+    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 @@ class AsyncDialClientPool:
                 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()

{aidial_client-0.11.0.dev3 → aidial_client-0.11.0.dev6}/aidial_client/types/file.py

@@ -40,3 +40,11 @@ class FileDownloadResponse:
     @property
     def filename(self) -> str:
         return self._filename
+
+    @property
+    def headers(self) -> httpx.Headers:
+        return self._response.headers
+
+    @property
+    def content_type(self) -> str | None:
+        return self.headers.get("content-type")

{aidial_client-0.11.0.dev3 → aidial_client-0.11.0.dev6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aidial-client"
-version = "0.11.0.dev3"
+version = "0.11.0.dev6"
 description = "A Python client library for the AI DIAL API"
 readme = "README.md"
 license = "Apache-2.0"