Django checkboxがNoneの場合のみis_valid()がFalseになってしまいます.

Question

実現したいこと

・checkboxの値がNoneの状態でforms.pyのis_valid()を通したいです.

前提

学習目的でCustomUserモデルを管理するフォームをAdmin無しで作成しております.
一つ詰まってしまった点で, タイトルの通り, checkboxがNoneの場合のみis_valid()がFalseになってしまいます.

・usernameとemailは変更してもis_valid()を通ります.
・問題のis_activeとis_staffも共にTrueであればis_valid()を通ります.
・is_activeとis_staffのいずれかがNoneの場合, is_valid()がFalseとなります.

発生している問題・エラーメッセージ

エラーメッセージは何も出ません.

該当のソースコード

### models.py ###

class User(AbstractBaseUser, PermissionsMixin):
    username = models.CharField(max_length=50)
    email = models.EmailField(max_length=150, unique=True)
    # password =      # AbstractBaseUserがフィールドを持つので追記不要.
    # is_superuser =        # PermissionMixinがフィールドを持つので追記不要.
    is_staff = models.BooleanField(default=False)
    is_active = models.BooleanField(default=False)
    create_at = models.DateTimeField(default=datetime.datetime.now())
    modified_at = models.DateTimeField(null=True, blank=True)

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['username'] 
    
    objects = UserManager()

    def __str__(self):
        return self.username

### forms.py ###

class UpdateuserForm(forms.ModelForm):
    username = forms.CharField(label='ユーザー名', max_length=50)
    email = forms.EmailField(label='メールアドレス', max_length=150)
    is_active = forms.BooleanField()
    is_staff = forms.BooleanField()

    class Meta():
        model = User
        fields = ('username', 'email', 'is_active', 'is_staff')

### views.py ###
@login_required
def manage_user(request):
    obj = User.objects.all()
    update_user_form = UpdateuserForm(request.POST or None)
    ctx = {
        'user_objects': obj,
        'update_form': update_user_form,
    }

    if 'user_edit_submit' in request.POST:
        logger.info({                                                      # logging
            'action': 'user_edit_submit in request.POST',
            'status': 'run',
            'value': {
                'request.POST: ': request.POST,
            }
        })
        terget_obj = get_object_or_404(User, id=request.POST['id'])
        update_user_form = UpdateuserForm(request.POST, instance=terget_obj)

        if update_user_form.is_valid():
            logger.info({                                                      # logging
                'action': 'update_user_form.is_valid()',
                'status': 'run',
                'value': {
                    'cleaned_data': update_user_form.cleaned_data
                }
            })
            update_user_form.save()
            return redirect('account:manage_user')
        else:
            logger.warning({                                                      # logging
                'action': 'update_user_form.is_valid()',
                'status': 'failed',
                'request.POST': request.POST,
                'message': 'updateformにinstanceを渡していますか？',
            })

    return render(request, 'admin/manage_user.html', ctx)

{% for user_object in user_objects %}
    <ul>
        <li>{{ user_object.username }}</li>
        <li>...</li>        <- リスト表示しているだけなので省略します. ->
    </ul>
    <form method="post">
    {% csrf_token %}
        <input type="text" name="username" value="{{ user_object.username }}">
        <input type="email" name="email" value="{{ user_object.email }}">
        <- 問題のチェックボックスです ->
        <input type="checkbox" name="is_active" {% if user_object.is_active == True %}checked{% endif %}>    
        <input type="checkbox" name="is_staff" {% if user_object.is_staff == True %}checked{% endif %}>
        <- ここまで ->
        <input type="hidden" name="id" value="{{ user_object.id }}">
        <input type="submit" name="user_edit_submit" value="変更">
     </form>
{% endfor %}

試したこと

・文字列がいけないのかと思いBoolean型をrequest.POST['is_active']...にrequest.POST._mutableで無理矢理渡しましたが同じ動作(前提に箇条書きした条件の通りの動作です.).
・inputのvalue値で hiddenでFalse, チェックボックスon時でTrueをpostするようにしたところ同じ動作.
・checkboxのcheckedが悪さをしているかと思い外して上記を試したところ同じ動作.

補足情報（FW/ツールのバージョンなど）

docker v4.15 (python:3 のイメージでビルドしております.)
Python 3.11.1
Django 4.1.2

試したことの後３時間ほど調べたのですが, 自力での解決が難しいと考えました.
お力添えくださると幸いです.

Answer 1

django.forms.BooleanFieldはrequired=Falseが必須のようです。

widget=django.forms.CheckboxInputとして自動でレンダリングさせるとわかりますが、このフラグがHTMLのinput要素のrequired属性と連動しています。つまり設計意図としては、BooleanFieldがデフォルトのrequired=Trueな場合、HTML的にはチェックボックスがチェックされない限り、ブラウザが送信そのものを行わない指定になるということです。そのため、Falseなのに送られてきたらis_validは当然Falseになるという理屈になります。

なので、チェックしていない結果を送信したい場合、BooleanFieldにrequired=Falseが必要になります。

検証用環境構築コード

