class FormMixin

from django.views.generic.edit import FormMixin
A mixin that provides a way to show and handle a form in a request.

Attributes

  Defined in
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, re-render the context data with the
data-filled form and errors.
110
111
112
113
114
115
def form_invalid(self, form):
    """
    If the form is invalid, re-render the context data with the
    data-filled form and errors.
    """
    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.
104
105
106
107
108
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.
117
118
119
120
121
122
123
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(FormMixin, self).get_context_data(**kwargs)

ContextMixin

22
23
24
25
def get_context_data(self, **kwargs):
    if 'view' not in kwargs:
        kwargs['view'] = self
    return kwargs

def get_form(self, form_class=None): FormMixin

Returns an instance of the form to be used in this view.
68
69
70
71
72
73
74
def get_form(self, form_class=None):
    """
    Returns 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

Returns the form class to use in this view
62
63
64
65
66
def get_form_class(self):
    """
    Returns the form class to use in this view
    """
    return self.form_class

def get_form_kwargs(self): FormMixin

Returns the keyword arguments for instantiating the form.
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def get_form_kwargs(self):
    """
    Returns 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

Returns the initial data to use for forms on this view.
50
51
52
53
54
def get_initial(self):
    """
    Returns the initial data to use for forms on this view.
    """
    return self.initial.copy()

def get_prefix(self): FormMixin

Returns the prefix to use for forms on this view
56
57
58
59
60
def get_prefix(self):
    """
    Returns the prefix to use for forms on this view
    """
    return self.prefix

def get_success_url(self): FormMixin

Returns the supplied success URL.
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get_success_url(self):
    """
    Returns the supplied success URL.
    """
    if self.success_url:
        # Forcing possible reverse_lazy evaluation
        url = force_text(self.success_url)
    else:
        raise ImproperlyConfigured(
            "No URL to redirect to. Provide a success_url.")
    return url