crypticorn 2.5.0rc2__tar.gz → 2.5.0rc3__tar.gz

{crypticorn-2.5.0rc2 → crypticorn-2.5.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.5.0rc2
+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.0rc2 → crypticorn-2.5.0rc3}/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-2.5.0rc3/crypticorn/common/exceptions.py

@@ -0,0 +1,80 @@
+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):
+    '''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,
+        detail: ExceptionDetail,
+        headers: Optional[Dict[str, str]] = None,
+    ):
+        assert isinstance(detail, ExceptionDetail)
+        body = detail.enrich()
+        super().__init__(
+            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-2.5.0rc2 → crypticorn-2.5.0rc3}/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.0rc2 → crypticorn-2.5.0rc3}/crypticorn.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.5.0rc2
+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.0rc2 → crypticorn-2.5.0rc3}/pyproject.toml

@@ -4,7 +4,7 @@ description = "Maximise Your Crypto Trading Profits with AI Predictions"
 readme = "README.md"
 requires-python = ">=3.10"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.5.0-rc.2"
+version = "2.5.0-rc.3"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 

crypticorn-2.5.0rc2/crypticorn/common/exceptions.py

@@ -1,27 +0,0 @@
-from typing import Optional, Dict
-from pydantic import BaseModel, Field
-from fastapi import HTTPException as FastAPIHTTPException
-from crypticorn.common import ApiError
-
-
-class ExceptionDetail(BaseModel):
-    message: Optional[str] = Field(None, description="An additional error message")
-    error: ApiError = Field(..., description="The unique error 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,
-        detail: ExceptionDetail,
-        headers: Optional[Dict[str, str]] = None,
-    ):
-        super().__init__(
-            status_code=detail.error.status_code,
-            detail=detail.model_dump(),
-            headers=headers,
-        )