如何在 Django 中向 ModelForm 添加外键字段？

Posted 2023-02-23

【中文标题】如何在 Django 中向 ModelForm 添加外键字段？

【英文标题】：How do I add a Foreign Key Field to a ModelForm in Django?

【发布时间】：2011-08-08 04:42:03

【问题描述】：

我想做的是显示一个表单，让用户：

输入文档标题（来自Document 模型） 从下拉列表中选择他们的user_defined_code 选项之一（由UserDefinedCode 模型填充） 输入unique_code（存储在Code 模型中）

我不确定如何在表单中显示外键关系的字段。我知道在视图中您可以使用 document.code_set（例如）访问当前 document 对象的相关对象，但我不确定如何将其应用于 ModelForm。

我的模特：

class UserDefinedCode(models.Model):
    name = models.CharField(max_length=8)
    owner = models.ForeignKey(User)

class Code(models.Model):
    user_defined_code = models.ForeignKey(UserDefinedCode)
    unique_code = models.CharField(max_length=15)

class Document(models.Model):
    title = models.CharField(blank=True, null=True, max_length=200)
    code = models.ForeignKey(Code)
    active = models.BooleanField(default=True)

我的模型表单

class DocumentForm(ModelForm):
    class Meta:
        model = Document

【参考方案1】：

关于在表单中显示外键字段，您可以使用 forms.ModelChoiceField 并将其传递给查询集。

所以，forms.py：

class DocumentForm(forms.ModelForm):
    class Meta:
        model = Document

    def __init__(self, *args, **kwargs):
        user = kwargs.pop('user','')
        super(DocumentForm, self).__init__(*args, **kwargs)
        self.fields['user_defined_code']=forms.ModelChoiceField(queryset=UserDefinedCode.objects.filter(owner=user))

views.py：

def someview(request):
    if request.method=='post':
        form=DocumentForm(request.POST, user=request.user)
        if form.is_valid():
            selected_user_defined_code = form.cleaned_data.get('user_defined_code')
            #do stuff here
    else:
        form=DocumentForm(user=request.user)

    context =  'form':form, 

    return render_to_response('sometemplate.html', context, 
        context_instance=RequestContext(request))

根据您的问题：

我知道在一个视图中你可以使用 document.code_set（例如）到 访问相关对象 当前文档对象，但我不是 确定如何将其应用于 ModelForm。

实际上，您的 Document 对象不会有 .code_set，因为 FK 关系是在您的文档模型中定义的。它定义了与Code 的多对一关系，这意味着每个Code 对象可以有许多Document 对象，而不是相反。您的Code 对象将具有.document_set。您可以从文档对象中执行的操作是访问与使用 document.code 相关的 Code。

编辑：我认为这会满足您的需求。 （未经测试）

forms.py：

class DocumentForm(forms.ModelForm):
    class Meta:
        model = Document
        exclude = ('code',)

    def __init__(self, *args, **kwargs):
        user = kwargs.pop('user','')
        super(DocumentForm, self).__init__(*args, **kwargs)
        self.fields['user_defined_code']=forms.ModelChoiceField(queryset=UserDefinedCode.objects.filter(owner=user))
        self.fields['unique_code']=forms.CharField(max_length=15)

views.py：

def someview(request):
    if request.method=='post':
        form=DocumentForm(request.POST, user=request.user)
        if form.is_valid():
            uniquecode = form.cleaned_data.get('unique_code')
            user_defined_code = form.cleaned_data.get('user_defined_code')
            doc_code = Code(user_defined_code=user_defined_code, code=uniquecode)
            doc_code.save()
            doc = form.save(commit=False)
            doc.code = doc_code
            doc.save()
            return HttpResponse('success')
    else:
        form=DocumentForm(user=request.user)

    context =  'form':form, 

    return render_to_response('sometemplate.html', context, 
        context_instance=RequestContext(request))

实际上，您可能希望在创建 Code 对象而不是 this 时使用 get_or_create。

doc_code = Code(user_defined_code=user_defined_code, code=uniquecode)

【讨论】：

感谢您的帮助。我阅读了 ModelChoiceField 的文档，现在很有意义。您知道我将如何显示 unique_code 字段的 CharField（我的问题中的第三个要点）吗？我已经稍微精简了我的模型以使它们更易于阅读，但基本上我有一个文档，该文档被分配了一个计算机生成的唯一文档代码。每个用户都可以创建一个单独的用户代码，作为前缀附加到他们拥有的所有文档的文档代码中，这就是多个模型的原因。

还有一些其他的事情需要知道，比如预填充小部件（通过get_initial() 在视图中）

在__init__ 中分配给self.fields['user_defined_code'] 是丑陋的，但通常是无法避免的：将user_defined_code = ModelChoiceField(...) 声明为类属性会更好，但这几乎不可能，因为queryset参数通常需要一些在表单类声明时不可用的东西。