Django フォームでエラーチェック: forms.Form.has_error() を徹底解説

メソッドの動作

• False を返す場合
  フォーム全体に エラーが存在しません。
• True を返す場合
  フォーム全体に 少なくとも1つ以上のエラー が存在します。

使用方法

form = MyForm(data=request.POST)

if form.is_valid():
    # フォームデータが有効な場合の処理
    pass
else:
    # フォームデータにエラーが存在する場合の処理
    if form.has_error():
        # フォーム全体にエラーが存在する場合の処理
        pass
    else:
        # フォームフィールドにエラーが存在する場合の処理
        pass

• 非フィールドエラー
  フォーム全体に関連するエラー（非フィールドエラー）は、form.non_field_errors リストを使用して確認できます。このリストには、フォーム全体のバリデーション処理で発生したエラーメッセージが格納されています。
• フォームフィールドごとのエラーチェック
  フォームフィールドごとのエラーチェックは、form.errors 辞書を使用して行うことができます。この辞書には、各フィールドのエラーメッセージがキーと値のペアとして格納されています。

例

以下の例は、forms.Form.has_error() メソッドを使用して、フォーム全体にエラーが存在するかどうかを判断する方法を示しています。

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255)
    email = forms.EmailField()

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            if form.has_error():
                # フォーム全体にエラーが存在する場合の処理
                print('フォーム全体にエラーがあります。')
            else:
                # フォームフィールドにエラーが存在する場合の処理
                print('フォームフィールドにエラーがあります。')

    return render(request, 'my_template.html', {'form': form})

この例では、フォームが送信された場合、form.is_valid() メソッドを使用してフォームデータのバリデーションを行います。バリデーションが成功した場合、# フォームデータが有効な場合の処理 ブロックが実行されます。

一方、バリデーションが失敗した場合、form.has_error() メソッドを使用してフォーム全体にエラーが存在するかどうかを判断します。エラーが存在する場合、# フォーム全体にエラーがあります。 メッセージが出力されます。

エラーが存在しない場合は、form.errors 辞書を使用してフォームフィールドごとのエラーメッセージを確認し、# フォームフィールドにエラーがあります。 メッセージを出力します。

---

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            if form.has_error():
                # フォーム全体にエラーが存在する場合の処理
                print('フォーム全体にエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示
            else:
                # フォームフィールドにエラーが存在する場合の処理
                print('フォームフィールドにエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示

    return render(request, 'my_template.html', {'form': form})

フォームフィールドにエラーが存在する場合

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            if form.has_error():
                # フォーム全体にエラーが存在する場合の処理
                print('フォーム全体にエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示
            else:
                # フォームフィールドにエラーが存在する場合の処理
                print('フォームフィールドにエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示

                # 特定のフィールドのエラーメッセージを取得
                if 'name' in form.errors:
                    name_error = form.errors['name']
                    print(f'name フィールドのエラーメッセージ: {name_error}')

    return render(request, 'my_template.html', {'form': form})

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            if form.has_error():
                # フォーム全体にエラーが存在する場合の処理
                print('フォーム全体にエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示
            else:
                # フォームフィールドにエラーが存在する場合の処理
                print('フォームフィールドにエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示

                # 非フィールドエラーを取得
                if form.non_field_errors:
                    non_field_errors = form.non_field_errors
                    print(f'非フィールドエラー: {non_field_errors}')

    return render(request, 'my_template.html', {'form': form})

---

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            if form.errors:
                # フォーム全体にエラーが存在する場合の処理
                print('フォーム全体にエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示
            else:
                # フォームフィールドにエラーが存在する場合の処理
                print('フォームフィールドにエラーがあります。')
                print(form.errors)  # 各フィールドのエラーメッセージを表示

    return render(request, 'my_template.html', {'form': form})

この方法では、form.has_error() メソッドを使用するよりもコードが簡潔になります。また、各フィールドのエラーメッセージに直接アクセスできるという利点もあります。

form.cleaned_data 辞書を使用する

form.cleaned_data 辞書を使用して、送信されたフォームデータがバリデーションに合格しているかどうかを確認することもできます。この辞書には、バリデーションに合格した各フィールドの値が格納されています。

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            cleaned_data = form.cleaned_data
            name = cleaned_data['name']
            email = cleaned_data['email']
            print(f'名前: {name}')
            print(f'メールアドレス: {email}')
        else:
            # フォームデータにエラーが存在する場合の処理
            print('フォームデータにエラーがあります。')
            print(form.errors)  # 各フィールドのエラーメッセージを表示

    return render(request, 'my_template.html', {'form': form})

この方法では、バリデーションに合格したフォームデータに直接アクセスできるという利点があります。

カスタムバリデーションロジックを使用する

より複雑なバリデーションロジックが必要な場合は、カスタムバリデーションロジックを使用することができます。これを行うには、clean_<field_name> メソッドをフォームクラスに定義します。このメソッドは、送信されたフォームデータをチェックし、エラーが発生した場合は ValidationError 例外を発生させることができます。

from django import forms

class MyForm(forms.Form):
    name = forms.CharField(max_length=255, required=True)
    email = forms.EmailField(required=True)

    def clean_name(self):
        name = self.cleaned_data['name']

        if len(name) < 5:
            raise ValidationError('名前は5文字以上である必要があります。')

        return name

def my_view(request):
    if request.method == 'POST':
        form = MyForm(data=request.POST)

        if form.is_valid():
            # フォームデータが有効な場合の処理
            pass
        else:
            # フォームデータにエラーが存在する場合の処理
            print('フォームデータにエラーがあります。')
            print(form.errors)  # 各フィールドのエラーメッセージを表示

    return render(request, 'my_template.html', {'form': form})

この方法は、より複雑なバリデーションロジックを実装する必要がある場合に役立ちます。