solari-runloop-compat 0.1.0__py3-none-any.whl

solari_runloop/_exceptions.py

@@ -0,0 +1,122 @@
+"""Runloop's exception hierarchy, same names and attributes where a Solari call can raise them.
+
+Solari gateway errors are translated by :func:`solari_runloop._mapping.map_error`; the original
+``{code, error, message, retryable}`` JSON stays available as ``.body``.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional
+
+__all__ = [
+    "RunloopError",
+    "APIError",
+    "APIResponseValidationError",
+    "APIStatusError",
+    "APIConnectionError",
+    "APITimeoutError",
+    "BadRequestError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "UnprocessableEntityError",
+    "RateLimitError",
+    "InternalServerError",
+    "SolariCompatUnsupported",
+]
+
+
+class RunloopError(Exception):
+    pass
+
+
+class APIError(RunloopError):
+    message: str
+    request: Optional[Any]
+    body: Optional[object]
+
+    def __init__(self, message: str, request: Optional[Any] = None, *, body: Optional[object] = None) -> None:
+        super().__init__(message)
+        self.message = message
+        self.request = request
+        self.body = body
+
+
+class APIResponseValidationError(APIError):
+    def __init__(self, message: Optional[str] = None, *, body: Optional[object] = None, response: Optional[Any] = None) -> None:
+        super().__init__(message or "Data returned by API invalid for expected schema.", None, body=body)
+        self.response = response
+        self.status_code: Optional[int] = getattr(response, "status_code", None)
+
+
+class APIStatusError(APIError):
+    """A 4xx/5xx from the Solari gateway."""
+
+    status_code: int
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: Optional[int] = None,
+        body: Optional[object] = None,
+        response: Optional[Any] = None,
+    ) -> None:
+        super().__init__(message, None, body=body)
+        self.response = response
+        if status_code is not None:
+            self.status_code = status_code
+
+
+class APIConnectionError(APIError):
+    def __init__(self, message: str = "Connection error.", request: Optional[Any] = None) -> None:
+        super().__init__(message, request, body=None)
+
+
+class APITimeoutError(APIConnectionError):
+    def __init__(self, request: Optional[Any] = None) -> None:
+        super().__init__("Request timed out.", request)
+
+
+class BadRequestError(APIStatusError):
+    status_code = 400
+
+
+class AuthenticationError(APIStatusError):
+    status_code = 401
+
+
+class PermissionDeniedError(APIStatusError):
+    status_code = 403
+
+
+class NotFoundError(APIStatusError):
+    status_code = 404
+
+
+class ConflictError(APIStatusError):
+    status_code = 409
+
+
+class UnprocessableEntityError(APIStatusError):
+    status_code = 422
+
+
+class RateLimitError(APIStatusError):
+    status_code = 429
+
+
+class InternalServerError(APIStatusError):
+    pass
+
+
+class SolariCompatUnsupported(APIError):
+    """The Runloop feature has no Solari equivalent yet (see COMPAT.md). Never silently ignored."""
+
+    def __init__(self, feature: str, hint: str = "") -> None:
+        msg = f"{feature} is not supported by the Solari compatibility layer yet."
+        if hint:
+            msg += f" {hint}"
+        super().__init__(msg, None, body=None)
+        self.feature = feature