Django Rest Framework - how to create custom error messages for all ModelSerializer fields?

Question

This is my serializers.py (I want to create a serializer for the built-in User model):

from rest_framework import serializers

from django.contrib.auth.models import User

class UserSerializer(serializers.ModelSerializer):

    class Meta:
        model = User
        fields = ('username', 'password', 'email', )

I'm aware that Django Rest Framework has it's own field validators, because when I try to create a user using a username which already exists, it raises an error saying:

{'username': [u'This field must be unique.']}

I want to customize the error message and make it say "This username is already taken. Please try again" rather than saying "This field must be unique".

It also has a built-in regex validator, because when I create a username with an exclamation mark, it says:

{'username': [u'Enter a valid username. This value may contain only letters, numbers and @/./+/-/_ characters.']}

I want to customize the regex validator so that it just says "Invalid username".

How do I customize all of the error messages which each field has?

Note: according to this post: Custom error messages in Django Rest Framework serializer I can do:

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User

    def __init__(self, *args, **kwargs):
        super(UserSerializer, self).__init__(*args, **kwargs)

        self.fields['username'].error_messages['required'] = u'My custom required msg'

But what do I do for the 'unique' and 'regex' validators? I tried doing

self.fields['username'].error_messages['regex'] = u'My custom required msg'

and

self.fields['username'].error_messages['validators'] = u'My custom required msg'

but neither worked.

awesoon · Accepted Answer · 2015-06-15 06:48:55Z

6

In order to replace unique or regex error messages you should change message member of corresponding validator object. This could be done using separate mixin class:

from django.core.validators import RegexValidator
from rest_framework.validators import UniqueValidator
from django.utils.translation import ugettext_lazy as _


class SetCustomErrorMessagesMixin:
    """
    Replaces built-in validator messages with messages, defined in Meta class. 
    This mixin should be inherited before the actual Serializer class in order to call __init__ method.

    Example of Meta class:

    >>> class Meta:
    >>>     model = User
    >>>     fields = ('url', 'username', 'email', 'groups')
    >>>     custom_error_messages_for_validators = {
    >>>         'username': {
    >>>             UniqueValidator: _('This username is already taken. Please, try again'),
    >>>             RegexValidator: _('Invalid username')
    >>>         }
    >>>     }
    """
    def __init__(self, *args, **kwargs):
        # noinspection PyArgumentList
        super(SetCustomErrorMessagesMixin, self).__init__(*args, **kwargs)
        self.replace_validators_messages()

    def replace_validators_messages(self):
        for field_name, validators_lookup in self.custom_error_messages_for_validators.items():
            # noinspection PyUnresolvedReferences
            for validator in self.fields[field_name].validators:
                if type(validator) in validators_lookup:
                    validator.message = validators_lookup[type(validator)]

    @property
    def custom_error_messages_for_validators(self):
        meta = getattr(self, 'Meta', None)
        return getattr(meta, 'custom_error_messages_for_validators', {})

Then you could just inherit this mixin and update Meta class:

class UserSerializer(SetCustomErrorMessagesMixin, serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ('url', 'username', 'email', 'groups')
        custom_error_messages_for_validators = {
            'username': {
                UniqueValidator: _('This username is already taken. Please, try again'),
                RegexValidator: _('Invalid username')
            }
        }

edited Jun 15, 2015 at 6:48

answered Jun 1, 2015 at 5:15

awesoon

33.8k14 gold badges81 silver badges103 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

awesoon Over a year ago

Another way is replacing all validators for a field using Meta.extra_kwargs field. Note, that you should provide all validators, because it will replace all original validators. If performance is important, you should provide some additional information, at least - expected connections per second. But if you want to replace, say 10 or even 100 messages, you will not see any difference between suggested approaches.

awesoon Over a year ago

HyperlinkedModelSerializer behaves like ModelSerializer, but it represents hyperlinks instead of ids. Just a matter of style.

awesoon Over a year ago

I always place mixins into, well, mixins module (like views, models and so on).

awesoon Over a year ago

Yes, you can. The SetCustomErrorMessagesMixin does not depend on the serializer type

awesoon Over a year ago

Seems like I forgot to add required imports, sorry. I've updated the answer, please, take look on it.

|

Artem Chege · Accepted Answer · 2021-11-03 09:26:29Z

You also can do that just customizing your language translation, look here:

https://docs.djangoproject.com/en/3.2/topics/i18n/translation/#message-files

All you have to do is to create message files, change translation in there and compile your message into .mo files.

This method is not so much unacceptable as i might seems. Look here:

https://www.django-rest-framework.org/topics/internationalization/

DRF docs say that its common practice customizing error messages (your own and default ones) via translation.

My tips for those who`d want to try path above:

Make default django.po file. Most of default errors will be there.
If you are using DRF, then open this file https://raw.githubusercontent.com/encode/django-rest-framework/master/rest_framework/locale/en_US/LC_MESSAGES/django.po , chose error that you want to customize and copy only that error into your django.po flle above.
Customize it.
Compile it.

(!) NOTE Make sure that your translation file named exacly as django.po, not mylovelydjango.po, not myproject.po but EXACTLY django.po, or nothing will work.

Collectives™ on Stack Overflow

Django Rest Framework - how to create custom error messages for all ModelSerializer fields?

2 Answers 2

9 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

9 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related