You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
58 lines
1.7 KiB
58 lines
1.7 KiB
"""Error definitions."""
|
|
from typing import Dict
|
|
|
|
from werkzeug.exceptions import HTTPException
|
|
|
|
from server.api.decorators import return_json
|
|
from server.api.model import APIResponse, APIMessage
|
|
|
|
|
|
class BaseError(Exception):
|
|
"""Base Error Class (5xx errors)."""
|
|
|
|
def __init__(
|
|
self,
|
|
message: str = 'Unknown error',
|
|
status_code: int = 500,
|
|
extra_fields: Dict[str, str] = None) -> None:
|
|
"""Populate The Error Definition."""
|
|
super().__init__(message)
|
|
self.message = message
|
|
self.status_code = status_code
|
|
self.extra_fields = extra_fields
|
|
|
|
def to_dict(self) -> dict:
|
|
"""Serialize an error message to return."""
|
|
return {
|
|
'message': self.message,
|
|
'status_code': self.status_code
|
|
}
|
|
|
|
|
|
class ClientError(BaseError):
|
|
"""Errors where the client is wrong (4xx errors)."""
|
|
|
|
def __init__(self,
|
|
message: str = 'Unknown client error',
|
|
status_code: int = 400,
|
|
extra_fields: Dict[str, str] = None) -> None:
|
|
"""Init for client originated errors."""
|
|
super().__init__(message, status_code, extra_fields)
|
|
|
|
|
|
class ValidationError(ClientError):
|
|
"""Validation Error."""
|
|
|
|
|
|
@return_json
|
|
def handle_404_error(exception: HTTPException) -> APIResponse:
|
|
"""Error handler for 404 errors."""
|
|
return APIResponse(
|
|
payload=APIMessage(False, 'Not Found'),
|
|
status=exception.code if exception.code is not None else 404)
|
|
|
|
|
|
@return_json
|
|
def handle_base_error(error: BaseError) -> APIResponse:
|
|
"""Error handler for basic raised errors."""
|
|
return APIResponse(payload=error, status=error.status_code)
|