Django Form コンポーネント
Django Form コンポーネントは、ページの初期化、HTMLタグの生成に使用され、さらにユーザーが送信したデータの検証(エラーメッセージの表示)も行えます。
エラーメッセージの表示順序:
- まずフィールド属性のエラーメッセージを表示し、次にローカルフックのエラーメッセージを表示します。
- フィールド属性のエラーメッセージが表示された場合、ローカルフックのエラーメッセージは表示されません。
- グローバルフックがある場合、グローバルフックはすべてのデータの検証が完了してから検証を開始し、グローバルフックのエラーメッセージは必ず表示されます。
Form コンポーネントを使用するには、まず forms をインポートする必要があります:
from django import forms

次に、app01 ディレクトリに My_forms.py を作成します:
app01/My_forms.py
from django import forms
from django.core.exceptions import ValidationError
from app01 import models
class EmpForm(forms.Form):
name = forms.CharField(min_length=4, label="氏名", error_messages={"min_length": "短すぎます", "required": "このフィールドは空にできません!"})
age = forms.IntegerField(label="年齢")
salary = forms.DecimalField(label="給与")
from django.core.exceptions import ValidationError
from app01 import models
class EmpForm(forms.Form):
name = forms.CharField(min_length=4, label="氏名", error_messages={"min_length": "短すぎます", "required": "このフィールドは空にできません!"})
age = forms.IntegerField(label="年齢")
salary = forms.DecimalField(label="給与")
フィールド属性:
- label:入力ボックスの前のテキスト情報。
- error_message:カスタム表示エラーメッセージ。属性値は辞書で、required は空にできない場合に表示されるエラーメッセージのキーです。
app01/views.py
from django.shortcuts import render, HttpResponse
from app01.My_Forms import EmpForm
from app01 import models
from django.core.exceptions import ValidationError
# Create your views here.
def add_emp(request):
if request.method == "GET":
form = EmpForm()
return render(request, "add_emp.html", {"form": form})
else:
form = EmpForm(request.POST)
if form.is_valid(): # データ検証を実行
# 検証成功
data = form.cleaned_data # 検証に成功した値は、cleaned_data に格納されます。
data.pop('r_salary')
print(data)
models.Emp.objects.create(**data)
return HttpResponse(
'ok'
)
# return render(request, "add_emp.html", {"form": form})
else:
print(form.errors) # エラーメッセージを出力
clean_errors = form.errors.get("__all__")
print(222, clean_errors)
return render(request, "add_emp.html", {"form": form, "clean_errors": clean_errors})
from app01.My_Forms import EmpForm
from app01 import models
from django.core.exceptions import ValidationError
# Create your views here.
def add_emp(request):
if request.method == "GET":
form = EmpForm()
return render(request, "add_emp.html", {"form": form})
else:
form = EmpForm(request.POST)
if form.is_valid(): # データ検証を実行
# 検証成功
data = form.cleaned_data # 検証に成功した値は、cleaned_data に格納されます。
data.pop('r_salary')
print(data)
models.Emp.objects.create(**data)
return HttpResponse(
'ok'
)
# return render(request, "add_emp.html", {"form": form})
else:
print(form.errors) # エラーメッセージを出力
clean_errors = form.errors.get("__all__")
print(222, clean_errors)
return render(request, "add_emp.html", {"form": form, "clean_errors": clean_errors})
app01/urls.py ファイルに以下のルールを追加します:
path('add_emp/', views.add_emp)
HTML テンプレート:
app01/add_emp.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
<h3>従業員を追加</h3>{#1、自分でHTMLページを手動で書く#}<form action="" method="post">
<p>氏名:<input type="text" name="name"></p>
<p>年齢:<input type="text" name="age"></p>
<p>給与:<input type="text" name="salary"></p>
<input type="submit">
</form>{#2、formオブジェクトのas_pメソッドで実装#}
{#<form action="" method="post" novalidate>#}
{# {% csrf_token %}#}
{# {{ form.as_p }}#}
{# <input type="submit">#}
{#</form>#}
{#3、formオブジェクトのフィールドを手動で取得#}
{#<form action="" method="post" novalidate>#}
{# {% csrf_token %}#}
{# <div>#}
{# <label for="id_{{ form.name.name }}">氏名</label>#}
{# {{ form.name }} <span>{{ form.name.errors.0 }}</span>#}
{# </div>#}
{# <div>#}
{# <label for="id_{{ form.age.name }}">年齢</label>#}
{# {{ form.age }} <span>{{ form.age.errors.0 }}</span>#}
{# </div>#}
{# <div>#}
{# <label for="id_salary">給与</label>#}
{# {{ form.salary }} <span>{{ form.salary.errors.0 }}</span>#}
{# </div>#}
{# <input type="submit">#}
{#</form>#}
{#4、forループですべてのフィールドを表示#}
{#<form action="" method="post" novalidate>#}
{# {% csrf_token %}#}
{# {% for field in form %}#}
{# <div>#}
{# <label for="id_{{ field.name }}">{{ field.label }}</label>#}
{# {{ field }} <span>{{ field.errors.0 }}</span>#}
{# </div>#}
{# {% endfor %}#}
{# <input type="submit">#}
{#</form>#}
</body>
</html>
実行結果は次の図のようになります:

ローカルフックとグローバルフック
Form クラスを定義:
app01/My_forms.py
from django import forms
from django.core.exceptions import ValidationError
from app01 import models
class EmpForm(forms.Form):
name = forms.CharField(min_length=5, label="氏名", error_messages={"required": "このフィールドは空にできません!",
"min_length": "ユーザー名が短すぎます。"})
age = forms.IntegerField(label="年齢")
salary = forms.DecimalField(max_digits=5, decimal_places=2, label="給与")
r_salary = forms.DecimalField(max_digits=5, decimal_places=2, label="給与をもう一度入力してください")
def clean_name(self): # ローカルフック
val = self.cleaned_data.get("name")
if val.isdigit():
raise ValidationError("ユーザー名は数字だけにできません")
elif models.Emp.objects.filter(name=val):
raise ValidationError("ユーザー名は既に存在します!")
else:
return val
def clean(self): # グローバルフック 2回入力した給与が一致するか確認します。
val = self.cleaned_data.get("salary")
r_val = self.cleaned_data.get("r_salary")
if val == r_val:
return self.cleaned_data
else:
raise ValidationError("給与が一致するか確認してください。")
from django.core.exceptions import ValidationError
from app01 import models
class EmpForm(forms.Form):
name = forms.CharField(min_length=5, label="氏名", error_messages={"required": "このフィールドは空にできません!",
"min_length": "ユーザー名が短すぎます。"})
age = forms.IntegerField(label="年齢")
salary = forms.DecimalField(max_digits=5, decimal_places=2, label="給与")
r_salary = forms.DecimalField(max_digits=5, decimal_places=2, label="給与をもう一度入力してください")
def clean_name(self): # ローカルフック
val = self.cleaned_data.get("name")
if val.isdigit():
raise ValidationError("ユーザー名は数字だけにできません")
elif models.Emp.objects.filter(name=val):
raise ValidationError("ユーザー名は既に存在します!")
else:
return val
def clean(self): # グローバルフック 2回入力した給与が一致するか確認します。
val = self.cleaned_data.get("salary")
r_val = self.cleaned_data.get("r_salary")
if val == r_val:
return self.cleaned_data
else:
raise ValidationError("給与が一致するか確認してください。")
views.py ファイルのコード:
app01/views.py
def add_emp(request):
if request.method == "GET":
form = EmpForm() # formオブジェクトを初期化
return render(request, "add_emp.html", {"form":form})
else:
form = EmpForm(request.POST) # データをformオブジェクトに渡す
if form.is_valid(): # 検証を実行
data = form.cleaned_data
data.pop("r_salary")
models.Emp.objects.create(**data)
return redirect("/index/")
else: # 検証失敗
clear_errors = form.errors.get("__all__") # グローバルフックのエラーメッセージを取得
return render(request, "add_emp.html", {"form": form, "clear_errors": clear_errors})
if request.method == "GET":
form = EmpForm() # formオブジェクトを初期化
return render(request, "add_emp.html", {"form":form})
else:
form = EmpForm(request.POST) # データをformオブジェクトに渡す
if form.is_valid(): # 検証を実行
data = form.cleaned_data
data.pop("r_salary")
models.Emp.objects.create(**data)
return redirect("/index/")
else: # 検証失敗
clear_errors = form.errors.get("__all__") # グローバルフックのエラーメッセージを取得
return render(request, "add_emp.html", {"form": form, "clear_errors": clear_errors})
テンプレートファイルのコードは次のとおりです:
app01/add_emp.html
<form action="" method="post" novalidate>
{% csrf_token %}
<div>
<label for="id_{{ form.name.name }}">氏名</label>
{{ form.name }} <span>{{ form.name.errors.0 }}</span>
</div>
<div>
<label for="id_{{ form.age.name }}">年齢</label>
{{ form.age }} <span>{{ form.age.errors.0 }}</span>
</div>
<div>
<label for="id_salary">給与</label>
{{ form.salary }} <span>{{ form.salary.errors.0 }}{{ clear_errors.0 }}</span>
</div>
<div>
<label for="id_r_salary">給与をもう一度入力してください</label>
{{ form.r_salary }} <span>{{ form.r_salary.errors.0 }}{{ clear_errors.0 }}</span>
</div>
<input type="submit">
</form>
実行結果は次の図のようになります:

