Django rest framework обработка ошибок

exceptions.py

Exceptions… allow error handling to be organized cleanly in a central or high-level place within the program structure.

— Doug Hellmann, Python Exception Handling Techniques

Exception handling in REST framework views

REST framework’s views handle various exceptions, and deal with returning appropriate error responses.

The handled exceptions are:

• Subclasses of APIException raised inside REST framework.
• Django’s Http404 exception.
• Django’s PermissionDenied exception.

In each case, REST framework will return a response with an appropriate status code and content-type. The body of the response will include any additional details regarding the nature of the error.

Most error responses will include a key detail in the body of the response.

For example, the following request:

DELETE http://api.example.com/foo/bar HTTP/1.1
Accept: application/json

Might receive an error response indicating that the DELETE method is not allowed on that resource:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 42

{"detail": "Method 'DELETE' not allowed."}

Validation errors are handled slightly differently, and will include the field names as the keys in the response. If the validation error was not specific to a particular field then it will use the «non_field_errors» key, or whatever string value has been set for the NON_FIELD_ERRORS_KEY setting.

An example validation error might look like this:

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 94

{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}

Custom exception handling

You can implement custom exception handling by creating a handler function that converts exceptions raised in your API views into response objects. This allows you to control the style of error responses used by your API.

The function must take a pair of arguments, the first is the exception to be handled, and the second is a dictionary containing any extra context such as the view currently being handled. The exception handler function should either return a Response object, or return None if the exception cannot be handled. If the handler returns None then the exception will be re-raised and Django will return a standard HTTP 500 ‘server error’ response.

For example, you might want to ensure that all error responses include the HTTP status code in the body of the response, like so:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 62

{"status_code": 405, "detail": "Method 'DELETE' not allowed."}

In order to alter the style of the response, you could write the following custom exception handler:

from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    # Call REST framework's default exception handler first,
    # to get the standard error response.
    response = exception_handler(exc, context)

    # Now add the HTTP status code to the response.
    if response is not None:
        response.data['status_code'] = response.status_code

    return response

The context argument is not used by the default handler, but can be useful if the exception handler needs further information such as the view currently being handled, which can be accessed as context['view'].

The exception handler must also be configured in your settings, using the EXCEPTION_HANDLER setting key. For example:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

If not specified, the 'EXCEPTION_HANDLER' setting defaults to the standard exception handler provided by REST framework:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

Note that the exception handler will only be called for responses generated by raised exceptions. It will not be used for any responses returned directly by the view, such as the HTTP_400_BAD_REQUEST responses that are returned by the generic views when serializer validation fails.

API Reference

APIException

Signature: APIException()

The base class for all exceptions raised inside an APIView class or @api_view.

To provide a custom exception, subclass APIException and set the .status_code, .default_detail, and default_code attributes on the class.

For example, if your API relies on a third party service that may sometimes be unreachable, you might want to implement an exception for the «503 Service Unavailable» HTTP response code. You could do this like so:

from rest_framework.exceptions import APIException

class ServiceUnavailable(APIException):
    status_code = 503
    default_detail = 'Service temporarily unavailable, try again later.'
    default_code = 'service_unavailable'

Inspecting API exceptions

There are a number of different properties available for inspecting the status
of an API exception. You can use these to build custom exception handling
for your project.

The available attributes and methods are:

• .detail — Return the textual description of the error.
• .get_codes() — Return the code identifier of the error.
• .get_full_details() — Return both the textual description and the code identifier.

In most cases the error detail will be a simple item:

>>> print(exc.detail)
You do not have permission to perform this action.
>>> print(exc.get_codes())
permission_denied
>>> print(exc.get_full_details())
{'message':'You do not have permission to perform this action.','code':'permission_denied'}

In the case of validation errors the error detail will be either a list or
dictionary of items:

>>> print(exc.detail)
{"name":"This field is required.","age":"A valid integer is required."}
>>> print(exc.get_codes())
{"name":"required","age":"invalid"}
>>> print(exc.get_full_details())
{"name":{"message":"This field is required.","code":"required"},"age":{"message":"A valid integer is required.","code":"invalid"}}

