crypticorn 2.4.6__py3-none-any.whl → 2.4.7__py3-none-any.whl

crypticorn/common/auth.py

@@ -9,7 +9,7 @@ from crypticorn.common import (
     Scope,
     Service,
 )
-from fastapi import Depends, HTTPException, Query, status
+from fastapi import Depends, HTTPException, Query, status, WebSocketException
 from fastapi.security import (
     HTTPAuthorizationCredentials,
     SecurityScopes,
@@ -183,7 +183,7 @@ class AuthHandler:
         Verifies the API key and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the API key.
         """
-        return await self.api_key_auth(api_key=api_key, sec=sec)
+        return await self.ws_combined_auth(bearer=None, api_key=api_key, sec=sec)
 
     async def ws_bearer_auth(
         self,
@@ -194,12 +194,7 @@ class AuthHandler:
         Verifies the bearer token and checks if the user scopes are a subset of the API scopes.
         Use this function if you only want to allow access via the bearer token.
         """
-        credentials = (
-            HTTPAuthorizationCredentials(scheme="Bearer", credentials=bearer)
-            if bearer
-            else None
-        )
-        return await self.bearer_auth(bearer=credentials, sec=sec)
+        return await self.ws_combined_auth(bearer=bearer, api_key=None, sec=sec)
 
     async def ws_combined_auth(
         self,
@@ -216,4 +211,7 @@ class AuthHandler:
             if bearer
             else None
         )
-        return await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+        response = await self.combined_auth(bearer=credentials, api_key=api_key, sec=sec)
+        if isinstance(response, HTTPException):
+            raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION, reason=response.detail)
+        return response

crypticorn/common/errors.py

@@ -100,6 +100,11 @@ class ApiErrorIdentifier(StrEnum):
     UNKNOWN_ERROR = "unknown_error_occurred"
     URL_NOT_FOUND = "requested_resource_not_found"
 
+    @property
+    def get_error_code(self) -> str:
+        """Get the corresponding ApiError."""
+        return ApiError[self.value]
+
 
 class ApiErrorLevel(StrEnum):
     """API error levels"""

crypticorn/common/utils.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Union
 from decimal import Decimal
 import string
 import random
@@ -9,19 +9,19 @@ from fastapi import status
 from crypticorn.common import ApiError
 
 
-def throw_if_none(value: Any, message: ApiError) -> None:
+def throw_if_none(value: Any, message: Union[ApiError, str]) -> None:
     """Throws an FastAPI HTTPException if the value is None."""
     if value is None:
         raise HTTPException(
-            status_code=status.HTTP_404_NOT_FOUND, detail=message.identifier
+            status_code=status.HTTP_404_NOT_FOUND, detail=message.identifier if isinstance(message, ApiError) else message
         )
 
 
-def throw_if_falsy(value: Any, message: ApiError) -> None:
+def throw_if_falsy(value: Any, message: Union[ApiError, str]) -> None:
     """Throws an FastAPI HTTPException if the value is False."""
     if not value:
         raise HTTPException(
-            status_code=status.HTTP_400_BAD_REQUEST, detail=message.identifier
+            status_code=status.HTTP_400_BAD_REQUEST, detail=message.identifier if isinstance(message, ApiError) else message
         )
 
 
@@ -50,3 +50,13 @@ def is_equal(
     return Decimal(abs(a - b)) <= max(
         Decimal(str(rel_tol)) * max(abs(a), abs(b)), Decimal(str(abs_tol))
     )
+
+def optional_import(module_name: str, extra_name: str):
+    try:
+        return __import__(module_name)
+    except ImportError as e:
+        extra = f"[{extra_name}]"
+        raise ImportError(
+            f"Optional dependency '{module_name}' is required for this feature. "
+            f"Install it with: pip install crypticorn{extra}"
+        ) from e

crypticorn/klines/main.py

@@ -1,4 +1,4 @@
-import pandas as pd
+from __future__ import annotations
 from crypticorn.klines import (
     ApiClient,
     Configuration,
@@ -8,6 +8,7 @@ from crypticorn.klines import (
     SymbolsApi,
     UDFApi,
 )
+from crypticorn.common import optional_import
 
 
 class FundingRatesApiWrapper(FundingRatesApi):
@@ -15,7 +16,8 @@ class FundingRatesApiWrapper(FundingRatesApi):
     A wrapper for the FundingRatesApi class.
     """
 
-    def get_funding_rates_fmt(self):
+    def get_funding_rates_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.funding_rate_funding_rates_symbol_get()
         return pd.DataFrame(response.json())
 
@@ -25,7 +27,8 @@ class OHLCVDataApiWrapper(OHLCVDataApi):
     A wrapper for the OHLCVDataApi class.
     """
 
-    def get_ohlcv_data_fmt(self):
+    def get_ohlcv_data_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.get_ohlcv_market_timeframe_symbol_get()
         return pd.DataFrame(response.json())
 
@@ -35,7 +38,8 @@ class SymbolsApiWrapper(SymbolsApi):
     A wrapper for the SymbolsApi class.
     """
 
-    def get_symbols_fmt(self):
+    def get_symbols_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.symbols_symbols_market_get()
         return pd.DataFrame(response.json())
 
@@ -45,7 +49,8 @@ class UDFApiWrapper(UDFApi):
     A wrapper for the UDFApi class.
     """
 
-    def get_udf_fmt(self):
+    def get_udf_fmt(self) -> pd.DataFrame:
+        pd = optional_import("pandas", "extra")
         response = self.get_history_udf_history_get()
         return pd.DataFrame(response.json())
 

crypticorn/metrics/main.py

@@ -1,3 +1,4 @@
+from __future__ import annotations
 from crypticorn.metrics import (
     ApiClient,
     Configuration,
@@ -10,13 +11,11 @@ from crypticorn.metrics import (
     TokensApi,
     MarketType,
 )
+from crypticorn.common import optional_import
 from pydantic import StrictStr, StrictInt, Field
 from typing_extensions import Annotated
 from typing import Optional
 
-import pandas as pd
-
-
 class MetricsClient:
     """
     A client for interacting with the Crypticorn Metrics API.
@@ -67,7 +66,8 @@ class MarketcapApiWrapper(MarketcapApi):
         """
         Get the marketcap symbols in a pandas dataframe
         """
-        response = await self.get_marketcap_symbols_without_preload_content(
+        pd = optional_import("pandas", "extra")
+        response = await self.get_marketcap_symbols(
             start_timestamp=start_timestamp,
             end_timestamp=end_timestamp,
             interval=interval,
@@ -96,6 +96,7 @@ class TokensApiWrapper(TokensApi):
         """
         Get the tokens in a pandas dataframe
         """
+        pd = optional_import("pandas", "extra")
         response = await self.get_stable_and_wrapped_tokens_without_preload_content(
             token_type=token_type
         )

crypticorn/trade/client/__init__.py

@@ -3,14 +3,14 @@
 # flake8: noqa
 
 """
-Trading API
+    Trading API
 
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 0.1.0
-Generated by OpenAPI Generator (https://openapi-generator.tech)
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-Do not edit the class manually.
+    Do not edit the class manually.
 """  # noqa: E501
 
 
@@ -63,6 +63,4 @@ from crypticorn.trade.client.models.strategy_model_output import StrategyModelOu
 from crypticorn.trade.client.models.tpsl import TPSL
 from crypticorn.trade.client.models.trading_action_type import TradingActionType
 from crypticorn.trade.client.models.validation_error import ValidationError
-from crypticorn.trade.client.models.validation_error_loc_inner import (
-    ValidationErrorLocInner,
-)
+from crypticorn.trade.client.models.validation_error_loc_inner import ValidationErrorLocInner

crypticorn/trade/client/api/__init__.py

@@ -10,3 +10,4 @@ from crypticorn.trade.client.api.orders_api import OrdersApi
 from crypticorn.trade.client.api.status_api import StatusApi
 from crypticorn.trade.client.api.strategies_api import StrategiesApi
 from crypticorn.trade.client.api.trading_actions_api import TradingActionsApi
+