9

これは私の serializers.py です (組み込みの User モデルのシリアライザーを作成したい):

from rest_framework import serializers

from django.contrib.auth.models import User

class UserSerializer(serializers.ModelSerializer):

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

Django Rest Framework には独自のフィールド バリデータがあることを認識しています。既に存在するユーザー名を使用してユーザーを作成しようとすると、次のエラーが発生するためです。

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

エラー メッセージをカスタマイズして、「このフィールドは一意である必要があります」ではなく、「このユーザー名は既に使用されています。もう一度お試しください」と表示するようにしたいと考えています。

また、組み込みの正規表現バリデーターもあります。これは、感嘆符を使用してユーザー名を作成すると、次のように表示されるためです。

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

「無効なユーザー名」とだけ表示されるように、正規表現バリデーターをカスタマイズしたいと考えています。

各フィールドのすべてのエラー メッセージをカスタマイズするにはどうすればよいですか?

注: この投稿によると: Django Rest Framework シリアライザーのカスタム エラー メッセージ:

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'

しかし、'unique' および 'regex' バリデーターに対してはどうすればよいでしょうか? やってみた

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

と

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

しかし、どちらも機能しませんでした。

4

2 に答える 2

6

固有または正規表現のエラー メッセージを置き換えるにmessageは、対応するバリデータ オブジェクトのメンバーを変更する必要があります。これは、別の mixin クラスを使用して行うことができます。

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

Meta次に、この mixin を継承してクラスを更新できます。

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')
            }
        }
于 2015-06-01T05:15:18.187 に答える