ParseError

Signature: ParseError(detail=None, code=None)

Raised if the request contains malformed data when accessing request.data.

By default this exception results in a response with the HTTP status code «400 Bad Request».

AuthenticationFailed

Signature: AuthenticationFailed(detail=None, code=None)

Raised when an incoming request includes incorrect authentication.

By default this exception results in a response with the HTTP status code «401 Unauthenticated», but it may also result in a «403 Forbidden» response, depending on the authentication scheme in use. See the authentication documentation for more details.

NotAuthenticated

Signature: NotAuthenticated(detail=None, code=None)

Raised when an unauthenticated request fails the permission checks.

By default this exception results in a response with the HTTP status code «401 Unauthenticated», but it may also result in a «403 Forbidden» response, depending on the authentication scheme in use. See the authentication documentation for more details.

PermissionDenied

Signature: PermissionDenied(detail=None, code=None)

Raised when an authenticated request fails the permission checks.

By default this exception results in a response with the HTTP status code «403 Forbidden».

NotFound

Signature: NotFound(detail=None, code=None)

Raised when a resource does not exists at the given URL. This exception is equivalent to the standard Http404 Django exception.

By default this exception results in a response with the HTTP status code «404 Not Found».

MethodNotAllowed

Signature: MethodNotAllowed(method, detail=None, code=None)

Raised when an incoming request occurs that does not map to a handler method on the view.

By default this exception results in a response with the HTTP status code «405 Method Not Allowed».

NotAcceptable

Signature: NotAcceptable(detail=None, code=None)

Raised when an incoming request occurs with an Accept header that cannot be satisfied by any of the available renderers.

By default this exception results in a response with the HTTP status code «406 Not Acceptable».

Signature: UnsupportedMediaType(media_type, detail=None, code=None)

Raised if there are no parsers that can handle the content type of the request data when accessing request.data.

By default this exception results in a response with the HTTP status code «415 Unsupported Media Type».

Throttled

Signature: Throttled(wait=None, detail=None, code=None)

Raised when an incoming request fails the throttling checks.

By default this exception results in a response with the HTTP status code «429 Too Many Requests».

ValidationError

Signature: ValidationError(detail, code=None)

The ValidationError exception is slightly different from the other APIException classes:

• The detail argument is mandatory, not optional.
• The detail argument may be a list or dictionary of error details, and may also be a nested data structure. By using a dictionary, you can specify field-level errors while performing object-level validation in the validate() method of a serializer. For example. raise serializers.ValidationError({'name': 'Please enter a valid name.'})
• By convention you should import the serializers module and use a fully qualified ValidationError style, in order to differentiate it from Django’s built-in validation error. For example. raise serializers.ValidationError('This field must be an integer value.')

The ValidationError class should be used for serializer and field validation, and by validator classes. It is also raised when calling serializer.is_valid with the raise_exception keyword argument:

serializer.is_valid(raise_exception=True)

The generic views use the raise_exception=True flag, which means that you can override the style of validation error responses globally in your API. To do so, use a custom exception handler, as described above.

By default this exception results in a response with the HTTP status code «400 Bad Request».

Generic Error Views

Django REST Framework provides two error views suitable for providing generic JSON 500 Server Error and
400 Bad Request responses. (Django’s default error views provide HTML responses, which may not be appropriate for an
API-only application.)

Use these as per Django’s Customizing error views documentation.

rest_framework.exceptions.server_error

Returns a response with status code 500 and application/json content type.

Set as handler500:

handler500 = 'rest_framework.exceptions.server_error'

rest_framework.exceptions.bad_request

Returns a response with status code 400 and application/json content type.

Set as handler400:

handler400 = 'rest_framework.exceptions.bad_request'

Third party packages

The following third-party packages are also available.

DRF Standardized Errors

The drf-standardized-errors package provides an exception handler that generates the same format for all 4xx and 5xx responses. It is a drop-in replacement for the default exception handler and allows customizing the error response format without rewriting the whole exception handler. The standardized error response format is easier to document and easier to handle by API consumers.

