clarity-api-sdk-python 0.3.27__tar.gz → 0.3.29__tar.gz

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.27
+Version: 0.3.29
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
@@ -114,10 +114,10 @@ if __name__ == "__main__":
     asyncio.run(main())
 
 # In other modules
-from cti.api.session import async_client
+from cti.api.session import get_async_client
 
 async def fetch_data():
-    if async_client:
-        response = await async_client.get(...)
-        return response.json()
+    client = get_async_client()
+    response = await client.get(...)
+    return response.json()
 ```

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/README.md

@@ -80,10 +80,10 @@ if __name__ == "__main__":
     asyncio.run(main())
 
 # In other modules
-from cti.api.session import async_client
+from cti.api.session import get_async_client
 
 async def fetch_data():
-    if async_client:
-        response = await async_client.get(...)
-        return response.json()
+    client = get_async_client()
+    response = await client.get(...)
+    return response.json()
 ```

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "clarity-api-sdk-python"
-version = "0.3.27"
+version = "0.3.29"
 authors = [
   { name="Chesapeake Technology Inc.", email="support@chesapeaketech.com" },
 ]

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/src/clarity_api_sdk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarity-api-sdk-python
-Version: 0.3.27
+Version: 0.3.29
 Summary: A Python SDK to connect to the CTI Clarity API server.
 Author-email: "Chesapeake Technology Inc." <support@chesapeaketech.com>
 Project-URL: Homepage, https://github.com/chesapeake-tech/clarity-api-sdk-python
@@ -114,10 +114,10 @@ if __name__ == "__main__":
     asyncio.run(main())
 
 # In other modules
-from cti.api.session import async_client
+from cti.api.session import get_async_client
 
 async def fetch_data():
