crypticorn 2.13.2__tar.gz → 2.14.0__tar.gz

{crypticorn-2.13.2 → crypticorn-2.14.0}/CHANGELOG.md

@@ -1,6 +1,32 @@
 # CHANGELOG
 
 
+## v2.14.0 (2025-05-26)
+
+### Bug Fixes
+
+- Fixes error code value
+  ([`182d4d7`](https://github.com/crypticorn-ai/api-client/commit/182d4d7a92289b66914816a90e707739dba4af1c))
+
+### Continuous Integration
+
+- Cleanup on failure in release step
+  ([`dff5ee4`](https://github.com/crypticorn-ai/api-client/commit/dff5ee4b25832ed8b6944213325e7a6d658a2491))
+
+### Features
+
+- Allow custom http client injection
+  ([`1a4cd0c`](https://github.com/crypticorn-ai/api-client/commit/1a4cd0cdd68d39a950f547d22721409e022c896a))
+
+
+## v2.13.3 (2025-05-26)
+
+### Bug Fixes
+
+- Fixes logging import error
+  ([`5df42ef`](https://github.com/crypticorn-ai/api-client/commit/5df42ef9835a397ed6162dcb1c1ad4ab67badd4e))
+
+
 ## v2.13.2 (2025-05-26)
 
 ### Bug Fixes

{crypticorn-2.13.2/crypticorn.egg-info → crypticorn-2.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.13.2
+Version: 2.14.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT
@@ -207,19 +207,27 @@ async with ApiClient() as client:
 
 ### Session Management
 
-By default `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers. You can pass your own configured `aiohttp.ClientSession` for advanced use cases (for custom retry, logging, or mocking):
+By default, `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers.  
+However, you can pass your own pre-configured `aiohttp.ClientSession` if you need advanced control — for example, to add retries, custom headers, logging, or mocking behavior.
+
+When you inject a custom session, you are responsible for managing its lifecycle, including closing when you're done.
 
 ```python
 import aiohttp
 from crypticorn import ApiClient
 
-custom_http_client = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=10), headers={"X-Test": "1"})
-api = ApiClient(api_key="your-key")
-api._http_client = custom_http_client
-
-for service in api._services.values():
-    service.base_client.rest_client.pool_manager = custom_http_client
-```
+async def main():
+    custom_session = aiohttp.ClientSession()
+    async with ApiClient(api_key="your-key", http_client=custom_session) as client:
+        await client.trade.status.ping()
+    await custom_session.close()
+    # or
+    custom_session = aiohttp.ClientSession()
+    client = ApiClient(api_key="your-key", http_client=custom_session)
+    await client.trade.status.ping()
+    await custom_session.close()
+```
+If you don’t pass a session, `ApiClient` will create and manage one internally. In that case, it will be automatically closed when using `async with` or when calling `await client.close()` manually.
 
 ### Disable Logging
 

{crypticorn-2.13.2 → crypticorn-2.14.0}/README.md

@@ -152,19 +152,27 @@ async with ApiClient() as client:
 
 ### Session Management
 
-By default `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers. You can pass your own configured `aiohttp.ClientSession` for advanced use cases (for custom retry, logging, or mocking):
+By default, `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers.  
+However, you can pass your own pre-configured `aiohttp.ClientSession` if you need advanced control — for example, to add retries, custom headers, logging, or mocking behavior.
+
+When you inject a custom session, you are responsible for managing its lifecycle, including closing when you're done.
 
 ```python
 import aiohttp
 from crypticorn import ApiClient
 
-custom_http_client = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=10), headers={"X-Test": "1"})
-api = ApiClient(api_key="your-key")
-api._http_client = custom_http_client
-
-for service in api._services.values():
-    service.base_client.rest_client.pool_manager = custom_http_client
-```
+async def main():
+    custom_session = aiohttp.ClientSession()
+    async with ApiClient(api_key="your-key", http_client=custom_session) as client:
+        await client.trade.status.ping()
+    await custom_session.close()
+    # or
+    custom_session = aiohttp.ClientSession()
+    client = ApiClient(api_key="your-key", http_client=custom_session)
+    await client.trade.status.ping()
+    await custom_session.close()
+```
+If you don’t pass a session, `ApiClient` will create and manage one internally. In that case, it will be automatically closed when using `async with` or when calling `await client.close()` manually.
 
 ### Disable Logging
 

{crypticorn-2.13.2 → crypticorn-2.14.0}/crypticorn/client.py

@@ -24,6 +24,8 @@ class ApiClient:
         api_key: Optional[str] = None,
         jwt: Optional[str] = None,
         base_url: BaseUrl = BaseUrl.PROD,
+        *,
+        http_client: Optional[ClientSession] = None,
     ):
         self.base_url = base_url
         """The base URL the client will use to connect to the API."""
@@ -34,13 +36,8 @@ class ApiClient:
         self.version = version("crypticorn")
         """The version of the client."""
 
-        # self._http_client = ClientSession(
-        #     timeout=ClientTimeout(total=30.0),
-        #     connector=TCPConnector(limit=100, limit_per_host=20),
-        #     headers={"User-Agent": f"crypticorn/python/{self.version}"},
-        # )
-        self._http_client = None # temporary fix for the issue with the event loop
-
+        self._http_client = http_client
+        self._owns_http_client = http_client is None # whether we own the http client
         self._service_classes: dict[Service, type[SubClient]] = {
             Service.HIVE: HiveClient,
             Service.TRADE: TradeClient,
@@ -99,9 +96,28 @@ class ApiClient:
         return self._services[Service.AUTH]
 
     async def close(self):
+        # close each in sync
         for service in self._services.values():
-            if hasattr(service.base_client, "close"):
+            if hasattr(service.base_client, "close") and self._owns_http_client:
                 await service.base_client.close()
+        # close shared in async
+        if self._http_client and self._owns_http_client:
+            await self._http_client.close()
+            self._http_client = None
+
+    async def _ensure_session(self) -> None:
+        """
+        Lazily create the shared HTTP client when first needed and pass it to all subclients.
+        """
+        if self._http_client is None:
+            self._http_client = ClientSession(
+                timeout=ClientTimeout(total=30.0),
+                connector=TCPConnector(limit=100, limit_per_host=20),
+                headers={"User-Agent": f"crypticorn/python/{self.version}"},
+            )
+            for service in self._services.values():
+                if hasattr(service, 'base_client') and hasattr(service.base_client, 'rest_client'):
+                    service.base_client.rest_client.pool_manager = self._http_client
 
     def _get_default_config(self, service, version=None):
         if version is None:
@@ -137,6 +153,7 @@ class ApiClient:
         )
 
     async def __aenter__(self):
+        await self._ensure_session()
         return self
 
     async def __aexit__(self, exc_type, exc_val, exc_tb):

{crypticorn-2.13.2 → crypticorn-2.14.0}/crypticorn/common/errors.py

@@ -63,7 +63,7 @@ class ApiErrorIdentifier(StrEnum):
     EXCHANGE_USER_FROZEN = "exchange_user_account_is_frozen"
     EXPIRED_API_KEY = "api_key_expired"
     EXPIRED_BEARER = "bearer_token_expired"
-    FAILED_OPEN_ORDER = "open_order_expired"
+    FAILED_OPEN_ORDER = "failed_open_order"
     FORBIDDEN = "forbidden"
     HEDGE_MODE_NOT_ACTIVE = "hedge_mode_not_active"
     INSUFFICIENT_BALANCE = "insufficient_balance"

{crypticorn-2.13.2 → crypticorn-2.14.0}/crypticorn/common/logging.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+from logging.handlers import RotatingFileHandler
 import sys
 from crypticorn.common.mixins import ValidateEnumMixin
 from crypticorn.common.ansi_colors import AnsiColors as C
@@ -109,7 +110,7 @@ def configure_logging(
     # Configure file handler
     if log_file:
         os.makedirs(os.path.dirname(log_file), exist_ok=True)
-        file_handler = logging.handlers.RotatingFileHandler(
+        file_handler = RotatingFileHandler(
             log_file, maxBytes=10 * 1024 * 1024, backupCount=5
         )
         file_handler.setLevel(file_level)

{crypticorn-2.13.2 → crypticorn-2.14.0}/crypticorn/trade/main.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 from crypticorn.trade import (
     ApiClient,
     APIKeysApi,

{crypticorn-2.13.2 → crypticorn-2.14.0/crypticorn.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.13.2
+Version: 2.14.0
 Summary: Maximise Your Crypto Trading Profits with Machine Learning
 Author-email: Crypticorn <timon@crypticorn.com>
 License-Expression: MIT
@@ -207,19 +207,27 @@ async with ApiClient() as client:
 
 ### Session Management
 
-By default `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers. You can pass your own configured `aiohttp.ClientSession` for advanced use cases (for custom retry, logging, or mocking):
+By default, `ApiClient` manages a single shared `aiohttp.ClientSession` for all service wrappers.  
+However, you can pass your own pre-configured `aiohttp.ClientSession` if you need advanced control — for example, to add retries, custom headers, logging, or mocking behavior.
+
+When you inject a custom session, you are responsible for managing its lifecycle, including closing when you're done.
 
 ```python
 import aiohttp
 from crypticorn import ApiClient
 
-custom_http_client = aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=10), headers={"X-Test": "1"})
-api = ApiClient(api_key="your-key")
-api._http_client = custom_http_client
-
-for service in api._services.values():
-    service.base_client.rest_client.pool_manager = custom_http_client
-```
+async def main():
+    custom_session = aiohttp.ClientSession()
+    async with ApiClient(api_key="your-key", http_client=custom_session) as client:
+        await client.trade.status.ping()
+    await custom_session.close()
+    # or
+    custom_session = aiohttp.ClientSession()
+    client = ApiClient(api_key="your-key", http_client=custom_session)
+    await client.trade.status.ping()
+    await custom_session.close()
+```
+If you don’t pass a session, `ApiClient` will create and manage one internally. In that case, it will be automatically closed when using `async with` or when calling `await client.close()` manually.
 
 ### Disable Logging
 

{crypticorn-2.13.2 → crypticorn-2.14.0}/crypticorn.egg-info/SOURCES.txt

@@ -299,9 +299,8 @@ static/logo.svg
 static/pip-structure.drawio
 static/pip-structure.svg
 tests/test_auth_client.py
-tests/test_basic_client.py
 tests/test_config.py
+tests/test_custom_session.py
 tests/test_enums.py
 tests/test_errors.py
-tests/test_pagination.py
-tests/test_shared_aiohttp_client.py
+tests/test_pagination.py

{crypticorn-2.13.2 → crypticorn-2.14.0}/pyproject.toml

@@ -5,7 +5,7 @@ readme = "README.md"
 license = "MIT"
 requires-python = ">=3.9"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.13.2"
+version = "2.14.0"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 

crypticorn-2.14.0/tests/test_custom_session.py

@@ -0,0 +1,113 @@
+import gc
+import warnings
+import pytest
+import asyncio
+from aiohttp import ClientSession
+from crypticorn.client import ApiClient, Service  # Adjust import to your path
+
+
+@pytest.mark.asyncio
+async def test_custom_http_client_injection():
+    custom_session = ClientSession()
+
+    client = ApiClient(http_client=custom_session)
+
+    # Subclients should have received the custom session immediately (sync context)
+    for service in Service:
+        subclient = client._services[service]
+        assert subclient.base_client.rest_client.pool_manager is custom_session
+
+    await client.close()
+    assert not custom_session.closed  # Client did not own it
+
+    await custom_session.close()
+
+
+@pytest.mark.asyncio
+async def test_lazy_http_client_creation():
+    client = ApiClient()
+    assert client._http_client is None
+
+    await client._ensure_session()
+
+    assert isinstance(client._http_client, ClientSession)
+    for service in Service:
+        subclient = client._services[service]
+        assert subclient.base_client.rest_client.pool_manager is client._http_client
+
+    await client.close()
+    assert client._http_client is None  # It should have been closed
+
+
+@pytest.mark.asyncio
+async def test_close_custom_http_client_not_owned():
+    custom_session = ClientSession()
+    client = ApiClient(http_client=custom_session)
+
+    await client.close()
+    assert not custom_session.closed  # Still open since it wasn't owned by us
+
+    await custom_session.close()
+
+
+@pytest.mark.asyncio
+async def test_close_owned_http_client():
+    client = ApiClient()
+    await client._ensure_session()
+    session = client._http_client
+
+    await client.close()
+    assert session.closed # session should be closed since we own it
+
+@pytest.mark.asyncio
+async def test_unclosed_owned_session_warns():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")  # Catch all warnings
+
+        client = ApiClient()
+        await client.trade.status.ping()
+
+        # Intentionally forget to close
+        del client
+        await asyncio.sleep(0.1)  # Let __del__ run
+
+        # Look for aiohttp's unclosed session warning
+        unclosed_warnings = [
+            warn for warn in w if "Unclosed client session" in str(warn.message)
+        ]
+        assert unclosed_warnings, "Expected unclosed client session warning"
+
+@pytest.mark.asyncio
+async def test_custom_session_not_closed_by_client():
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        custom_session = ClientSession()
+        client = ApiClient(http_client=custom_session)
+        await client.trade.status.ping()
+
+        # Don't close the custom session
+        del client
+        del custom_session
+
+        # Force cleanup (otherwise it's unpredicatable when the warning will be raised)
+        await asyncio.sleep(0.1)
+        gc.collect()
+        await asyncio.sleep(0.1)
+
+        unclosed_warnings = [
+            warn for warn in w 
+            if "Unclosed client session" in str(warn.message) or 
+               "Unclosed connector" in str(warn.message)
+        ]
+        assert unclosed_warnings, "Expected unclosed client session warning"
+
+@pytest.mark.asyncio
+async def test_context_manager_usage():
+    async with ApiClient() as client:
+        assert isinstance(client._http_client, ClientSession)
+        for service in Service:
+            subclient = client._services[service]
+            assert subclient.base_client.rest_client.pool_manager is client._http_client
+
+    # Confirm session is closed after context manager
+    assert client._http_client is None

crypticorn-2.13.2/tests/test_basic_client.py

@@ -1,41 +0,0 @@
-import pytest
-import aiohttp
-from crypticorn import ApiClient
-
-
-@pytest.mark.asyncio
-@pytest.mark.skip(reason="temporary fix for the issue with the event loop")
-async def test_api_client_creation():
-    api = ApiClient(api_key="test", jwt="test", base_url="http://localhost:8000")
-
-    assert isinstance(api._http_client, aiohttp.ClientSession)
-
-    for service_name, service in api._services.items():
-        assert hasattr(service, "base_client")
-        assert hasattr(service.base_client, "rest_client")
-        assert service.base_client.rest_client.pool_manager is api._http_client
-
-    await api.close()
-
-
-@pytest.mark.asyncio
-@pytest.mark.skip(reason="temporary fix for the issue with the event loop")
-async def test_custom_http_client():
-    custom_session = aiohttp.ClientSession()
-    custom_session.is_custom = True  # Add a marker
-
-    api = ApiClient(api_key="test", jwt="test", base_url="http://localhost:8000")
-    api._http_client = custom_session
-
-    for service_name, service in api._services.items():
-        service.base_client.rest_client.pool_manager = custom_session
-
-    assert api._http_client is custom_session
-    assert hasattr(api._http_client, "is_custom")
-
-    for service_name, service in api._services.items():
-        assert service.base_client.rest_client.pool_manager is custom_session
-        assert hasattr(service.base_client.rest_client.pool_manager, "is_custom")
-
-    await api.close()
-    await custom_session.close()

crypticorn-2.13.2/tests/test_shared_aiohttp_client.py

@@ -1,29 +0,0 @@
-import pytest
-import aiohttp
-from crypticorn import ApiClient
-from crypticorn.common import Service
-
-
-class DummyClientSession(aiohttp.ClientSession):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.is_dummy = True
-
-
-@pytest.mark.skip(reason="temporary fix for the issue with the event loop")
-@pytest.mark.asyncio
-async def test_shared_aiohttp_client_across_services():
-    dummy_client = DummyClientSession()
-    api = ApiClient(api_key="test", jwt="test", base_url="http://localhost:8000")
-    api._http_client = dummy_client
-    for service in api._services.values():
-        service.base_client.rest_client.pool_manager = dummy_client
-    assert api._http_client is dummy_client
-    assert api.hive.base_client.rest_client.pool_manager is dummy_client
-    assert api.trade.base_client.rest_client.pool_manager is dummy_client
-    assert api.klines.base_client.rest_client.pool_manager is dummy_client
-    assert api.pay.base_client.rest_client.pool_manager is dummy_client
-    assert api.metrics.base_client.rest_client.pool_manager is dummy_client
-    assert api.auth.base_client.rest_client.pool_manager is dummy_client
-    await api.close()
-    await dummy_client.close()