博客

详解Django的 get_form() 函数：获取视图所使用的表单实例

  • Post category:Python

get_form()是Django框架中的一个函数，它用于获取当前视图使用的表单类。在Django的基于类视图中，使用get_form()函数可以重载或修改视图中表单的行为或属性。以下是get_form()函数的详细说明和使用方法攻略。

函数说明

get_form()是Django框架中用于获取视图表单类的函数。它默认返回视图中指定的form_class属性，即视图中自定义的表单类。可以通过自定义get_form()函数以生成不同的表单实例来替换默认的表单类，以达到更灵活和多样化的表单效果。

form_class是视图中定义的表单类。如果没有指定form_class，视图会尝试从视图中提供的model属性等情况推断表单类。

使用方法

重载父类的get_form()函数，可以创建在不同情况下使用不同表单的视图。get_form()函数返回的表单实例将用于视图的处理逻辑中。

以下是可用于自定义get_form()函数的重载方法：

from django.views.generic.edit import FormView

class ExampleView(FormView):
    # form_class = ExampleForm
    template_name = 'example.html'

    def get_form_class(self):
        """
        返回视图所需要的表单类。
        """
        if self.request.user.is_authenticated:
            return AuthenticatedUserForm
        else:
            return AnonymousUserForm

    def form_valid(self, form):
        """
        处理表单提交成功时的逻辑。
        """
        form.save()
        return super().form_valid(form)

上述视图重载了get_form_class()函数，使其基于当前用户的认证状态返回不同的表单类。表单实例的构造和处理逻辑保持不变（与默认的表单类一致）。这种方式可以使得视图在调用表单类之后，评估当前情况来动态确定所需表单的类型。

另一个重载方法是使用默认的get_form()函数，但基于视图其他设置来新建一个表单实例。例如，可以利用initial属性提供表单的初始值，使其默认使用GET参数填充表单：

from django.views.generic.edit import FormView
from . import ExampleForm

class ExampleView(FormView):
    # form_class = ExampleForm
    template_name = 'example.html'

    def get_form(self, form_class=None):
        """
        构造替代表单的实例。
        """
        form = super().get_form(form_class)
        form.initial.update(self.request.GET.dict()) # 将GET参数添加到表单实例的初始化期间

        return form

    def form_valid(self, form):
        """
        处理表单提交成功时的逻辑。
        """
        form.save()
        return super().form_valid(form)

上述视图使用默认的get_form()函数，但通过修改表单实例的initial属性来填充表单。这使得表单在初始化时基于默认值和GET参数填充，并保证表单实例始终以相同的方式工作。

实例说明

为了演示如何使用get_form()函数，我们可以看一下有关如何为不同的使用者显示不同类型的表单的例子：

from django.views.generic.edit import FormView
from . import AuthenticatedUserForm, AnonymousUserForm

class ExampleView(FormView):
    # form_class = ExampleForm
    template_name = 'example.html'

    def get_form_class(self):
        """
        返回视图所需要的表单类。
        """
        if self.request.user.is_authenticated:
            return AuthenticatedUserForm
        else:
            return AnonymousUserForm

    def form_valid(self, form):
        """
        处理表单提交成功时的逻辑。
        """
        form.save()
        return super().form_valid(form)

此视图基于当前登录情况，决定哪个表单应该被呈现。如果用户已经成功登录，则使用AuthenticatedUserForm，否则使用AnonymousUserForm。

另一个例子是对GET参数的重载示例。我们假设有一个表单类ExampleForm，其基于以下代码构建而成:

from django import forms

class ExampleForm(forms.Form):
    name = forms.CharField()
    email = forms.EmailField()
    phone = forms.CharField()

现在，我们可以使用以下方法处理GET请求，自定义表单的初始化：

from django.views.generic.edit import FormView
from . import ExampleForm

class ExampleView(FormView):
    form_class = ExampleForm
    template_name = 'example.html'

    def get_form(self, form_class=None):
        """
        构造自定义表单实例。
        """
        form = super().get_form(form_class)
        form.initial.update(self.request.GET.dict()) # 将GET请求参数添加到表单的初始化阶段

        return form

    def form_valid(self, form):
        """
        处理表单提交成功时的逻辑。
        """
        form.save()
        return super().form_valid(form)

此视图使用默认的表单，但依赖于自己定义的get_form()函数来以GET的方式填充表单。

Tags: