class FormView
from django.views.generic import FormView
A view for displaying a form, and rendering a template response.
Ancestors (MRO)
Attributes
Defined in | |
---|---|
content_type = None
|
TemplateResponseMixin |
form_class = None
|
FormMixin |
http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']
|
View |
initial = {}
|
FormMixin |
prefix = None
|
FormMixin |
response_class = <class 'django.template.response.TemplateResponse'>
|
TemplateResponseMixin |
success_url = None
|
FormMixin |
template_engine = None
|
TemplateResponseMixin |
template_name = None
|
TemplateResponseMixin |
Methods
def
__init__(self, **kwargs):
View
¶
def
__init__(self, **kwargs):
View
¶
Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.
36 37 38 39 40 41 42 43 44 | def __init__(self, **kwargs):
"""
Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.
"""
# Go through keyword arguments, and either save their values to our
# instance, or raise an error.
for key, value in six.iteritems(kwargs):
setattr(self, key, value)
|
def
_allowed_methods(self):
View
¶
def
_allowed_methods(self):
View
¶
106 107 | def _allowed_methods(self):
return [m.upper() for m in self.http_method_names if hasattr(self, m)]
|
def
as_view(cls, **initkwargs):
View
¶
def
as_view(cls, **initkwargs):
View
¶
Main entry point for a request-response process.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 | @classonlymethod
def as_view(cls, **initkwargs):
"""
Main entry point for a request-response process.
"""
for key in initkwargs:
if key in cls.http_method_names:
raise TypeError("You tried to pass in the %s method name as a "
"keyword argument to %s(). Don't do that."
% (key, cls.__name__))
if not hasattr(cls, key):
raise TypeError("%s() received an invalid keyword %r. as_view "
"only accepts arguments that are already "
"attributes of the class." % (cls.__name__, key))
def view(request, *args, **kwargs):
self = cls(**initkwargs)
if hasattr(self, 'get') and not hasattr(self, 'head'):
self.head = self.get
self.request = request
self.args = args
self.kwargs = kwargs
return self.dispatch(request, *args, **kwargs)
view.view_class = cls
view.view_initkwargs = initkwargs
# take name and docstring from class
update_wrapper(view, cls, updated=())
# and possible attributes set by decorators
# like csrf_exempt from dispatch
update_wrapper(view, cls.dispatch, assigned=())
return view
|
def
dispatch(self, request, *args, **kwargs):
View
¶
def
dispatch(self, request, *args, **kwargs):
View
¶
80 81 82 83 84 85 86 87 88 | def dispatch(self, request, *args, **kwargs):
# Try to dispatch to the right method; if a method doesn't exist,
# defer to the error handler. Also defer to the error handler if the
# request method isn't on the approved list.
if request.method.lower() in self.http_method_names:
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
return handler(request, *args, **kwargs)
|
def
form_invalid(self, form):
FormMixin
¶
def
form_invalid(self, form):
FormMixin
¶
If the form is invalid, re-render the context data with the data-filled form and errors.
81 82 83 84 85 86 | 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
¶
def
form_valid(self, form):
FormMixin
¶
If the form is valid, redirect to the supplied URL.
75 76 77 78 79 | def form_valid(self, form):
"""
If the form is valid, redirect to the supplied URL.
"""
return HttpResponseRedirect(self.get_success_url())
|
def
get(self, request, *args, **kwargs):
ProcessFormView
¶
def
get(self, request, *args, **kwargs):
ProcessFormView
¶
Handles GET requests and instantiates a blank version of the form.
170 171 172 173 174 | def get(self, request, *args, **kwargs):
"""
Handles GET requests and instantiates a blank version of the form.
"""
return self.render_to_response(self.get_context_data())
|
def
get_context_data(self, **kwargs):
¶
def
get_context_data(self, **kwargs):
¶
FormMixin
Insert the form into the context dict.
88 89 90 91 92 93 94 | 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
¶
def
get_form(self, form_class=None):
FormMixin
¶
Returns an instance of the form to be used in this view.
39 40 41 42 43 44 45 | 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
¶
def
get_form_class(self):
FormMixin
¶
Returns the form class to use in this view
33 34 35 36 37 | def get_form_class(self):
"""
Returns the form class to use in this view
"""
return self.form_class
|
def
get_form_kwargs(self):
FormMixin
¶
def
get_form_kwargs(self):
FormMixin
¶
Returns the keyword arguments for instantiating the form.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 | 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
¶
def
get_initial(self):
FormMixin
¶
Returns the initial data to use for forms on this view.
21 22 23 24 25 | def get_initial(self):
"""
Returns the initial data to use for forms on this view.
"""
return self.initial.copy()
|
def
get_prefix(self):
FormMixin
¶
def
get_prefix(self):
FormMixin
¶
Returns the prefix to use for forms on this view
27 28 29 30 31 | def get_prefix(self):
"""
Returns the prefix to use for forms on this view
"""
return self.prefix
|
def
get_success_url(self):
FormMixin
¶
def
get_success_url(self):
FormMixin
¶
Returns the supplied success URL.
63 64 65 66 67 68 69 70 71 72 73 | 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
|
def
get_template_names(self):
TemplateResponseMixin
¶
def
get_template_names(self):
TemplateResponseMixin
¶
Returns a list of template names to be used for the request. Must return a list. May not be called if render_to_response is overridden.
136 137 138 139 140 141 142 143 144 145 146 | def get_template_names(self):
"""
Returns a list of template names to be used for the request. Must return
a list. May not be called if render_to_response is overridden.
"""
if self.template_name is None:
raise ImproperlyConfigured(
"TemplateResponseMixin requires either a definition of "
"'template_name' or an implementation of 'get_template_names()'")
else:
return [self.template_name]
|
def
http_method_not_allowed(self, request, *args, **kwargs):
View
¶
def
http_method_not_allowed(self, request, *args, **kwargs):
View
¶
90 91 92 93 94 95 | def http_method_not_allowed(self, request, *args, **kwargs):
logger.warning(
'Method Not Allowed (%s): %s', request.method, request.path,
extra={'status_code': 405, 'request': request}
)
return http.HttpResponseNotAllowed(self._allowed_methods())
|
def
options(self, request, *args, **kwargs):
View
¶
def
options(self, request, *args, **kwargs):
View
¶
Handles responding to requests for the OPTIONS HTTP verb.
97 98 99 100 101 102 103 104 | def options(self, request, *args, **kwargs):
"""
Handles responding to requests for the OPTIONS HTTP verb.
"""
response = http.HttpResponse()
response['Allow'] = ', '.join(self._allowed_methods())
response['Content-Length'] = '0'
return response
|
def
post(self, request, *args, **kwargs):
ProcessFormView
¶
def
post(self, request, *args, **kwargs):
ProcessFormView
¶
Handles POST requests, instantiating a form instance with the passed POST variables and then checked for validity.
176 177 178 179 180 181 182 183 184 185 | def post(self, request, *args, **kwargs):
"""
Handles POST requests, instantiating a form instance with the passed
POST variables and then checked for validity.
"""
form = self.get_form()
if form.is_valid():
return self.form_valid(form)
else:
return self.form_invalid(form)
|
def
put(self, *args, **kwargs):
ProcessFormView
¶
def
put(self, *args, **kwargs):
ProcessFormView
¶
189 190 | def put(self, *args, **kwargs):
return self.post(*args, **kwargs)
|
def
render_to_response(self, context, **response_kwargs):
TemplateResponseMixin
¶
def
render_to_response(self, context, **response_kwargs):
TemplateResponseMixin
¶
Returns a response, using the `response_class` for this view, with a template rendered with the given context. If any keyword arguments are provided, they will be passed to the constructor of the response class.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | def render_to_response(self, context, **response_kwargs):
"""
Returns a response, using the `response_class` for this
view, with a template rendered with the given context.
If any keyword arguments are provided, they will be
passed to the constructor of the response class.
"""
response_kwargs.setdefault('content_type', self.content_type)
return self.response_class(
request=self.request,
template=self.get_template_names(),
context=context,
using=self.template_engine,
**response_kwargs
)
|