encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-24 08:14:16 +03:00
Code Issues Packages Projects Releases Wiki Activity

reworked APIException, pushing some of the status_code and detail management up. Also, makes the APIException useful in isolation (defaults to status code 500)

Browse Source
This commit is contained in:
Chris Guethle 2013-10-24 09:40:43 -05:00
parent 2ddf7869e3
commit 7a87893b96
1 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
rest_framework/exceptions.py
View File

@ -13,47 +13,40 @@ class APIException(Exception):
Base class for REST framework exceptions. Base class for REST framework exceptions.
Subclasses should provide `.status_code` and `.detail` properties. Subclasses should provide `.status_code` and `.detail` properties.
""" """
pass status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
default_detail = ""
def __init__(self, detail=None, status_code=None):
self.status_code = status_code or self.status_code
self.detail = detail or self.default_detail
class ParseError(APIException): class ParseError(APIException):
status_code = status.HTTP_400_BAD_REQUEST status_code = status.HTTP_400_BAD_REQUEST
default_detail = 'Malformed request.' default_detail = 'Malformed request.'
def __init__(self, detail=None):
self.detail = detail or self.default_detail
class AuthenticationFailed(APIException): class AuthenticationFailed(APIException):
status_code = status.HTTP_401_UNAUTHORIZED status_code = status.HTTP_401_UNAUTHORIZED
default_detail = 'Incorrect authentication credentials.' default_detail = 'Incorrect authentication credentials.'
def __init__(self, detail=None):
self.detail = detail or self.default_detail
class NotAuthenticated(APIException): class NotAuthenticated(APIException):
status_code = status.HTTP_401_UNAUTHORIZED status_code = status.HTTP_401_UNAUTHORIZED
default_detail = 'Authentication credentials were not provided.' default_detail = 'Authentication credentials were not provided.'
def __init__(self, detail=None):
self.detail = detail or self.default_detail
class PermissionDenied(APIException): class PermissionDenied(APIException):
status_code = status.HTTP_403_FORBIDDEN status_code = status.HTTP_403_FORBIDDEN
default_detail = 'You do not have permission to perform this action.' default_detail = 'You do not have permission to perform this action.'
def __init__(self, detail=None):
self.detail = detail or self.default_detail
class MethodNotAllowed(APIException): class MethodNotAllowed(APIException):
status_code = status.HTTP_405_METHOD_NOT_ALLOWED status_code = status.HTTP_405_METHOD_NOT_ALLOWED
default_detail = "Method '%s' not allowed." default_detail = "Method '%s' not allowed."
def __init__(self, method, detail=None): def __init__(self, method, detail=None):
self.detail = (detail or self.default_detail) % method super(MethodNotAllowed, self).__init__((detail or self.default_detail) % method)
class NotAcceptable(APIException): class NotAcceptable(APIException):
@ -61,7 +54,7 @@ class NotAcceptable(APIException):
default_detail = "Could not satisfy the request's Accept header" default_detail = "Could not satisfy the request's Accept header"
def __init__(self, detail=None, available_renderers=None): def __init__(self, detail=None, available_renderers=None):
self.detail = detail or self.default_detail super(NotAcceptable, self).__init__(detail)
self.available_renderers = available_renderers self.available_renderers = available_renderers
@ -70,19 +63,19 @@ class UnsupportedMediaType(APIException):
default_detail = "Unsupported media type '%s' in request." default_detail = "Unsupported media type '%s' in request."
def __init__(self, media_type, detail=None): def __init__(self, media_type, detail=None):
self.detail = (detail or self.default_detail) % media_type super(UnsupportedMediaType, self).__init__((detail or self.default_detail) % media_type)
class Throttled(APIException): class Throttled(APIException):
status_code = status.HTTP_429_TOO_MANY_REQUESTS status_code = status.HTTP_429_TOO_MANY_REQUESTS
default_detail = "Request was throttled." default_detail = 'Request was throttled.'
extra_detail = "Expected available in %d second%s." extra_detail = "Expected available in %d second%s."
def __init__(self, wait=None, detail=None): def __init__(self, wait=None, detail=None):
super(Throttled, self).__init__(detail)
import math import math
self.wait = wait and math.ceil(wait) or None self.wait = wait and math.ceil(wait) or None
if wait is not None: if wait is not None:
format = detail or self.default_detail + self.extra_detail format = self.detail + self.extra_detail
self.detail = format % (self.wait, self.wait != 1 and 's' or '') self.detail = format % (self.wait, self.wait != 1 and 's' or '')
else:
self.detail = detail or self.default_detail