Django フォームデータの取り扱い方 - cleaned_data 以外にも方法がある？

Djangoのforms.Form.cleaned_data

django.forms.forms.Form クラスの cleaned_data 属性は、フォームが検証に成功した後に、すべての検証済みデータを格納する辞書です。この属性は、フォームの送信されたデータにアクセスし、処理するために使用できます。

仕組み

フォームが送信されると、Django はまずすべてのフィールドの値を検証します。すべてのフィールドが検証に合格すると、cleaned_data 属性が作成され、各フィールドの検証済み値が格納されます。

例

次の例では、cleaned_data 属性を使用して、送信された名前とメールアドレスを取得する方法を示します。

from django.forms import Form

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

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            name = form.cleaned_data['name']
            email = form.cleaned_data['email']
            # ...

cleaned_data 属性の利点

• 検証済みデータに安全にアクセスできる
• データ型変換が不要
• 複数フィールドの値をまとめて処理できる

注意点

• cleaned_data 属性は、フォームが検証に成功した場合にのみ使用できる
• cleaned_data 属性は、フォームの送信されたデータのみを含む

Django forms.Form.cleaned_data サンプルコード

基本的な使い方

from django.forms import Form

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

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            name = form.cleaned_data['name']
            email = form.cleaned_data['email']
            # ...

複数フィールドの値をまとめて処理

from django.forms import Form

class MyForm(Form):
    name = forms.CharField()
    email = forms.EmailField()
    age = forms.IntegerField()

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            user_data = {
                'name': form.cleaned_data['name'],
                'email': form.cleaned_data['email'],
                'age': form.cleaned_data['age'],
            }
            # ...

カスタムバリデーション

from django.forms import Form

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

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

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            name = form.cleaned_data['name']
            email = form.cleaned_data['email']
            # ...

ファイルアップロード

from django.forms import Form, FileField

class MyForm(Form):
    name = forms.CharField()
    email = forms.EmailField()
    file = FileField()

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST, request.FILES)
        if form.is_valid():
            name = form.cleaned_data['name']
            email = form.cleaned_data['email']
            file = form.cleaned_data['file']
            # ...

ModelForm

from django.forms import ModelForm
from django.contrib.auth.models import User

class MyForm(ModelForm):
    class Meta:
        model = User
        fields = ['username', 'email']

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            user = form.save()
            # ...

Django forms.Form.cleaned_data 以外の方法

フォームの各フィールドには value 属性があり、送信された値にアクセスできます。ただし、この属性は検証されていない値を含んでいるため、注意が必要です。

from django.forms import Form

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

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        name = form.fields['name'].value
        email = form.fields['email'].value
        # ...

カスタムバリデーション

clean_ メソッドを使用して、カスタムバリデーションを行い、検証済みデータを取得できます。

from django.forms import Form

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

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

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            name = form.cleaned_data['name']
            email = form.cleaned_data['email']
            # ...

シグナル

form_valid シグナルを使用して、フォーム送信後に処理を行うことができます。

from django.forms import Form
from django.dispatch import receiver

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

@receiver(form_valid, sender=MyForm)
def my_form_valid_handler(sender, form, **kwargs):
    name = form.cleaned_data['name']
    email = form.cleaned_data['email']
    # ...

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            form.save()
            # ...

シリアルライザ

django.forms.models モジュールの model_to_dict 関数を使用して、フォームデータを辞書に変換できます。

from django.forms import ModelForm
from django.contrib.auth.models import User

class MyForm(ModelForm):
    class Meta:
        model = User
        fields = ['username', 'email']

def my_view(request):
    if request.method == 'POST':
        form = MyForm(request.POST)
        if form.is_valid():
            user_data = model_to_dict(form.instance)
            # ...

これらの方法は、それぞれ異なる利点と欠点があります。状況に応じて適切な方法を選択してください。