From 7a87893b962d155f5e9d06bd0001a7f994419a2d Mon Sep 17 00:00:00 2001 From: Chris Guethle Date: Thu, 24 Oct 2013 09:40:43 -0500 Subject: reworked APIException, pushing some of the status_code and detail management up. Also, makes the APIException useful in isolation (defaults to status code 500) --- rest_framework/exceptions.py | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) (limited to 'rest_framework/exceptions.py') diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index 425a7214..2bd21de3 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -13,47 +13,40 @@ class APIException(Exception): Base class for REST framework exceptions. 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): status_code = status.HTTP_400_BAD_REQUEST default_detail = 'Malformed request.' - def __init__(self, detail=None): - self.detail = detail or self.default_detail - class AuthenticationFailed(APIException): status_code = status.HTTP_401_UNAUTHORIZED default_detail = 'Incorrect authentication credentials.' - def __init__(self, detail=None): - self.detail = detail or self.default_detail - class NotAuthenticated(APIException): status_code = status.HTTP_401_UNAUTHORIZED default_detail = 'Authentication credentials were not provided.' - def __init__(self, detail=None): - self.detail = detail or self.default_detail - class PermissionDenied(APIException): status_code = status.HTTP_403_FORBIDDEN 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): status_code = status.HTTP_405_METHOD_NOT_ALLOWED default_detail = "Method '%s' not allowed." 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): @@ -61,7 +54,7 @@ class NotAcceptable(APIException): default_detail = "Could not satisfy the request's Accept header" 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 @@ -70,19 +63,19 @@ class UnsupportedMediaType(APIException): default_detail = "Unsupported media type '%s' in request." 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): 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." def __init__(self, wait=None, detail=None): + super(Throttled, self).__init__(detail) + import math self.wait = wait and math.ceil(wait) or None if wait is not None: - format = detail or self.default_detail + self.extra_detail - self.detail = format % (self.wait, self.wait != 1 and 's' or '') - else: - self.detail = detail or self.default_detail + format = self.detail + self.extra_detail + self.detail = format % (self.wait, self.wait != 1 and 's' or '') \ No newline at end of file -- cgit v1.2.3 From d937ce331cc6cd2df04a989b49cca030f65319da Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 13 Jan 2014 17:37:08 +0000 Subject: Minor cleanup --- rest_framework/exceptions.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'rest_framework/exceptions.py') diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index 2bd21de3..4276625a 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -6,6 +6,7 @@ In addition Django's built in 403 and 404 exceptions are handled. """ from __future__ import unicode_literals from rest_framework import status +import math class APIException(Exception): @@ -14,10 +15,9 @@ class APIException(Exception): Subclasses should provide `.status_code` and `.detail` properties. """ status_code = status.HTTP_500_INTERNAL_SERVER_ERROR - default_detail = "" + default_detail = '' - def __init__(self, detail=None, status_code=None): - self.status_code = status_code or self.status_code + def __init__(self, detail=None): self.detail = detail or self.default_detail @@ -46,7 +46,7 @@ class MethodNotAllowed(APIException): default_detail = "Method '%s' not allowed." def __init__(self, method, detail=None): - super(MethodNotAllowed, self).__init__((detail or self.default_detail) % method) + self.detail = (detail or self.default_detail) % method class NotAcceptable(APIException): @@ -54,7 +54,7 @@ class NotAcceptable(APIException): default_detail = "Could not satisfy the request's Accept header" def __init__(self, detail=None, available_renderers=None): - super(NotAcceptable, self).__init__(detail) + self.detail = detail or self.default_detail self.available_renderers = available_renderers @@ -63,7 +63,7 @@ class UnsupportedMediaType(APIException): default_detail = "Unsupported media type '%s' in request." def __init__(self, media_type, detail=None): - super(UnsupportedMediaType, self).__init__((detail or self.default_detail) % media_type) + self.detail = (detail or self.default_detail) % media_type class Throttled(APIException): @@ -72,10 +72,10 @@ class Throttled(APIException): extra_detail = "Expected available in %d second%s." def __init__(self, wait=None, detail=None): - super(Throttled, self).__init__(detail) - - import math - self.wait = wait and math.ceil(wait) or None - if wait is not None: - format = self.detail + self.extra_detail - self.detail = format % (self.wait, self.wait != 1 and 's' or '') \ No newline at end of file + if wait is None: + self.detail = detail or self.default_detail + self.wait = None + else: + format = (detail or self.default_detail) + self.extra_detail + self.detail = format % (wait, wait != 1 and 's' or '') + self.wait = math.ceil(wait) -- cgit v1.2.3 From 97b7c25987c3bfa096a084dc671fc24816b08f87 Mon Sep 17 00:00:00 2001 From: Hassan Shamim Date: Mon, 10 Feb 2014 12:54:56 -0600 Subject: Replace 'detail' with 'default_detail' in Exceptions guide and APIException class docstring. --- rest_framework/exceptions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'rest_framework/exceptions.py') diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index 4276625a..0ac5866e 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -12,7 +12,7 @@ import math class APIException(Exception): """ Base class for REST framework exceptions. - Subclasses should provide `.status_code` and `.detail` properties. + Subclasses should provide `.status_code` and `.default_detail` properties. """ status_code = status.HTTP_500_INTERNAL_SERVER_ERROR default_detail = '' -- cgit v1.2.3 From 6322feb32dceb7be67b2117686f0a7570a615294 Mon Sep 17 00:00:00 2001 From: jacobg Date: Fri, 4 Apr 2014 10:22:02 -0400 Subject: add a __str__ implementation to APIException Add a __str__ implementation to rest_framework.exceptions.APIException. This helps for logging raised exceptions. Thanks.--- rest_framework/exceptions.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'rest_framework/exceptions.py') diff --git a/rest_framework/exceptions.py b/rest_framework/exceptions.py index 0ac5866e..5f774a9f 100644 --- a/rest_framework/exceptions.py +++ b/rest_framework/exceptions.py @@ -20,6 +20,8 @@ class APIException(Exception): def __init__(self, detail=None): self.detail = detail or self.default_detail + def __str__(self): + return self.detail class ParseError(APIException): status_code = status.HTTP_400_BAD_REQUEST -- cgit v1.2.3