【Django】forms.py：フォームのフィールドの種類（型）と引数一覧

required

required引数により、フォーム入力を必須にするかどうか指定できます。
指定できる値はTrueまたはFalseです。

すべてのフィールド型はデフォルトでrequired=Trueとなっています。
HTMLのinputタグで言うとrequiredが必ず入ります。

そのためNoneや空文字が送信されるとValidationErrorが発生します。

該当のフォームフィールドを任意入力にする場合のみ、引数にrequiredを指定し、値をFalseにします。

label

label引数により、フォームに表示するラベルを指定することができます。

label引数でラベルを指定していない場合は、デフォルトラベルであるフィールド名が表示されます。

class TestForm(forms.Form):
    first_name = forms.CharField()
    last_name = forms.CharField()

label引数で表示したいラベルを指定することで、ユーザーがフォーム入力する際にわかりやすくなります。

class TestrForm(forms.Form):
    first_name = forms.CharField(label="名前")
    last_name = forms.CharField(label="苗字")

HTMLで説明すると、labelタグに指定した文字列が入るようになります。

initial

initial引数により、フォームの初期値を設定することができます。

class TestForm(forms.Form):
    first_name = forms.CharField(initial="OFFICE")
    last_name = forms.CharField(initial="54")

HTMLで説明すると、value属性に指定した値が入力されます。

widget

widget引数により、フォームに表示するウィジェットを操作することができます。

例えばフォームにTextareaを表示したい場合は、CharFieldにwidget=forms.Textareaを指定します。

class TestForm(forms.Form):
    first_name = forms.CharField()
    last_name = forms.CharField()
    comment = forms.CharField(widget=forms.Textarea)

パスワード入力フォームを表示したい場合は、widget=forms.PasswordInputを指定します。

class TestForm(forms.Form):
    first_name = forms.CharField()
    last_name = forms.CharField()
    password = forms.CharField(widget=forms.PasswordInput)

widgetに指定できるウィジェットは以下サイトをご参照ください。

Form Widgets

help_text

help_text引数により、フォーム上に説明テキストを表示することができます。

class TestForm(forms.Form):
    first_name = forms.CharField(help_text="田中 太郎の場合は太郎")
    last_name = forms.CharField(help_text="田中 太郎の場合は田中")

HTMLで説明すると、inputタグの後ろに説明文がspanタグで囲まれて入ります。

error_messages

error_message引数により、フォーム入力でエラーが発生した場合に表示するエラー文を、指定したテキストに上書きできます。

class TestForm(forms.Form):
    first_name = forms.CharField(error_messages={"required": "名前を入力してください"})
    last_name = forms.CharField(error_messages={"required": "苗字を入力してください"})

BooleanField

BooleanFieldのデフォルトウィジェットはCheckboxInputです。
以下のようなチェックボックスを生成します。

返される値はTrueまたはFalseです。

BooleanFieldには使用する際の注意点があります。

フィールドはすべてデフォルトでrequired=Trueのため、デフォルトの状態ではBooleanFieldはTrueしか返すことができないです。

TrueまたはFalseの2値を返すようにしたい場合は、必ずrequired=Falseを指定してください。

CharField

CharFieldのデフォルトウィジェットはTextInputです。
テキストを入力するためのフォームを生成します。

オプション引数として、以下の引数がCharFieldには用意されています。

ChoiceField

ChoiceFieldのデフォルトウィジェットはSelectです。
セレクトボックスを生成します。

オプション引数として、以下の引数がChoiceFieldには用意されています。

ChoiceFieldは次のように使用します。

Number = (
    ("1", "１月"),
    ("2", "２月"),
    ("3", "３月"),
)

class TestForm(forms.Form):
    Checkbox = forms.ChoiceField(choices=Number)

DateField

DateFieldのデフォルトウィジェットはDateInputです。
日付を入力するためのフォームを生成します。

入力された値がdatetime.date、datetime.datetime、または特定の日付形式でフォーマットされた文字列のいずれかであることをバリデーションします。

オプション引数として、以下の引数がDateFieldには用意されています。

DateTimeField

DateTimeFieldのデフォルトウィジェットはDateTimeInputです。
日時を入力するためのフォームを生成します。

入力された値がdatetime.date、datetime.datetime、または特定の日時形式でフォーマットされた文字列のいずれかであることをバリデーションします。

オプション引数として、以下の引数がDateTimeFieldには用意されています。

IntegerField

IntegerFieldのデフォルトウィジェットはNumberInputです。
整数値を入力するためのフォームを生成します。

オプション引数として、以下の引数がIntegerFieldには用意されています。

FloatField

FloatFieldのデフォルトウィジェットはNumberInputです。
整数値または少数を入力するためのフォームを生成します。

オプション引数として、以下の引数がFloatFieldには用意されています。

EmailField

EmailFieldのデフォルトウィジェットはEmailInputです。
メールアドレスを入力するためのフォームを生成します。

正規表現を利用して、入力さえたテキストがメールアドレスかバリデーションします。

オプション引数として、以下の引数がEmailFieldには用意されています。

URLField

URLlFieldのデフォルトウィジェットはURLInputです。
URLを入力するためのフォームを生成します。

入力された値が有効なURLかバリデーションします。

オプション引数として、以下の引数がURLFieldには用意されています。

ImageField

ImagelFieldのデフォルトウィジェットはClearableFileInputです。
画像ファイルのアップロードのためのフォームを生成します。

settings.pyにてMEDIA_ROOTを設定する必要があります。

オプション引数として、以下の引数がImageFieldには用意されています。

FileField

FileFieldのデフォルトウィジェットはClearableFileInputです。
ファイルアップロードのためのフォームを生成します。

settings.pyにてMEDIA_ROOTを設定する必要があります。