Django Rest Framework - come creare messaggi di errore personalizzati per tutti i campi ModelSerializer?

Question

Questo è il mio serializers.py (voglio creare un serializzatore per il modello utente built-in):

from rest_framework import serializers 

from django.contrib.auth.models import User 

class UserSerializer(serializers.ModelSerializer): 

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

Sono consapevole che Django Resto quadro ha il proprio validatori dei campi, perché quando cerco di creare un utente che utilizza un nome utente già esistente, solleva un detto errore:

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

voglio personalizzare il messaggio di errore e farle dire "Questo nome utente è già preso Riprovare." piuttosto che dire "Questo il campo deve essere unico ".

Essa ha anche un built-in validatore regex, perché quando creo un nome utente con un punto esclamativo, si dice:

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

voglio personalizzare il validatore regex in modo che si dice solo "Nome utente non valido ".

Come si personalizzano tutti i messaggi di errore di ciascun campo?

Nota: in base a questo post: Custom error messages in Django Rest Framework serializer posso fare:

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' 

Ma che cosa devo fare per i validatori 'unici' e 'regex'? Ho provato a fare

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

e

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

ma nessuno dei due ha funzionato.

Answer 1

Per sostituire messaggi di errore univoci o irregolari è necessario modificare il membro message dell'oggetto corrispondente del validatore. Questo potrebbe essere fatto utilizzando classe intermedia separata:

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', {}) 

Poi si può solo ereditare questa mixin e aggiornare Meta classe:

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') 
      } 
     }