Django中ModelForm的Select字段无法同时显示空标签与编辑选中值的问题

问题背景 #

我有一个基于Product模型（与Type模型为多对一关系）的ModelForm——ProductForm，系统自动生成的外键选择字段功能正常，但想给该Select字段添加空标签。由于empty_label是ModelChoiceField的属性，无法直接在widget的Select配置中设置。手动定义表单字段时，空标签能正常显示，但编辑表单时无法展示已选中的Type值，需要找到同时满足两个需求的方法。

原按文档配置的代码：

class Product(models.Model):
    type= models.ForeignKey(Types, on_delete=models.CASCADE)
    code=models.CharField(max_length=50)
    name=models.CharField(max_length=1000)
    details=models.CharField(max_length=1000)
    um=models.CharField(max_length=50)
    def __str__(self):
        return self.name

class ProductForm(ModelForm):    
    class Meta:
        model = Product
        fields='__all__'
        labels = {
            'code': 'Code',
            'name': 'Product',
            'type':'Product type',
            'um': 'UM',
            'details': 'Details'
        }
        widgets = {
            'code': TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'Code'
                }
            ),
            'name': TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'Product'
                }
            ),
            'um': TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'UM'
                }
            ),
            'type' : Select(attrs={'style':'width: 100%', 'class':'form-control select2bs4'}),
            'details': Textarea(
                attrs={
                    'style':'height:150px',
                    'class':'form-control',
                    'placeholder':'Details'
                }
            ),
        }

手动定义字段的代码（存在编辑时无法显示选中值的问题）：

class ProductForm(ModelForm):
    code= CharField(label='Code',widget=TextInput(attrs={'class':'form-control','placeholder':'Code'}))
    name = CharField(label='Product',widget=TextInput(attrs={'class':'form-control', 'placeholder':'Product'}))
    um = CharField(label='UM',widget=TextInput(attrs={'class':'form-control', 'placeholder':'UM'}))
    type= ModelChoiceField(label='Product Type',queryset=Types.objects.all(), empty_label='Please select one: ', widget=Select(attrs={'style':'width: 100%', 'class':'form-control select2bs4'}), to_field_name='type')
    details = CharField(label='Details',widget=Textarea(attrs={'style':'height:150px', 'class':'form-control', 'placeholder':'Details'}))
    class Meta:
        model = Product
        fields='__all__'

正确解决方案 #

不需要完全手动定义所有字段，只需在ProductForm中重写type字段，设置empty_label和对应的widget，同时保留ModelForm自动处理编辑状态的逻辑：

from django import forms
from .models import Product, Types

class ProductForm(ModelForm):
    # 只重写type字段，设置empty_label和widget
    type = forms.ModelChoiceField(
        label='Product type',
        queryset=Types.objects.all(),
        empty_label='Please select one: ',
        widget=forms.Select(attrs={'style':'width: 100%', 'class':'form-control select2bs4'})
    )
    
    class Meta:
        model = Product
        fields='__all__'
        labels = {
            'code': 'Code',
            'name': 'Product',
            'um': 'UM',
            'details': 'Details'
        }
        widgets = {
            'code': forms.TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'Code'
                }
            ),
            'name': forms.TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'Product'
                }
            ),
            'um': forms.TextInput(
                attrs={
                    'class':'form-control',
                    'placeholder':'UM'
                }
            ),
            'details': forms.Textarea(
                attrs={
                    'style':'height:150px',
                    'class':'form-control',
                    'placeholder':'Details'
                }
            ),
        }

关键说明 #

• 手动定义字段丢失编辑状态的原因：之前的代码中to_field_name='type'参数有误，该参数指定关联模型（Types）中用于匹配的字段，若Types的主键不是type字段，会导致表单无法正确关联已选值，去掉该参数即可解决。
• 只定制需要修改的字段：ModelForm会自动处理其他字段的渲染和数据填充，无需重复定义所有字段，既保留框架便利性，又实现特定字段的定制需求。

内容的提问来源于stack exchange，提问作者Roberto Vargas