api/core/exceptions.py
from django.utils.encoding import force_str
from rest_framework import status
from rest_framework.exceptions import APIException, ErrorDetail
from rest_framework.utils.serializer_helpers import ReturnDict, ReturnList
def _get_error_details(data, default_code=None):
"""
Descend into a nested data structure, forcing any
lazy translation strings or strings into `ErrorDetail`.
"""
if isinstance(data, list):
ret = [_get_error_details(item, default_code) for item in data]
if isinstance(data, ReturnList):
return ReturnList(ret, serializer=data.serializer)
return ret
elif isinstance(data, dict):
ret = {key: _get_error_details(value, default_code) for key, value in data.items()}
if isinstance(data, ReturnDict):
return ReturnDict(ret, serializer=data.serializer)
return ret
text = force_str(data)
code = getattr(data, "code", default_code)
return ErrorDetail(text, code)
class NotFoundError(APIException):
status_code = status.HTTP_404_NOT_FOUND
default_detail = "Invalid input."
default_code = "invalid"
def __init__(self, detail=None, code=None):
super(NotFoundError, self).__init__()
if detail is None:
detail = self.default_detail
if code is None:
code = self.default_code
# For validation failures, we may collect many errors together,
# so the details should always be coerced to a list if not already.
if not isinstance(detail, dict) and not isinstance(detail, list):
detail = [detail]
self.detail = _get_error_details(detail, code)
class PermissionDeniedError(APIException):
status_code = status.HTTP_403_FORBIDDEN
default_detail = "You don't have permission to do that action"
default_code = "invalid"
def __init__(self, detail=None, code=None):
super(PermissionDeniedError, self).__init__()
if detail is None:
detail = self.default_detail
if code is None:
code = self.default_code
self.detail = _get_error_details({"error": detail}, code)
class BadRequestError(APIException):
status_code = status.HTTP_400_BAD_REQUEST
default_detail = "Invalid input."
default_code = "invalid"
def __init__(self, detail=None, code=None):
super(BadRequestError, self).__init__()
if detail is None:
detail = self.default_detail
if code is None:
code = self.default_code
# For validation failures, we may collect many errors together,
# so the details should always be coerced to a list if not already.
if not isinstance(detail, dict) and not isinstance(detail, list):
detail = [detail]
self.detail = _get_error_details(detail, code)