-    if async_client:
-        response = await async_client.get(...)
-        return response.json()
+    client = get_async_client()
+    response = await client.get(...)
+    return response.json()
 ```

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/src/cti/api/__init__.py

@@ -2,6 +2,6 @@
 
 from .async_client import ClarityApiAsyncClient
 from .client import ClarityApiClient
-from .session import async_client, initialize_async_client, close_async_client
+from .session import get_async_client, initialize_async_client, close_async_client
 from .sonar_wiz_api import SonarWizApi
 from .sonar_wiz_async_api import SonarWizAsyncApi

clarity_api_sdk_python-0.3.29/src/cti/api/session.py

@@ -0,0 +1,122 @@
+"""Provides event loop-scoped async client instances.
+
+This module uses contextvars to ensure each event loop gets its own
+ClarityApiAsyncClient instance, preventing issues when event loops are
+created/destroyed (common in Dask workers).
+
+Example:
+    # Each asyncio.run() gets its own isolated client
+    async def task():
+        await initialize_async_client()
+        client = get_async_client()
+        response = await client.get(...)
+        await close_async_client()  # Optional, cleans up resources
+
+    # Task 1 - creates client in loop 1
+    asyncio.run(task())
+
+    # Task 2 - creates new client in loop 2
+    asyncio.run(task())
+"""
+
+# pylint: disable=unnecessary-dunder-call
+
+import asyncio
+from contextvars import ContextVar
+from typing import Optional
+
+from cti.api.async_client import ClarityApiAsyncClient
+
+# Context-local storage (isolated per event loop)
+# Stores tuple of (client, loop) to track which loop the client was created in
+_async_client_var: ContextVar[
+    Optional[tuple[ClarityApiAsyncClient, asyncio.AbstractEventLoop]]
+] = ContextVar("clarity_async_client", default=None)
+
+
+def _is_client_valid(
+    client_tuple: Optional[tuple[ClarityApiAsyncClient, asyncio.AbstractEventLoop]],
+    current_loop: asyncio.AbstractEventLoop,
+) -> bool:
+    """Check if client is still valid for the current event loop.
+
+    Args:
+        client_tuple: Tuple of (client, loop) from context storage.
+        current_loop: The current event loop to check against.
+
+    Returns:
+        True if client is valid for the current loop, False otherwise.
+    """
+    if client_tuple is None:
+        return False
+
+    _, stored_loop = client_tuple
+
+    try:
+        # Check if stored loop is the same as current loop and not closed
+        return stored_loop is current_loop and not current_loop.is_closed()
+    except Exception:
+        pass
+    return False
+
+
+async def initialize_async_client() -> None:
+    """Initialize async client for the current event loop context.
+
+    Creates a new client instance if:
+    - No client exists in current context, OR
+    - Existing client is bound to a different (closed) event loop
+
+    This function is idempotent within a single event loop.
+    """
+    current_client_tuple = _async_client_var.get()
+    current_loop = asyncio.get_running_loop()
+
+    # Check if we need a new client
+    needs_new_client = not _is_client_valid(current_client_tuple, current_loop)
+
+    if needs_new_client:
+        # Close old client if it exists
+        if current_client_tuple is not None:
+            old_client, _ = current_client_tuple
+            try:
+                await old_client.__aexit__(None, None, None)
+            except Exception:
+                pass  # Best effort cleanup
+
+        # Create new client for this event loop
+        new_client = ClarityApiAsyncClient()
+        await new_client.__aenter__()
+        _async_client_var.set((new_client, current_loop))
+
+
+def get_async_client() -> ClarityApiAsyncClient:
+    """Get the async client for the current context.
+
+    Returns:
+        ClarityApiAsyncClient instance for this event loop.
+
+    Raises:
+        ValueError: If initialize_async_client() hasn't been called in this context.
+    """
+    client_tuple = _async_client_var.get()
+    if client_tuple is None:
+        raise ValueError(
+            "initialize_async_client() must be called first to initialize client."
+        )
+    client, _ = client_tuple
+    return client
+
+
+async def close_async_client() -> None:
+    """Close the async client for the current context.
+
+    This function should be awaited to ensure the underlying connection
+    pool is closed gracefully. Resources are cleaned up for the current
+    event loop context only.
+    """
+    client_tuple = _async_client_var.get()
+    if client_tuple:
+        client, _ = client_tuple
+        await client.__aexit__(None, None, None)
+        _async_client_var.set(None)

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/src/cti/api/sonar_wiz_api.py

@@ -1337,21 +1337,20 @@ class SonarWizApi:
         response.raise_for_status()
         return RawDepth.model_validate(response.json())
 
-    def create_raw_sidescan_ping(self, ping: RawSidescanPingCreate) -> None:
-        """Create a raw sidescan ping record.
+    def create_raw_sidescan_pings(self, pings: list[RawSidescanPingCreate]) -> None:
+        """Create raw sidescan ping records.
 
         Args:
-            ping: Raw sidescan ping creation data.
+            pings: Raw sidescan ping creation data.
         """
         response = self._client.post(
-            "/api/v1/raw-sidescan-pings", json=[ping.model_dump(mode="json")]
+            "/api/v1/raw-sidescan-pings", json=[ping.model_dump(mode="json") for ping in pings]
         )
         response.raise_for_status()
         logger.debug(
-            "raw_sidescan_ping_created",
+            "raw_sidescan_pings_created",
             extra={
-                "sidescan_ping_source_id": str(ping.sidescan_ping_source_id),
-                "ping_number_id": str(ping.ping_number_id),
+                "count": len(pings),
             },
         )
 

{clarity_api_sdk_python-0.3.27 → clarity_api_sdk_python-0.3.29}/src/cti/api/sonar_wiz_async_api.py

@@ -1347,21 +1347,20 @@ class SonarWizAsyncApi:
         response.raise_for_status()
         return RawDepth.model_validate(response.json())
 
-    async def create_raw_sidescan_ping(self, ping: RawSidescanPingCreate) -> None:
-        """Create a raw sidescan ping record.
+    async def create_raw_sidescan_pings(self, pings: list[RawSidescanPingCreate]) -> None:
+        """Create raw sidescan ping records.
 
         Args:
-            ping: Raw sidescan ping creation data.
+            pings: Raw sidescan ping creation data.
         """
         response = await self._client.post(
-            "/api/v1/raw-sidescan-pings", json=[ping.model_dump(mode="json")]
+            "/api/v1/raw-sidescan-pings", json=[ping.model_dump(mode="json") for ping in pings]
         )
         response.raise_for_status()
         logger.debug(
-            "raw_sidescan_ping_created",
+            "raw_sidescan_pings_created",
             extra={
-                "sidescan_ping_source_id": str(ping.sidescan_ping_source_id),
-                "ping_number_id": str(ping.ping_number_id),
+                "count": len(pings),
             },
         )
 

clarity_api_sdk_python-0.3.27/src/cti/api/session.py

@@ -1,76 +0,0 @@
-"""Provides a shared, singleton instance of the ClarityApiAsyncClient.
-
-This module allows for a single, reusable async client to be initialized
-and accessed throughout the application, promoting connection reuse and
-efficiency. The client should be initialized at application startup
-and closed gracefully on shutdown.
-
-Example:
-    # In your main application entry point
-    import asyncio
-    from cti.api.session import initialize_async_client, close_async_client
-
-    async def main():
-        await initialize_async_client()
-        # ... your application logic ...
-        await close_async_client()
-
-    if __name__ == "__main__":
-        asyncio.run(main())
-
-    # In other modules
-    from cti.api.session import get_async_client
-
-    async def fetch_data():
-        response = await get_async_client().get(...)
-        return response.json()
-"""
-
-# pylint: disable=global-statement, unnecessary-dunder-call
-
-from cti.api.async_client import ClarityApiAsyncClient
-
-# The singleton instance, initially None.
-async_client: ClarityApiAsyncClient | None = None
-
-
-async def initialize_async_client() -> None:
-    """Initializes the shared ClarityApiAsyncClient instance.
-
-    If the client is already initialized, this function does nothing.
-    This function should be awaited at application startup.
-    """
-    global async_client
-    if async_client is None:
-        async_client = ClarityApiAsyncClient()
-        await async_client.__aenter__()
-
-
-def get_async_client() -> ClarityApiAsyncClient:
-    """Returns the shared ClarityApiAsyncClient instance.
-
-    If the client is not initialized, this function initializes it first.
-
-    Returns:
-        ClarityApiAsyncClient: The shared ClarityApiAsyncClient instance.
-
-    Raises:
-        ValueError: If initialize_async_client() has not been called first.
-    """
-    if async_client is None:
-        raise ValueError(
-            "initialize_async_client() must be called first to initialize client."
-        )
-    return async_client
-
-
-async def close_async_client() -> None:
-    """Closes the shared ClarityApiAsyncClient instance.
-
-    This function should be awaited at application shutdown to ensure
-    the underlying connection pool is closed gracefully.
-    """
-    global async_client
-    if async_client:
-        await async_client.__aexit__(None, None, None)
-        async_client = None