Djangoでrequest.POST.getlistができず、TypeError が出る。

Question

実現したいこと

Django forms.MultipleChoiceField を使って、複数の選択結果を request.POST.getlist によってリスト表示したい。

発生している問題・分からないこと

TypeError at /ｘｘｘｘｘ
can only concatenate str (not "list") to str

が出て、実現したいことができない。

該当のソースコード

#forms.py

from django import forms

class PyForm(forms.Form):
    sc = [
        ('肉', 'にく'),
        ('魚', 'さかな'),
        ('米', 'ごはん'),
        ('野菜', 'やさい'),
        ('汁物', 'しるもの'),
        ('漬物', 'つけもの'),
    ]
    multi_choice=forms.MultipleChoiceField(label='食べたもの複数選択可', choices=sc, \
                                           widget=forms.SelectMultiple(attrs={
                                               'size':6,'class':'form-select'
                                               }))


#views.py

from django.shortcuts import render
from . forms import PyForm

def choices(request):
    template = 'choices.html'
    context = {
        'title': 'mul_choice', #パス
        'goto': 'mul_choices', #name
        'message': None,
        'form': PyForm(),
    }

    if 'multi_choice' in request.POST:
        ch = request.POST.getlist('multi_choice')
        context['message'] = '食べたものは: '+ch
        context['form'] = PyForm(request.POST) 

    return render(request, template, context)

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

GitHab等で似たような質問、回答があったが、問題のポイントが違うようだ。

補足

選択テーブルはブラウザに表示されるが、
そもそも、選択テーブルで一つの項目しか選べない。
そこで、request.POST.get('multi_choice') とやると、エラーは出ず、選んだもの一つを表示する。
forms.pyにある複数選択のコマンドのどこかに問題があり、複数選べていない模様。

Answer 1

原因

そもそもフォームデータの取得方法がおかしい
https://docs.djangoproject.com/ja/5.0/ref/forms/api/

対策

views.py

from django.shortcuts import render
from . forms import PyForm

def choices(request):
    template = 'choices.html'
    context = {
        'title': 'mul_choice', #パス
        'goto': 'mul_choices', #name
        'message': None,
        'form': PyForm(),
    }

    if request.method == "POST":
        form = PyForm(request.POST)
        if form.is_valid():
            selected = form.cleaned_data['multi_choice']
            context['message'] = '食べたものは: '+','.join(selected)
            context['form'] = form

    return render(request, template, context)

環境構築

私が試した環境を再現するためのものです。
django系のコードは再現コードがないと同じ話が出来ない場合が多いので。

venv下に実行環境を構築するpythonスクリプトです。ubuntuの場合事前にpython3-venvパッケージが必要です。
スクリプトを空のディレクトリに例えばcreate_env.pyという名前で保存し、python3 create_env.py(windowsの場合はpython)すると構築されます。

import os
import venv
import subprocess
ENV = 'env'
if os.name == 'posix':
    BIN = 'bin'
else:
    BIN = 'Scripts'
