ccbv.co.uk

class FormMixin

from django.views.generic.edit import FormMixin
Hierarchy diagram Documentation Source code 
Provide a way to show and handle a form in a request.

Ancestors (MRO)

  1. FormMixin
  2. ContextMixin

Attributes

  Defined in
extra_context = None ContextMixin
form_class = None FormMixin
initial = {} FormMixin
prefix = None FormMixin
success_url = None FormMixin
Expand Collapse

Methods

def form_invalid(self, form): FormMixin 

If the form is invalid, render the invalid form.
67
68
69
def form_invalid(self, form):
    """If the form is invalid, render the invalid form."""
    return self.render_to_response(self.get_context_data(form=form))

def form_valid(self, form): FormMixin 

If the form is valid, redirect to the supplied URL.
63
64
65
def form_valid(self, form):
    """If the form is valid, redirect to the supplied URL."""
    return HttpResponseRedirect(self.get_success_url())

def get_context_data(self, **kwargs):

FormMixin

 
Insert the form into the context dict.
71
72
73
74
75
def get_context_data(self, **kwargs):
    """Insert the form into the context dict."""
    if "form" not in kwargs:
        kwargs["form"] = self.get_form()
    return super().get_context_data(**kwargs)

ContextMixin

 
28
29
30
31
32
def get_context_data(self, **kwargs):
    kwargs.setdefault("view", self)
    if self.extra_context is not None:
        kwargs.update(self.extra_context)
    return kwargs

def get_form(self, form_class=None): FormMixin 

Return an instance of the form to be used in this view.
35
36
37
38
39
def get_form(self, form_class=None):
    """Return an instance of the form to be used in this view."""
    if form_class is None:
        form_class = self.get_form_class()
    return form_class(**self.get_form_kwargs())

def get_form_class(self): FormMixin 

Return the form class to use.
31
32
33
def get_form_class(self):
    """Return the form class to use."""
    return self.form_class

def get_form_kwargs(self): FormMixin 

Return the keyword arguments for instantiating the form.
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def get_form_kwargs(self):
    """Return the keyword arguments for instantiating the form."""
    kwargs = {
        "initial": self.get_initial(),
        "prefix": self.get_prefix(),
    }
    if self.request.method in ("POST", "PUT"):
        kwargs.update(
            {
                "data": self.request.POST,
                "files": self.request.FILES,
            }
        )
    return kwargs

def get_initial(self): FormMixin 

Return the initial data to use for forms on this view.
23
24
25
def get_initial(self):
    """Return the initial data to use for forms on this view."""
    return self.initial.copy()

def get_prefix(self): FormMixin 

Return the prefix to use for forms.
27
28
29
def get_prefix(self):
    """Return the prefix to use for forms."""
    return self.prefix

def get_success_url(self): FormMixin 

Return the URL to redirect to after processing a valid form.
57
58
59
60
61
def get_success_url(self):
    """Return the URL to redirect to after processing a valid form."""
    if not self.success_url:
        raise ImproperlyConfigured("No URL to redirect to. Provide a success_url.")
    return str(self.success_url)  # success_url may be lazy