Django forms.ErrorList.template_name_text でエラーメッセージ表示をカスタマイズ

Django forms.ErrorList.template_name_text 詳細解説

概要

デフォルトの動作

forms.ErrorListは、エラーメッセージのリストを生成するクラスです。デフォルトでは、forms/error_list.htmlというテンプレートファイルを使用して、エラーメッセージを表示します。

template_name_text属性は、デフォルトのテンプレートファイルとは別のテンプレートファイルを指定するために使用できます。この属性に文字列を代入することで、そのテンプレートファイルがエラーメッセージの表示に使用されます。

テンプレートファイルは、Djangoプロジェクトのtemplatesディレクトリ以下に配置する必要があります。テンプレートファイル名は、拡張子.htmlを含めて指定します。

テンプレートファイルは、Djangoテンプレート言語を使用して記述されます。テンプレートファイルには、以下の変数が使用できます。

• errors: エラーメッセージのリスト
• form: フォームオブジェクト

例

以下の例では、forms/custom_error_list.htmlというテンプレートファイルを指定して、エラーメッセージを表示しています。

from django.forms import ErrorList

class MyForm(forms.Form):
    name = forms.CharField()

    def clean_name(self):
        value = self.cleaned_data['name']
        if len(value) < 3:
            raise ValidationError('名前は3文字以上入力してください')

error_list = ErrorList()
error_list.template_name_text = 'forms/custom_error_list.html'

# テンプレートファイル: forms/custom_error_list.html

{% for error in errors %}
<p>{{ error }}</p>
{% endfor %}

テンプレートファイルの詳細

テンプレートファイルの変数

• errors: エラーメッセージのリストです。各要素は、文字列またはdjango.utils.safestring.SafeTextオブジェクトです。
• form: フォームオブジェクトです。フォームオブジェクトを使用して、エラーメッセージに関連する情報を取り出すことができます。

テンプレートファイルの例

以下の例では、errors変数を使って、エラーメッセージをul要素で囲んで表示しています。

{% for error in errors %}
<li>{{ error }}</li>
{% endfor %}

フォームオブジェクトの使用例

以下の例では、formオブジェクトを使用して、エラーメッセージに関連するフィールド名を表示しています。

{% for error in errors %}
<p>{{ error }} (フィールド名: {{ form.field_errors.get(error.field) }})</p>
{% endfor %}

その他

テンプレートファイルは、Djangoプロジェクトのtemplatesディレクトリ以下に配置する必要があります。サブディレクトリに配置することも可能です。

テンプレートファイルの拡張子は、.htmlです。

テンプレートファイルは、Djangoテンプレート言語を使用して記述されます。詳細は、Django公式ドキュメントの「テンプレート」を参照してください。

補足

• forms.ErrorListクラスは、django.formsモジュール以外にも、django.contrib.adminモジュールなどでも使用されています。
• template_name_text属性は、Django 1.9以降で導入されました。

Django forms.ErrorList.template_name_text サンプルコード

基本的なサンプル

from django.forms import ErrorList

class MyForm(forms.Form):
    name = forms.CharField()

    def clean_name(self):
        value = self.cleaned_data['name']
        if len(value) < 3:
            raise ValidationError('名前は3文字以上入力してください')

error_list = ErrorList()
error_list.template_name_text = 'forms/custom_error_list.html'

# テンプレートファイル: forms/custom_error_list.html

{% for error in errors %}
<p>{{ error }}</p>
{% endfor %}

エラーメッセージにフィールド名を表示

from django.forms import ErrorList

class MyForm(forms.Form):
    name = forms.CharField()

    def clean_name(self):
        value = self.cleaned_data['name']
        if len(value) < 3:
            raise ValidationError('名前は3文字以上入力してください')

error_list = ErrorList()
error_list.template_name_text = 'forms/custom_error_list.html'

# テンプレートファイル: forms/custom_error_list.html

{% for error in errors %}
<p>{{ error }} (フィールド名: {{ form.field_errors.get(error.field) }})</p>
{% endfor %}

エラーメッセージの種類によってスタイルを変更

from django.forms import ErrorList

class MyForm(forms.Form):
    name = forms.CharField()

    def clean_name(self):
        value = self.cleaned_data['name']
        if len(value) < 3:
            raise ValidationError('名前は3文字以上入力してください')

error_list = ErrorList()
error_list.template_name_text = 'forms/custom_error_list.html'

# テンプレートファイル: forms/custom_error_list.html

{% for error in errors %}
{% if error.error_type == 'non_field_errors' %}
<p class="non_field_errors">{{ error }}</p>
{% else %}
<p class="{{ error.field }}">{{ error }}</p>
{% endif %}
{% endfor %}

Bootstrapと組み合わせてエラーメッセージを表示

from django.forms import ErrorList

class MyForm(forms.Form):
    name = forms.CharField()

    def clean_name(self):
        value = self.cleaned_data['name']
        if len(value) < 3:
            raise ValidationError('名前は3文字以上入力してください')

error_list = ErrorList()
error_list.template_name_text = 'forms/custom_error_list.html'

# テンプレートファイル: forms/custom_error_list.html

{% for error in errors %}
<div class="alert alert-danger">
    {{ error }}
</div>
{% endfor %}

補足

• 上記のサンプルコードは、あくまで基本的な例です。必要に応じて、自由にカスタマイズしてください。
• forms.ErrorListクラスの詳細については、Django公式ドキュメントを参照してください。

Django forms.ErrorList.template_name_text 以外の方法

テンプレートタグを使用する

{% for error in form.errors %} テンプレートタグを使用して、エラーメッセージをループ処理できます。

{% for error in form.errors %}
<p>{{ error }}</p>
{% endfor %}

{% if form.errors %} テンプレートタグを使用して、エラーメッセージがある場合のみ表示できます。

{% if form.errors %}
<div class="error-messages">
    {% for error in form.errors %}
    <p>{{ error }}</p>
    {% endfor %}
</div>
{% endif %}

カスタムフォームクラスを作成する

clean_errors() メソッドをオーバーライドして、エラーメッセージの表示をカスタマイズできます。

from django.forms import Form

class MyForm(Form):
    name = forms.CharField()

    def clean_errors(self):
        errors = super().clean_errors()
        for error in errors:
            error.message = 'エラーメッセージ: ' + error.message
        return errors

JavaScriptを使用して、エラーメッセージを動的に表示/非表示できます。

<script>
function showErrors(errors) {
    // エラーメッセージを表示する処理
}

// フォーム送信時の処理
document.getElementById('my-form').addEventListener('submit', function(event) {
    event.preventDefault();

    var form = document.getElementById('my-form');
    var errors = form.errors;

    if (errors.length > 0) {
        showErrors(errors);
    } else {
        // フォーム送信処理
    }
});
</script>

• シンプルなカスタマイズの場合は、テンプレートタグを使用するのが簡単です。
• より複雑なカスタマイズの場合は、カスタムフォームクラスを作成するか、JavaScriptを使用する必要があります。