venvで作った環境に簡単な検証コードを書いてみました。ご参考までに。

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==4.1.7', 'whatthepatch==1.0.4'])
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..e2e4514
--- /dev/null
+++ b/myapp/forms.py
@@ -0,0 +1,4 @@
+from django import forms
+class HogeForm(forms.Form):
+     checkbox = forms.BooleanField(widget=forms.CheckboxInput, initial=False)
+     textbox = forms.CharField(widget=forms.TextInput, initial='ほげ')
diff --git a/myapp/templates/myapp/form.html b/myapp/templates/myapp/form.html
new file mode 100644
index 0000000..4028860
--- /dev/null
+++ b/myapp/templates/myapp/form.html
@@ -0,0 +1,7 @@
+<form action="{% url 'form' %}" method="post">
+{% csrf_token %}
+{{ form.checkbox }} チェックボックス<br>
+{{ form.textbox }} 文字列<br>
+<input type="submit" name="submit" value="送信">
+</form>
+
diff --git a/myapp/urls.py b/myapp/urls.py
new file mode 100644
index 0000000..d12653a
--- /dev/null
+++ b/myapp/urls.py
@@ -0,0 +1,6 @@
+from django.urls import path
+from . import views
+
+urlpatterns = [
+    path('', views.index, name='form'),
+]
diff --git a/myapp/views.py b/myapp/views.py
index 91ea44a..32d73c5 100644
--- a/myapp/views.py
+++ b/myapp/views.py
@@ -1,3 +1,11 @@
 from django.shortcuts import render
+from django.http import HttpResponse
+from .forms import HogeForm
+
+def index(request):
+    form = HogeForm(request.POST or None)
+    if request.method == 'POST':
+        if form.is_valid():
+            print('成功')
+    return render(request, 'myapp/form.html', {'form': form})
 
-# Create your views here.
diff --git a/mysite/settings.py b/mysite/settings.py
index a73b6e4..4851a48 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',
@@ -103,9 +104,9 @@ AUTH_PASSWORD_VALIDATORS = [
 # Internationalization
 # https://docs.djangoproject.com/en/4.1/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = 'ja'
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = 'Asia/Tokyo'
 
 USE_I18N = True
 
diff --git a/mysite/urls.py b/mysite/urls.py
index 8bc0cd4..d2fd81c 100644
--- a/mysite/urls.py
+++ b/mysite/urls.py
@@ -14,8 +14,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:
               os.makedirs(os.path.dirname(header.new_path))
            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'])

フォームとビューのコード抜粋

mysite/myapp/forms.py

from django import forms
class HogeForm(forms.Form):
     checkbox = forms.BooleanField(widget=forms.CheckboxInput, initial=False)
     textbox = forms.CharField(widget=forms.TextInput, initial='ほげ')

mysite/myapp/views.py

from django.shortcuts import render
from django.http import HttpResponse
from .forms import HogeForm

def index(request):
    form = HogeForm(request.POST or None)
    if request.method == 'POST':
        if form.is_valid():
            print('成功')
    return render(request, 'myapp/form.html', {'form': form})

mysite/myapp/templates/myapp/form.html

<form action="{% url 'form' %}" method="post">
{% csrf_token %}
{{ form.checkbox }} チェックボックス<br>
{{ form.textbox }} 文字列<br>
<input type="submit" name="submit" value="送信">
</form>

動作のために必要な修正

mysite/myapp/forms.py

from django import forms
class HogeForm(forms.Form):
     # checkbox = forms.BooleanField(widget=forms.CheckboxInput, initial=False)
     checkbox = forms.BooleanField(widget=forms.CheckboxInput, initial=False, required=False)
     textbox = forms.CharField(widget=forms.TextInput, initial='ほげ')

Comments

[Tatsuya1192]

>> BooleanFieldがデフォルトのrequired=Trueな場合、HTML的にはチェックボックスがチェックされない限り、ブラウザが送信そのものを行わない指定になるということです。

こういう挙動になるのですね!
チェックが外れればNoneが返されるのでよく考えれば確かにそうでした...
勉強になりました.
とても助かります!

[dameo]

他の人のための補足です。質問者さんがおっしゃっているのはこの部分の話ですね。
https://developer.mozilla.org/ja/docs/Web/HTML/Element/input/checkbox
> メモ: フォームが送信されたときにチェックボックスがチェックされていなかった場合、チェックされていない状態を表す値 (value=unchecked など) が送信されることはなく、値はサーバーに全く送信されません。

なので、django側にフォームとして送信されるデータの中で、チェックボックスのinput要素のname属性に指定される値は、チェックされていない場合には付加されず、djangoはそのname属性をキーとした値を聞かれるとNoneを返すということです。

私が言ってたのはrequired=Trueのとき、input要素のrequired属性もTrueになり(HTMLで属性名のみは真偽値の真を意味します)、チェックされない限りsubmitされない(ポップアップが出て送信できない)ということです。私のコードではチェックボックスは自動でレンダリングされてますが、
{{ form.checkbox }}
質問者さんのコードでは、自動でレンダリングしていないため
<input type="checkbox" name="is_active" {% if user_object.is_active == True %}checked{% endif %}>
BooleanFieldのrequired属性に連動させずに、input要素のrequired属性を外すことができているため、submitは出来ています。私のコード(required=True)で無理矢理submitさせるためには、ブラウザの開発者ツールで、直接input要素のrequired属性を外してあげる必要があります。

なお、付記しようか迷ったのですが、フォームフィールドにMultipleChoiceFieldを使い、ウィジェットにCheckboxSelectMultipleを使い、各要素にvalue属性も設定することで、複数選択可能なラジオボタンのような使い方も可能です。この場合はデフォルトだと最低1個選択で送信可能になります。