builder = venv.EnvBuilder(with_pip=True)
builder.create(ENV)
cwd = os.getcwd()
python = os.path.join(cwd, ENV, BIN, 'python')
os.environ['VIRTUAL_ENV'] = os.path.join(cwd, ENV)
os.environ['PATH'] = os.path.join(cwd, ENV, BIN) + os.pathsep + os.environ['PATH']
p = subprocess.run([python, '-m', 'pip', 'install', '--upgrade', 'pip', 'setuptools'])
p = subprocess.run([python, '-m', 'pip', 'install', 'django==5.0.2', 'whatthepatch==1.0.5'])
with open('generated.py', 'wt', encoding='utf8') as f:
    f.write("""\
import subprocess
import os
p = subprocess.run('django-admin startproject mysite', shell=True)
os.chdir('mysite')
p = subprocess.run('python manage.py startapp myapp', shell=True)
p = subprocess.run('python ../patch.py ../patch.diff', shell=True)
""")
with open('patch.diff', 'wt', encoding='utf8') as f:
    f.write("""\
diff --git a/myapp/forms.py b/myapp/forms.py
new file mode 100644
index 0000000..2784dd8
--- /dev/null
+++ b/myapp/forms.py
@@ -0,0 +1,15 @@
+from django import forms
+
+class PyForm(forms.Form):
+    sc = [
+        ('肉', 'にく'),
+        ('魚', 'さかな'),
+        ('米', 'ごはん'),
+        ('野菜', 'やさい'),
+        ('汁物', 'しるもの'),
+        ('漬物', 'つけもの'),
+    ]
+    multi_choice=forms.MultipleChoiceField(label='食べたもの複数選択可', choices=sc, \\
+                                           widget=forms.SelectMultiple(attrs={
+                                               'size':6,'class':'form-select'
+                                               }))
diff --git a/myapp/templates/choices.html b/myapp/templates/choices.html
new file mode 100644
index 0000000..2c8026c
--- /dev/null
+++ b/myapp/templates/choices.html
@@ -0,0 +1,6 @@
+<form method="post">
+    {% csrf_token %}
+    {{ form }}
+    <div>{{ message }}</div>
+    <input type="submit" value="Submit">
+</form>
diff --git a/myapp/urls.py b/myapp/urls.py
new file mode 100644
index 0000000..def718a
--- /dev/null
+++ b/myapp/urls.py
@@ -0,0 +1,7 @@
+from django.urls import path
+from . import views
+
+urlpatterns = [
+    path('', views.choices, name='choices'),
+]
+
diff --git a/myapp/views.py b/myapp/views.py
index 91ea44a..f61d001 100644
--- a/myapp/views.py
+++ b/myapp/views.py
@@ -1,3 +1,20 @@
 from django.shortcuts import render
+from . forms import PyForm
 
-# Create your views here.
+def choices(request):
+    template = 'choices.html'
+    context = {
+        'title': 'mul_choice', #パス
+        'goto': 'mul_choices', #name
+        'message': None,
+        'form': PyForm(),
+    }
+
+    if request.method == "POST":
+        form = PyForm(request.POST)
+        if form.is_valid():
+            selected = form.cleaned_data['multi_choice']
+            context['message'] = '食べたものは: '+','.join(selected)
+            context['form'] = form
+
+    return render(request, template, context)
diff --git a/mysite/settings.py b/mysite/settings.py
index 2f5eb34..addc95d 100644
--- a/mysite/settings.py
+++ b/mysite/settings.py
@@ -31,6 +31,7 @@ ALLOWED_HOSTS = []
 # Application definition
 
 INSTALLED_APPS = [
+    'myapp.apps.MyappConfig',
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
diff --git a/mysite/urls.py b/mysite/urls.py
index dedacdb..687084f 100644
--- a/mysite/urls.py
+++ b/mysite/urls.py
@@ -15,8 +15,9 @@ Including another URLconf
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 \"\"\"
 from django.contrib import admin
-from django.urls import path
+from django.urls import include, path
 
 urlpatterns = [
+    path('myapp/', include('myapp.urls')),
     path('admin/', admin.site.urls),
 ]
""")
with open('patch.py', 'wt', encoding='utf8') as f:
    f.write("""\
import whatthepatch, os, sys
with open(sys.argv[1], 'rt', encoding='utf8') as fp:
    for diff in whatthepatch.parse_patch(fp):
        header = diff.header
        if header.new_path == '/dev/null':
            os.remove(header.old_path)
        else:
            if header.old_path == '/dev/null':
                old = []
            else:
                with open(header.old_path, 'rt', encoding='utf8') as fo:
                    old = [line.rstrip(os.linesep) for line in fo]
            new = whatthepatch.apply_diff(diff, old)
            try:
               dirpath = os.path.dirname(header.new_path)
               if dirpath != "":
                   os.makedirs(dirpath)
            except FileExistsError:
               pass
            with open(header.new_path, 'wt', encoding='utf8') as fn:
                for line in new:
                    print(line, file=fn)
""")
p = subprocess.run([python, 'generated.py'])

使い方

$ . env/bin/activate # windowsの場合は.\env\Scripts\activate
$ cd mysite
$ python manage.py runserver
...
^C
$ deactivate

Comments

[oono]

ご教示ありがとうございます。
解決いたしました。
ただ、小生の場合、もっと基本的な単純な誤りだったようです。
views.pyの以下のコマンドの中で
context['message'] = '食べたものは: '+ch
の部分　str(ch)　としたら、解決しました。

if 'multi_choice' in request.POST:
ch = request.POST.getlist('multi_choice')
context['message'] = '食べたものは: '+ch　→　context['message'] = '食べたものは: '+str(ch)
context['form'] = PyForm(request.POST)

[退会済みユーザー]

エラーになっている直接の原因はlist型であることなわけですが、リクエストパラメータを直に見てしまっているので、validationが効いていない値になっており、見方そのものが正しくないのです。私の書いた方法だとリクエストパラメータを元にフォームオブジェクトを構築し、それをvalidateした上でリクエストパラメータではなく、フォームに対してきちんとした値を聞いているので、正しい方法になります。

正しい方法の詳細は回答にあるリンク先を読んでください。

[退会済みユーザー]

あとこの表示方法で複数選ぶにはCtrlキーを押しながら選択する必要があります。

[退会済みユーザー]

例えばchoices関数に、@csrf_exemptデコレータを付けてCSRFを無効化し、ブラウザではなくコマンドラインから
$ wget -O - --post-data 'multi_choice=beaf' 'http://localhost:8000/myapp/'
などとすると、リストにない選択肢の'beaf'を送る事ができます。私の方法だとvalidationが機能するので、is_valid()に失敗して受け取りません(messageはNoneのまま)が、あなたの方法ではそのまま受け取ってしまって、beafと表示されてしまいます。

[oono]

回答ありがとうございます。
dameo様のやり方も試し、実行できました。非常に参考になりました。ご丁寧な説明感謝。