Django CheckboxSelectMultipleで、複数の選択を反映して、モデルに保存したい

Question

Django　CheckboxSelectMultipleで、複数の選択をリストとして、またはそれが不可能ならば、後で加工しやすい形（カンマ区切りの文字列等）でモデルに保存したいと考えています。

下記のコードを試し、複数のデータをチェックしても、１つのデータ（"バナナ"だけ）しか入らないです。
どのようにしたら、複数選択した全てをリストとして、またはカンマ区切りの文字列等、後から加工しやすい形でモデルに保存できるでしょうか。

models.py

class Food(models.Model):
    class Meta:
      db_table = 'Food'

    food = models.CharField('食べ物', blank=True, max_length=100)

forms.py

class FoodForm(forms.Form):

   FOOD_CHOICES = [("りんご","りんご"),("バナナ","バナナ"),("シャケ","シャケ")]

   food = forms.ChoiceField(
        label='食べ物',
        widget=forms.CheckboxSelectMultiple,
        choices=FOOD_CHOICES,
        required=True,
    )

class FoodRecordForm(forms.ModelForm):

  class Meta:
        model = Food
        fields = ['food']

<form action="{% url 'logicsettei' %}" method="post">
        {% csrf_token %}
        {{form}}                           

  <tr><td></td><td><input type="submit" value="登録する" id="test"></td></tr>
</form>

views.py

def foodsettei(request):
    if(request.method == 'POST'):
        form = FoodForm()
        obj = Food()
        friend = FoodRecordForm(request.POST, instance=obj)
        friend.save()
        # return redirect(to='/hello/food')

    else:'
        form = FoodForm()
        friend = ''

    params = {
    'form':form
    }

    return render(request,'hello/food.html',params)

環境
Python 3.6.5
Django'2.0.2'
macbook

Answer 1

下記のコードを試し、複数のデータをチェックしても、１つのデータ（"バナナ"だけ）しか入らないです。

view のコードを載せられていませんが、フォームで送信された値を保存する処理はどのようにされていますか？そこの処理をどのようにするかがポイントだと思いますので、そのコードをご共有いただくと具体的な回答がもらえやすくなると思います。

ざっくりとしたイメージとしては、あくまでも CharField をお使いになりたいのであれば、フォームで送信された値を join 等して Food.food に格納する形になるでしょうか。

イメージ:

# views.py のフォーム送信データをオゾンする処理の一部:
Food.objects.create(food=',',join(form.cleaned_data["food"]))

モデルの見直しも含めて考えられるのであれば、 FOOD_CHOICES で作られている選択肢を別のモデルとして作られて、 Food.food はそのモデルを参照する ManyToManyField として作られる形もありではないかと思います。そうすると Food に対する ModelForm がある程度自動的に複数選択機能を実現してくれるはずです。

• https://docs.djangoproject.com/en/2.1/topics/db/examples/many_to_many/

また、少し古くて Django 2.x に対応していないかもしれませんが（ググって見つけただけなので、動作確認していません）、次の使えそうなパッケージ等もあるようです。

• https://github.com/goinnn/django-multiselectfield

追記 2018/11/01 21:43:

以下、 2018/11/01 19:12 にいただいたコメントに対する回答です。

Food.objects.create(food=',',join(form.cleaned_data["food"]))を書いて実行すると、
下記のエラーメッセージが出てしまいます。
'Food' object has no attribute 'cleaned_data'

cleaned_data は Form インスタンスのアトリビュートなのですが、そのエラーが出るということは Food のインスタンスに対して cleaned_data アトリビュートにアクセスしようとされているのだと思います。そうではないので、以下読み進めてください。

cleaned_dataという処理をやっていないためだと思います。上記に示したコードで書き換えると、どのようなコードになりますでしょうか？

cleaned_data は Form.is_valid() を呼び出して成功したときにセットされるアトリビュートです。ですので、通常のライフサイクルでは form.is_valid() が True だったときに利用するものです。詳しくは公式のドキュメントの次の場所をご覧ください:

• https://docs.djangoproject.com/en/2.1/ref/forms/api/#accessing-clean-data

「 上記に示したコードで書き換えると、どのようなコードになりますでしょうか？ 」への回答としては、次のようなイメージになるでしょうか（なるべく原形を残すように努めました）。

# views.py:
def foodsettei(request):
    if request.method == 'POST':
        form = FoodForm(request.POST)
        if form.is_valid():
            selected_foods = form.cleaned_data["food"]
            Food.objects.create(food=','.join(selected_foods))
            # return redirect(to='/hello/food')
    else:
        form = FoodForm()
    params = {
      'form': form,
    }

    return render(request, 'hello/food.html', params)

そして、申し訳ありません、最初に回答させていただいたときに気づかなかったのですが、 FoodForm の方も少し変更していただく必要があります。ウィジェットに CheckboxSelectMultiple を使うのであれば、 ChoiceField だとバリデーション（つまり form.is_valid() ）が通らなくなるので、代わりに MultipleChoiceField を使用してみてください。

# forms.py:
class FoodForm(forms.Form):
    FOOD_CHOICES = [("りんご", "りんご"), ("バナナ", "バナナ"), ("シャケ", "シャケ")]

    food = forms.MultipleChoiceField(
        label='食べ物',
        widget=forms.CheckboxSelectMultiple,
        choices=FOOD_CHOICES,
        required=True,
    )

これで私の手元では正しく動いたのですが、いかがでしょうか。ご参考になれば幸いです。

Comments

[MitMc]

貴重な情報をありがとうございます。全て試してみます。

[MitMc]

Food.objects.create(food=',',join(form.cleaned_data["food"]))を書いて実行すると、
下記のエラーメッセージが出てしまいます。
cleaned_dataという処理をやっていないためだと思います。上記に示したコードで書き換えると、どのようなコードになりますでしょうか？
'Food' object has no attribute 'cleaned_data'

[gh640]

最後にいただいたコメントに対する返信を回答の末尾に追記しました。ご覧になってみてください。

[MitMc]

ありがとうございます！
早速試してみます。

[MitMc]

頂いたコードを参考に自分のプログラムに適用し、望んだ動作になりました。
forms.MultipleChoiceFieldと、','.join(....)　の考えがとても助かりました。
どうもありがとうございました。

[gh640]

そうですか！それはよかったです :)
ChoiceField と CheckboxSelectMultiple の組み合わせは一見動くように見えるから要注意、でしたね。私も勉強になりました。