Skip to main content

A Django app for returning consistent, verbose and easy to parse error messages on Django Rest Framework backends.

Project description

Hipo DRF Exceptions

hipo Build Status pypi

A Django app for returning consistent, verbose and easy to parse error messages on Django Rest Framework backends.

Parsing error messages generated by DRF is a bit of pain for client developers. They need to try-catch different possible error formats. When you add errors raised at the business logic level, the error parsing becomes even more difficult.

This package unifies the output format of DRF in the "Hipo Error Protocol".

No more "An error occured." errors.

This package also provides the "fallback message", a text string that always contains a human readable error summary. This way, client developers can always fallback and show this message when the client receives an error that is not handled.

Sounds cool! Can client devs just use this field all the time?

In our past experience, we noticed that some lazy client developers tend to use this message and avoid writing any code to parse the error bundle. However, the message in this field is automatically generated and may not always be suitable for end users. In order to make clear that this is a fallback message, we named this field "fallback_message"

Table of Contents


You can get stable version of Hipo Excepitons by using pip, pipenv or poetry:

pip install hipo-drf-exceptions



You will need to set EXCEPTION_HANDLER of the REST_FRAMEWORK setting of your Django project file.

    'EXCEPTION_HANDLER': 'hipo_drf_exceptions.handler',

Example Error Responses

Field Error

You can make validations on model level and raise ValidationError when it is required.

from django.core.exceptions import ValidationError

class Invitation(models.Model):
    email = models.EmailField(unique=True)

    def save(self, *args, **kwargs):
        if User.objects.filter(
            raise ValidationError({"email": _("Email is already registered.")})
        super().save(*args, **kwargs)

If the view or serializer encounters with the ValidationError, The response will be like:

    "type": "ValidationError",
    "detail": {
        "email": [
            "Email is already registered."
    "fallback_message": "Email is already registered."

Non Field Error

Implement your own error classes.

from hipo_drf_exceptions import BaseAPIException

class ProfileCredentialError(BaseAPIException):
    default_detail = _('Profile credentials are not correct.')

Raise error when it is required.

class AuthenticationView(GenericAPIView):

    def post(self, request, *args, **kwargs):
        if not profile.check_password(password):
            raise ProfileCredentialError()

The response will be like:

    "type": "ProfileCredentialError",
    "detail": {
        "non_field_errors": [
            "Profile credentials are not correct."
    "fallback_message": "Profile credentials are not correct."


You can set default key for Django's non field errors key (it is "__all__") by adding this to your Django settings:

    "DJANGO_NON_FIELD_ERRORS_KEY": "field_free_errors"  # by default it's "non_field_errors" to be consistent with DRF.


Install dependencies via poetry.

poetry install

Run tests.

pytest test_project

Client SDKs

We have SDKs for client side.


Please open an issue for support.


Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hipo-drf-exceptions-0.1.8.tar.gz (9.0 kB view hashes)

Uploaded source

Built Distribution

hipo_drf_exceptions-0.1.8-py3-none-any.whl (13.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page