【Django】フォームの作成：forms.pyにフォームクラスを定義する（forms.Form）

１．forms.pyを作成する

アプリケーションフォルダ内にforms.pyを作成します。

Djangoアプリケーションのファイル階層構造は次のようになっています。

作成したforms.pyにフォームクラスを定義して、そのフォームクラスを使ってテンプレートにフォームを表示させます。

２．forms.Formを継承したフォームクラスを定義する

フォームクラスとは、テンプレートに簡単にフォームを表示するための仕組みの一つです。

フォームクラスはdjango.forms.Formのサブクラスとして定義します。
そのためforms.pyの先頭では以下のようにdjango.formsをインポートします。

そしてフォームクラスを定義する際は、forms.Formを継承します。

いきなりモデルの話をしますが、models.py内に作成するModelクラスは、１つ以上のフィールドを定義します。
これらフィールドはデータベースのカラムデータの型に対応します。

from django.db import models

class Person(models.Model):
    first_name = models.CharField(blank=True, max_length=50)
    last_name = models.CharField(blank=True, max_length=50)
    paid_member = models.BooleanField()

【django】モデルのフィールドについて：フィールドの型・オプション一覧

フォームクラスでも、Modelクラスのようにフィールドを定義します。
このforms.Formを継承して生成するフォームクラスのフィールドは、HTML上の<imput>タグに対応します。

フィールドとは簡単に言うと、データの種類を表すための型であると言えます。

フォームクラスのフィールドは次のように定義します。

ちなみにModelFormではモデルのフィールドと<input>タグが対応するようになります。

ここまで解説してきたフォ－ムクラスの定義をまとめると、フォームは次のように定義するということがわかります。

from django import forms

class クラス名(forms.Form):
    変数 = forms.フィールドの型(オプション)
    変数 = forms.フィールドの型(オプション)
    変数 = forms.フィールドの型(オプション)

フォームクラス定義の例

forms.Formを利用したフォームクラスを定義する例を下記に記します。
ここでは会員登録する際に使用するフォームを定義しています。

from django import forms

class MemberForm(forms.Form):
    first_name = forms.CharField(label= "名前")
    last_name = forms.CharField(label= "苗字")
    address = forms.CharField(label="住所")
    age = forms.IntegerField(label= "年齢")
    Mail = forms.EmailField(label="メールアドレス")

上記例ではMemberFormクラスを定義しています。
その中に各種フィールドを定義しています。

このフォームクラスで使うフィールドは多くの種類が用意されています。
上記例ではテキスト入力のためのCharField、整数値入力のためのIntegerField、メールアドレス入力のためのEmailFieldを使用しています。

forms.Formを利用するメリットである、細かな設定を行うにはフィールドの種類（型）や引数の使い方を身に着けておく必要があります。
フィールドや引数については以下記事で詳しく解説しています。

【django】モデルのフィールドについて：フィールドの型・オプション一覧

３．views.py：テンプレートにフォームクラスを渡す

views.pyでは、forms.pyで定義したフォームクラスを引き継いで、テンプレートにそのフォームクラスを渡す記述をします。

下記にそのコードを記します。

from django.shortcuts import render
from .forms import MemberForm

def index(request):
    form = MemberForm()
    context = {'form': form,}
    return render(request, 'five/index.html', context)

まずviews.pyの先頭でforms.pyからMemberFormをインポートします。

そして関数内でそのフォームクラスをインスタンス化します。
インスタンス化したフォームクラスを変数に入れて、render()メソッドを利用してテンプレートに渡しています。

４．テンプレート（HTMLファイル）にフォームを表示させる

テンプレート（HTMLファイル）にviews.pyから渡されたフォームクラスを利用して、フォームを表示します。

下記にフォーム部分を抜粋したテンプレートを記します。

<h2>会員登録フォーム</h2>
<form class="" action="" method="post" enctype="multipart/form-data">
    {% csrf_token %}
    {{ form.as_p }}
    <button type="submit" name="submit">Submit</button>
</form>

{{ form.as_p }}

{{ form.as_p }}によりフォームをテンプレートに表示しています。
formはインスタンス化したフォームクラスを入れた変数を指定します。

as_pとは、formの各要素（inputタグ）をpタグで囲むことを意味しています。

{% csrf_token %}

{% csrf_token %}はCSRF（クロスサイトリクエストフォージェリ）を検証する仕組みです。

Djangoのフォーム送信では、この記述がないとエラーになりますので、必ず記述するようにしましょう。