crypticorn 2.5.0rc1__py3-none-any.whl → 2.5.0rc3__py3-none-any.whl

crypticorn/common/errors.py

@@ -63,6 +63,8 @@ class ApiErrorIdentifier(StrEnum):
     INSUFFICIENT_SCOPES = "insufficient_scopes"
     INVALID_API_KEY = "invalid_api_key"
     INVALID_BEARER = "invalid_bearer"
+    INVALID_DATA_REQUEST = "invalid_data"
+    INVALID_DATA_RESPONSE = "invalid_data_response"
     INVALID_EXCHANGE_KEY = "invalid_exchange_key"
     INVALID_MARGIN_MODE = "invalid_margin_mode"
     INVALID_PARAMETER = "invalid_parameter_provided"
@@ -263,6 +265,16 @@ class ApiError(Enum, metaclass=Fallback):
         ApiErrorType.USER_ERROR,
         ApiErrorLevel.ERROR,
     )
+    INVALID_DATA_REQUEST = (
+        ApiErrorIdentifier.INVALID_DATA_REQUEST,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
+    INVALID_DATA_RESPONSE = (
+        ApiErrorIdentifier.INVALID_DATA_RESPONSE,
+        ApiErrorType.USER_ERROR,
+        ApiErrorLevel.ERROR,
+    )
     INVALID_EXCHANGE_KEY = (
         ApiErrorIdentifier.INVALID_EXCHANGE_KEY,
         ApiErrorType.SERVER_ERROR,
@@ -489,6 +501,8 @@ class HttpStatusMapper:
         ApiError.BOT_ALREADY_DELETED: status.HTTP_409_CONFLICT,
         # Invalid Content
         ApiError.CONTENT_TYPE_ERROR: status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
+        ApiError.INVALID_DATA_REQUEST: status.HTTP_422_UNPROCESSABLE_ENTITY,
+        ApiError.INVALID_DATA_RESPONSE: status.HTTP_422_UNPROCESSABLE_ENTITY,
         # Rate Limits
         ApiError.EXCHANGE_RATE_LIMIT: status.HTTP_429_TOO_MANY_REQUESTS,
         ApiError.REQUEST_SCOPE_EXCEEDED: status.HTTP_429_TOO_MANY_REQUESTS,

crypticorn/common/exceptions.py

@@ -1,33 +1,80 @@
-from typing import Optional, Dict
-from pydantic import BaseModel
-from fastapi import HTTPException as FastAPIHTTPException
-from crypticorn.common import ApiError
+from enum import Enum
+from typing import Optional, Dict, Type
+from pydantic import BaseModel, Field
+from fastapi import HTTPException as FastAPIHTTPException, Request, FastAPI
+from fastapi.exceptions import RequestValidationError, ResponseValidationError
+from fastapi.openapi.utils import get_openapi
+from fastapi.responses import JSONResponse
+from crypticorn.common import ApiError, ApiErrorIdentifier, ApiErrorType, ApiErrorLevel
+
+class EnrichedDetail(BaseModel):
+    '''This is the detail of the exception. It is used to enrich the exception with additional information by unwrapping the ApiError into its components.'''
+    message: Optional[str] = Field(None, description="An additional error message")
+    code: ApiErrorIdentifier = Field(..., description="The unique error code")
+    type: ApiErrorType = Field(..., description="The type of error")
+    level: ApiErrorLevel = Field(..., description="The level of the error")
+    status_code: int = Field(..., description="The HTTP status code")
 
 
 class ExceptionDetail(BaseModel):
-    message: str
-    error: ApiError
+    '''This is the detail of the exception. Pass an ApiError to the constructor and an optional human readable message.'''
+    error: ApiError = Field(..., description="The unique error code")
+    message: Optional[str] = Field(None, description="An additional error message")
 
+    def enrich(self) -> EnrichedDetail:
+        return EnrichedDetail(
+            message=self.message,
+            code=self.error.identifier,
+            type=self.error.type,
+            level=self.error.level,
+            status_code=self.error.status_code,
+        )
 
 class HTTPException(FastAPIHTTPException):
+    """A custom HTTP exception wrapper around FastAPI's HTTPException.
+    It allows for a more structured way to handle errors, with a message and an error code. The status code is being derived from the detail's error.
+        The ApiError class is the source of truth for everything. If the error is not yet implemented, there are fallbacks to avoid errors while testing.
+    """
+
     def __init__(
         self,
-        status_code: int,
-        detail: ExceptionDetail | str,
+        detail: ExceptionDetail,
         headers: Optional[Dict[str, str]] = None,
     ):
-        try:
-            exc = (
-                ExceptionDetail(**detail)
-                if not isinstance(detail, ExceptionDetail)
-                else detail
-            )
-        except Exception as e:
-            exc = ExceptionDetail(
-                message=detail,
-                error=ApiError.UNKNOWN_ERROR,
-            )
-
+        assert isinstance(detail, ExceptionDetail)
+        body = detail.enrich()
         super().__init__(
-            status_code=status_code, detail=exc.model_dump(), headers=headers
+            status_code=body.status_code,
+            detail=body.model_dump(mode="json"),
+            headers=headers,
         )
+
+async def general_handler(request: Request, exc: Exception):
+    '''This is the default exception handler for all exceptions.'''
+    body = ExceptionDetail(message=str(exc), error=ApiError.UNKNOWN_ERROR)
+    return JSONResponse(status_code=body.error.status_code, content=HTTPException(detail=body).detail)
+
+async def request_validation_handler(request: Request, exc: RequestValidationError):
+    '''This is the exception handler for all request validation errors.'''
+    body = ExceptionDetail(message=str(exc), error=ApiError.INVALID_DATA_REQUEST)
+    return JSONResponse(status_code=body.error.status_code, content=HTTPException(detail=body).detail)
+
+async def response_validation_handler(request: Request, exc: ResponseValidationError):
+    '''This is the exception handler for all response validation errors.'''
+    body = ExceptionDetail(message=str(exc), error=ApiError.INVALID_DATA_RESPONSE)
+    return JSONResponse(status_code=body.error.status_code, content=HTTPException(detail=body).detail)
+
+async def http_handler(request: Request, exc: HTTPException):
+    '''This is the exception handler for HTTPExceptions. It unwraps the HTTPException and returns the detail in a flat JSON response.'''
+    return JSONResponse(status_code=exc.status_code, content=exc.detail)
+
+def register_exception_handlers(app: FastAPI):
+    '''Utility to register serveral exception handlers in one go. Catches Exception, HTTPException and Data Validation errors and responds with a unified json body.'''
+    app.add_exception_handler(Exception, general_handler)
+    app.add_exception_handler(FastAPIHTTPException, http_handler)
+    app.add_exception_handler(RequestValidationError, request_validation_handler)
+    app.add_exception_handler(ResponseValidationError, response_validation_handler)
+
+exception_response = {
+    "default": {"model": EnrichedDetail, "description": "Error response", "media_type": "application/txt"}
+}

crypticorn/common/utils.py

@@ -35,7 +35,7 @@ def gen_random_id(length: int = 20) -> str:
     return "".join(random.choice(charset) for _ in range(length))
 
 
-@deprecated(reason="Use math.isclose instead. Will be removed in a future version.")
+@deprecated("Use math.isclose instead. Will be removed in a future version.")
 def is_equal(
     a: float | Decimal,
     b: float | Decimal,

{crypticorn-2.5.0rc1.dist-info → crypticorn-2.5.0rc3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.5.0rc1
+Version: 2.5.0rc3
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com

{crypticorn-2.5.0rc1.dist-info → crypticorn-2.5.0rc3.dist-info}/RECORD

@@ -62,13 +62,13 @@ crypticorn/cli/templates/auth.py,sha256=Q1TxlA7qzhjvrqp1xz1aV2vGnj3DKFNN-VSl3o0B
 crypticorn/common/__init__.py,sha256=ZR6znFCEMAJH-FuSMga0KaTpAXj3tl9Xz_4Xi820l9w,312
 crypticorn/common/auth.py,sha256=q5DwgoIzveGWXCHpGl4xMPEABsjufptTqsR92MsOi6M,7618
 crypticorn/common/enums.py,sha256=6cCwQZVdXUoN33WA8kSf4LeSZyExZcWO2ahSsgGddCs,1243
-crypticorn/common/errors.py,sha256=LyX32A8Bgl20DrQmeUOPYYp1KIj4uRjvha4VyTFZm0A,20102
-crypticorn/common/exceptions.py,sha256=lSJojYl8DiK4YJbxYGOsisJdl8WTWnxqO0ed97BsoB8,883
+crypticorn/common/errors.py,sha256=sRlcNe84sJxU2ujikhjSG7eJ9GdOqOo5uv7duYDATBo,20645
+crypticorn/common/exceptions.py,sha256=_KfHjEhqEx44eJeELvmXFMnCT8wWLJkj9LQj8ePJybQ,4292
 crypticorn/common/pydantic.py,sha256=pmnGYCIrLv59wZkDbvPyK9NJmgPJWW74LXTdIWSjOkY,1063
 crypticorn/common/scopes.py,sha256=MgH9sGodJfPjEqVtFsaczNmwEaGL2wuGzeTpga_ehXs,2407
 crypticorn/common/sorter.py,sha256=keRRp4u7KJk3nS2A8tMdSF8Hbc1jcsre8KdTVuetfGc,1278
 crypticorn/common/urls.py,sha256=X557WaODUqW2dECi-mOjTbmhkSpnp40fPXDdvlnBXfo,805
-crypticorn/common/utils.py,sha256=oB9rYfy4TeYWafItACI4x8QH1R2lT2p6HSoK1eRnQrM,2092
+crypticorn/common/utils.py,sha256=crH8_p_HpuWSaH9zsxwyGRaBjgZV_5Msm6lfW028MWs,2085
 crypticorn/hive/__init__.py,sha256=hRfTlEzEql4msytdUC_04vfaHzVKG5CGZle1M-9QFgY,81
 crypticorn/hive/main.py,sha256=U4wurkxnKai2i7iiq049ah9nVzBxmexRxBdFIWfd9qE,631
 crypticorn/hive/client/__init__.py,sha256=b4XBX-fBb0vVHY6323ADasKFSbL66UDeUi0aV3-aNj8,2376
@@ -283,8 +283,8 @@ crypticorn/trade/client/models/tpsl.py,sha256=LlqzHaSA-HgQp1k4PhRckmxWNhgVZU6NgB
 crypticorn/trade/client/models/trading_action_type.py,sha256=oLVDp94VeC9kjYbgZN7dHn2t07YGGUrAkNr2PE435eM,827
 crypticorn/trade/client/models/validation_error.py,sha256=x4rR325juK4EJiFJ8l5IKp2werY8y6PWbLx_WJMxbbA,3208
 crypticorn/trade/client/models/validation_error_loc_inner.py,sha256=ZB2NbHkxhjDZ2-qK1HyvzTUnabeCdxeTjbSAHNmWq5A,5111
-crypticorn-2.5.0rc1.dist-info/METADATA,sha256=jaLSSOGCOkdJDTjosuOox9fpd55KSH_a8RrwQYHYIzE,6210
-crypticorn-2.5.0rc1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-crypticorn-2.5.0rc1.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
-crypticorn-2.5.0rc1.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.5.0rc1.dist-info/RECORD,,
+crypticorn-2.5.0rc3.dist-info/METADATA,sha256=Efy7jNBKex8LUfaKHSGg9GLixf-EDUZg6T_8eP6Xzpg,6210
+crypticorn-2.5.0rc3.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+crypticorn-2.5.0rc3.dist-info/entry_points.txt,sha256=d_xHsGvUTebPveVUK0SrpDFQ5ZRSjlI7lNCc11sn2PM,59
+crypticorn-2.5.0rc3.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
+crypticorn-2.5.0rc3.dist-info/RECORD,,