如何基于Django表单初始值为复选框字段添加自定义属性？

要实现需求，需要自定义Checkbox组件（Widget）来控制渲染时的属性，具体步骤如下：

1. 自定义Checkbox Widget #

继承Django内置的CheckboxInput，重写其render方法，根据传入的值动态添加对应属性：

from django.forms.widgets import CheckboxInput

class CustomCheckboxInput(CheckboxInput):
    def render(self, name, value, attrs=None, renderer=None):
        attrs = attrs or {}
        # 当传入值为'on'时，添加checked和data-initial属性
        if value == 'on':
            attrs['checked'] = 'checked'
            attrs['data-initial'] = 'on'
        # 空数据时确保移除checked属性，避免默认选中
        elif value in (None, ''):
            attrs.pop('checked', None)
        return super().render(name, value, attrs, renderer)

2. 在表单中使用自定义Widget #

修改MyForm，将real字段的widget指定为自定义的CustomCheckboxInput：

from django.forms import Form, BooleanField

class MyForm(Form):
    real = BooleanField(widget=CustomCheckboxInput())

效果验证 #

• 当通过MyForm(data={'real': 'on'})实例化时，渲染出的HTML为：<input type="checkbox" checked="checked" data-initial="on" name="real" id="id_real">
• 当通过MyForm(data={})实例化时，渲染出的HTML为：<input type="checkbox" name="real" id="id_real">

内容的提问来源于stack exchange，提问作者Paul R