1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
from django.forms.formsets import formset_factory
from django.forms.models import inlineformset_factory, modelformset_factory
from django.http import HttpResponseRedirect
from django.views.generic.base import ContextMixin, TemplateResponseMixin, View
from django.views.generic.detail import (
SingleObjectMixin,
SingleObjectTemplateResponseMixin,
)
from django.views.generic.list import (
MultipleObjectMixin,
MultipleObjectTemplateResponseMixin,
)
class BaseFormSetFactory(object):
"""
Base class for constructing a FormSet from `formset_factory` in a view.
Calling `construct_formset` calls all other methods.
"""
initial = []
form_class = None
formset_class = None
prefix = None
formset_kwargs = {}
factory_kwargs = {}
def construct_formset(self):
"""
Returns an instance of the formset
"""
formset_class = self.get_formset()
return formset_class(**self.get_formset_kwargs())
def get_initial(self):
"""
Returns a copy of the initial data to use for formsets on this view.
"""
return self.initial[:]
def get_prefix(self):
"""
Returns the prefix used for formsets on this view.
"""
return self.prefix
def get_formset_class(self):
"""
Returns the formset class to use in the formset factory
"""
return self.formset_class
def get_form_class(self):
"""
Returns the form class to use with the formset in this view
"""
return self.form_class
def get_formset(self):
"""
Returns the formset class from the formset factory
"""
return formset_factory(self.get_form_class(), **self.get_factory_kwargs())
def get_formset_kwargs(self):
"""
Returns the keyword arguments for instantiating the formset.
"""
kwargs = self.formset_kwargs.copy()
kwargs.update({"initial": self.get_initial(), "prefix": self.get_prefix()})
if self.request.method in ("POST", "PUT"):
kwargs.update(
{"data": self.request.POST.copy(), "files": self.request.FILES}
)
return kwargs
def get_factory_kwargs(self):
"""
Returns the keyword arguments for calling the formset factory
"""
kwargs = self.factory_kwargs.copy()
if self.get_formset_class():
kwargs["formset"] = self.get_formset_class()
return kwargs
class FormSetMixin(BaseFormSetFactory, ContextMixin):
"""
A view mixin that provides a way to show and handle a single formset in a request.
"""
success_url = None
def get_success_url(self):
"""
Returns the supplied URL.
"""
if self.success_url:
url = self.success_url
else:
# Default to returning to the same page
url = self.request.get_full_path()
return url
def formset_valid(self, formset):
"""
If the formset is valid redirect to the supplied URL
"""
return HttpResponseRedirect(self.get_success_url())
def formset_invalid(self, formset):
"""
If the formset is invalid, re-render the context data with the
data-filled formset and errors.
"""
return self.render_to_response(self.get_context_data(formset=formset))
class ModelFormSetMixin(FormSetMixin, MultipleObjectMixin):
"""
A view mixin that provides a way to show and handle a single model formset
in a request.
Uses `modelformset_factory`.
"""
exclude = None
fields = None
def get_formset_kwargs(self):
"""
Returns the keyword arguments for instantiating the formset.
"""
kwargs = super().get_formset_kwargs()
kwargs["queryset"] = self.get_queryset()
return kwargs
def get_factory_kwargs(self):
"""
Returns the keyword arguments for calling the formset factory
"""
kwargs = super().get_factory_kwargs()
kwargs.setdefault("fields", self.fields)
kwargs.setdefault("exclude", self.exclude)
if self.get_form_class():
kwargs["form"] = self.get_form_class()
return kwargs
def get_formset(self):
"""
Returns the formset class from the model formset factory
"""
return modelformset_factory(self.model, **self.get_factory_kwargs())
def formset_valid(self, formset):
"""
If the formset is valid, save the associated models.
"""
self.object_list = formset.save()
return super().formset_valid(formset)
class BaseInlineFormSetFactory(BaseFormSetFactory):
"""
Base class for constructing a FormSet from `inlineformset_factory` in a view.
Calling `construct_formset` calls all other methods.
"""
model = None
inline_model = None
exclude = None
fields = None
def get_inline_model(self):
"""
Returns the inline model to use with the inline formset
"""
return self.inline_model
def get_formset_kwargs(self):
"""
Returns the keyword arguments for instantiating the formset.
"""
kwargs = super().get_formset_kwargs()
kwargs["instance"] = self.object
return kwargs
def get_factory_kwargs(self):
"""
Returns the keyword arguments for calling the formset factory
"""
kwargs = super().get_factory_kwargs()
kwargs.setdefault("fields", self.fields)
kwargs.setdefault("exclude", self.exclude)
if self.get_form_class():
kwargs["form"] = self.get_form_class()
return kwargs
def get_formset(self):
"""
Returns the formset class from the inline formset factory
"""
return inlineformset_factory(
self.model, self.get_inline_model(), **self.get_factory_kwargs()
)
class InlineFormSetMixin(BaseInlineFormSetFactory, SingleObjectMixin, FormSetMixin):
"""
A view mixin that provides a way to show and handle a single inline formset
in a request.
"""
def formset_valid(self, formset):
self.object_list = formset.save()
return super().formset_valid(formset)
class ProcessFormSetView(View):
"""
A mixin that processes a formset on POST.
"""
def get(self, request, *args, **kwargs):
"""
Handles GET requests and instantiates a blank version of the formset.
"""
formset = self.construct_formset()
return self.render_to_response(self.get_context_data(formset=formset))
def post(self, request, *args, **kwargs):
"""
Handles POST requests, instantiating a formset instance with the passed
POST variables and then checked for validity.
"""
formset = self.construct_formset()
if formset.is_valid():
return self.formset_valid(formset)
else:
return self.formset_invalid(formset)
# PUT is a valid HTTP verb for creating (with a known URL) or editing an
# object, note that browsers only support POST for now.
def put(self, *args, **kwargs):
return self.post(*args, **kwargs)
class BaseFormSetView(FormSetMixin, ProcessFormSetView):
"""
A base view for displaying a formset
"""
class FormSetView(TemplateResponseMixin, BaseFormSetView):
"""
A view for displaying a formset, and rendering a template response
"""
class BaseModelFormSetView(ModelFormSetMixin, ProcessFormSetView):
"""
A base view for displaying a model formset
"""
def get(self, request, *args, **kwargs):
self.object_list = self.get_queryset()
return super().get(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
self.object_list = self.get_queryset()
return super().post(request, *args, **kwargs)
class ModelFormSetView(MultipleObjectTemplateResponseMixin, BaseModelFormSetView):
"""
A view for displaying a model formset, and rendering a template response
"""
class BaseInlineFormSetView(InlineFormSetMixin, ProcessFormSetView):
"""
A base view for displaying an inline formset for a queryset belonging to
a parent model
"""
def get(self, request, *args, **kwargs):
self.object = self.get_object()
return super().get(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
self.object = self.get_object()
return super().post(request, *args, **kwargs)
class InlineFormSetView(SingleObjectTemplateResponseMixin, BaseInlineFormSetView):
"""
A view for displaying an inline formset for a queryset belonging to a parent model
"""
|