DELETE http://api.example.com/foo/bar HTTP/1.1
Accept: application/json

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 42

{"detail": "Method 'DELETE' not allowed."}

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 94

{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 62

{"status_code": 405, "detail": "Method 'DELETE' not allowed."}

from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    # Call REST framework's default exception handler first,
    # to get the standard error response.
    response = exception_handler(exc, context)

    # Now add the HTTP status code to the response.
    if response is not None:
        response.data['status_code'] = response.status_code

    return response

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

from rest_framework.exceptions import APIException

class ServiceUnavailable(APIException):
    status_code = 503
    default_detail = 'Service temporarily unavailable, try again later.'
    default_code = 'service_unavailable'

>>> print(exc.detail)
You do not have permission to perform this action.
>>> print(exc.get_codes())
permission_denied
>>> print(exc.get_full_details())
{'message':'You do not have permission to perform this action.','code':'permission_denied'}

>>> print(exc.detail)
{"name":"This field is required.","age":"A valid integer is required."}
>>> print(exc.get_codes())
{"name":"required","age":"invalid"}
>>> print(exc.get_full_details())
{"name":{"message":"This field is required.","code":"required"},"age":{"message":"A valid integer is required.","code":"invalid"}}

serializer.is_valid(raise_exception=True)

handler500 = 'rest_framework.exceptions.server_error'

handler400 = 'rest_framework.exceptions.bad_request'

Вернуться на верх

Exceptions

Исключения…позволяют чисто организовать обработку ошибок в центральном или высокоуровневом месте в структуре программы.

— Дуг Хеллманн, Методы обработки исключений Python

Обработка исключений во взглядах на структуру REST

Представления REST-фреймворка обрабатывают различные исключения и имеют дело с возвратом соответствующих ответов об ошибках.

Обработанные исключения:

• Подклассы APIException подняты в рамках REST.
• Исключение Django Http404 .
• Django’s PermissionDenied исключение.

В каждом случае REST-структура возвращает ответ с соответствующим кодом статуса и типом содержимого.Тело ответа будет содержать любые дополнительные сведения о характере ошибки.

Большинство ответов об ошибках будут содержать ключевую detail в теле ответа.

Например,следующий запрос:

DELETE http://api.example.com/foo/bar HTTP/1.1
Accept: application/json

Может получить ответ об ошибке, указывающий, что метод DELETE не разрешен для этого ресурса:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 42

{"detail": "Method 'DELETE' not allowed."}

Ошибки проверки обрабатываются немного по-разному и включают имена полей в качестве ключей в ответе. Если ошибка проверки не была специфичной для определенного поля, тогда она будет использовать ключ «non_field_errors» или любое другое строковое значение, установленное для параметра NON_FIELD_ERRORS_KEY .

Пример ошибки валидации может выглядеть следующим образом:

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 94

{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}

Обработка исключений на заказ

Вы можете реализовать пользовательскую обработку исключений,создав функцию обработчика,которая преобразует исключения,поднятые в ваших API представлениях,в объекты ответа.Это позволяет контролировать стиль ответов на ошибки,используемых вашим API.

Функция должна принимать пару аргументов, первый — исключение, которое нужно обработать, а второй — словарь, содержащий любой дополнительный контекст, такой как представление, обрабатываемое в данный момент. Функция обработчика исключений должна либо возвращать объект Response , либо возвращать None , если исключение не может быть обработано. Если обработчик возвращает None , то исключение будет повторно вызвано, и Django вернет стандартный HTTP 500 ответ «ошибка сервера».

Например,вы можете захотеть убедиться,что все ответы на ошибки включают код статуса HTTP в теле ответа,подобно этому:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 62

{"status_code": 405, "detail": "Method 'DELETE' not allowed."}

Для того,чтобы изменить стиль ответа,можно написать следующий пользовательский обработчик исключений:

from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    
    
    response = exception_handler(exc, context)

    
    if response is not None:
        response.data['status_code'] = response.status_code

    return response

Аргумент context не используется обработчиком по умолчанию, но может быть полезен, если обработчику исключений требуется дополнительная информация, такая как представление, обрабатываемое в данный момент, к которому можно обращаться как context['view'] .

Обработчик исключений также должен быть настроен в ваших настройках, используя ключ установки EXCEPTION_HANDLER . Например:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

Если не указано, для параметра 'EXCEPTION_HANDLER' умолчанию используется стандартный обработчик исключений, предоставляемый средой REST:

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

Обратите внимание, что обработчик исключений будет вызываться только для ответов, генерируемых возбужденными исключениями. Он не будет использоваться ни для каких ответов, возвращаемых представлением, например ответов HTTP_400_BAD_REQUEST , которые возвращаются общими представлениями при сбое проверки сериализатора.

API Reference

APIException

Signature:APIException()

Базовый класс для всех исключений , сгенерированных внутри APIView класса или @api_view .

Чтобы предоставить пользовательское исключение, APIException подкласс APIException и установите .status_code , .default_detail и default_code для класса.

Например,если ваш API полагается на службу третьей стороны,которая иногда может быть недоступна,вы можете реализовать исключение для кода ответа HTTP «503 Service Unavailable».Вы можете сделать это таким образом:

from rest_framework.exceptions import APIException

class ServiceUnavailable(APIException):
    status_code = 503
    default_detail = 'Service temporarily unavailable, try again later.'
    default_code = 'service_unavailable'

Проверка исключений API

Существует ряд различных свойств для проверки статуса исключения API.Вы можете использовать их для построения пользовательской обработки исключений для вашего проекта.

Доступные атрибуты и методы:

• .detail — возвращает текстовое описание ошибки.
• .get_codes() — возвращает идентификатор кода ошибки.
• .get_full_details() — возвращает текстовое описание и идентификатор кода.

В большинстве случаев детализация ошибки будет простой:

>>> print(exc.detail)
You do not have permission to perform this action.
>>> print(exc.get_codes())
permission_denied
>>> print(exc.get_full_details())
{'message':'You do not have permission to perform this action.','code':'permission_denied'}

В случае ошибок проверки детализацией ошибки будет либо список,либо словарь элементов:

>>> print(exc.detail)
{"name":"This field is required.","age":"A valid integer is required."}
>>> print(exc.get_codes())
{"name":"required","age":"invalid"}
>>> print(exc.get_full_details())
{"name":{"message":"This field is required.","code":"required"},"age":{"message":"A valid integer is required.","code":"invalid"}}

ParseError

Signature:ParseError(detail=None, code=None)

Возникает, если запрос содержит искаженные данные при доступе к request.data .

По умолчанию это исключение приводит к ответу с кодом состояния HTTP «400 Bad Request».

AuthenticationFailed

Signature:AuthenticationFailed(detail=None, code=None)

Поднимается,когда входящий запрос включает некорректную аутентификацию.

По умолчанию это исключение приводит к ответу с кодом состояния HTTP «401 Не аутентифицирован», но может также привести к ответу «403 Запрещено», в зависимости от используемой схемы аутентификации. Смотрите документацию по аутентификации для более подробной информации.

NotAuthenticated

Signature:NotAuthenticated(detail=None, code=None)

Поднимается,когда неаутентифицированный запрос не проверяет разрешение.

По умолчанию это исключение приводит к ответу с кодом состояния HTTP «401 Не аутентифицирован», но может также привести к ответу «403 Запрещено», в зависимости от используемой схемы аутентификации. Смотрите документацию по аутентификации для более подробной информации.

PermissionDenied

Signature:PermissionDenied(detail=None, code=None)

Поднимается,когда аутентифицированный запрос не проверяется.

По умолчанию это исключение приводит к ответу с кодом статуса HTTP «403 Запрещено».

NotFound

Signature:NotFound(detail=None, code=None)

Возникает, когда ресурс не существует по указанному URL. Это исключение эквивалентно стандартному исключению Http404 Django.

По умолчанию это исключение приводит к ответу с кодом статуса HTTP «404 Не найдено».

MethodNotAllowed

Подпись: MethodNotAllowed(method, detail=None, code=None)

Поднимается при возникновении входящего запроса,который не привязан к методу обработчика на просмотре.

По умолчанию это исключение дает ответ с кодом статуса HTTP «405 Метод не разрешен».

NotAcceptable

Signature:NotAcceptable(detail=None, code=None)

Возникает, когда происходит входящий запрос с заголовком Accept , который не может быть удовлетворен ни одним из доступных средств визуализации.

По умолчанию это исключение дает ответ с кодом статуса HTTP «406 Неприемлемо».

UnsupportedMediaType

Подпись: UnsupportedMediaType(media_type, detail=None, code=None)

Возникает, если нет парсеров, которые могут обрабатывать тип содержимого данных запроса при доступе к request.data .

По умолчанию это исключение приводит к ответу с кодом статуса HTTP «415 Неподдерживаемый тип носителя».

Throttled

Подпись: Throttled(wait=None, detail=None, code=None)

Поднимается,когда входящий запрос не проходит проверку дросселирования.

По умолчанию это исключение приводит к ответу с кодом статуса HTTP «429 Слишком много запросов».

ValidationError

Signature:ValidationError(detail, code=None)

ValidationError исключение немного отличается от других APIException классов:

• detail аргумент является обязательным, а не факультативным.
• Аргумент detail может быть списком или словарем сведений об ошибках, а также может быть вложенной структурой данных. Используя словарь, вы можете указать ошибки на уровне поля при выполнении проверки на уровне объекта в методе validate() сериализатора. Например. raise serializers.ValidationError({'name': 'Please enter a valid name.'})
• По соглашению вы должны импортировать модуль сериализаторов и использовать полностью определенный стиль ValidationError , чтобы отличить его от встроенной ошибки проверки Django. Например. raise serializers.ValidationError('This field must be an integer value.')

Класс ValidationError должен использоваться для валидации сериализатора и поля, а также для классов валидатора. Он также вызывается при вызове serializer.is_valid с raise_exception ключевого слова rise_exception :

serializer.is_valid(raise_exception=True)

В общих представлениях используется флаг raise_exception=True , что означает, что вы можете переопределить стиль ответов об ошибках проверки глобально в вашем API. Для этого используйте пользовательский обработчик исключений, как описано выше.

По умолчанию это исключение приводит к ответу с кодом состояния HTTP «400 Bad Request».

Общие представления об ошибках

Django REST Framework предоставляет два представления ошибок, подходящих для предоставления общих ответов JSON 500 Server Error и 400 Bad Request. (Представления ошибок Django по умолчанию предоставляют HTML-ответы, которые могут не подходить для приложений только для API.)

Используйте их в соответствии с документацией Django по настройке представлений ошибок .

rest_framework.exceptions.server_error

Возвращает ответ с кодом состояния 500 и типом содержимого application/json .

Установить в качестве handler500 :

handler500 = 'rest_framework.exceptions.server_error'

rest_framework.exceptions.bad_request

Возвращает ответ с кодом состояния 400 и типом содержимого application/json .

Установить в качестве handler400 :

handler400 = 'rest_framework.exceptions.bad_request'

exceptions.py

Django REST Framework

3.14

• Caching

  Некая женщина имела очень острое сознание,но почти не помнила Кэширование REST Framework хорошо работает с утилитами кэширования,предоставляемыми Django.

• Content negotiation

  HTTP имеет положения для нескольких механизмов «согласования содержимого» процесса выбора наилучшего представления с учетом ответа, когда имеется несколько представлений.

• Serializer fields

  Каждое поле в классе Form отвечает не только за проверку данных, но и за их «очистку», нормализуя согласованный формат.

• Custom fields

  Если вы хотите создать настраиваемое поле, вам понадобится подкласс, а затем переопределите один или оба метода .to_representation() .to_internal_value().