Django Extra Views - The missing class-based generic views for Django
Django-extra-views is a Django package which introduces additional class-based views in order to simplify common design patterns such as those found in the Django admin interface.
Full documentation is available at read the docs.
Installation
Install the stable release from pypi (using pip):
pip install django-extra-views
Or install the current master branch from github:
pip install -e git://github.com/AndrewIngram/django-extra-views.git#egg=django-extra-views
Then add 'extra_views' to your INSTALLED_APPS:
INSTALLED_APPS = [
...
'extra_views',
...
]
Features
FormSetandModelFormSetviews - The formset equivalents ofFormViewandModelFormView.InlineFormSetView- Lets you edit a formset related to a model (using Django'sinlineformset_factory).CreateWithInlinesViewandUpdateWithInlinesView- Lets you edit a model and multiple inline formsets all in one view.GenericInlineFormSetView, the equivalent ofInlineFormSetViewbut forGenericForeignKeys.- Support for generic inlines in
CreateWithInlinesViewandUpdateWithInlinesView. - Support for naming each inline or formset in the template context with
NamedFormsetsMixin. SortableListMixin- Generic mixin for sorting functionality in your views.SearchableListMixin- Generic mixin for search functionality in your views.SuccessMessageMixinandFormSetSuccessMessageMixin- Generic mixins to display success messages after form submission.
Still to do
Add support for pagination in ModelFormSetView and its derivatives, the goal being to be able to mimic the change_list view in Django's admin. Currently this is proving difficult because of how Django's MultipleObjectMixin handles pagination.
Quick Examples
FormSetView
Define a FormSetView, a view which creates a single formset from django.forms.formset_factory and adds it to the context.
from extra_views import FormSetView
from my_forms import AddressForm
class AddressFormSet(FormSetView):
form_class = AddressForm
template_name = 'address_formset.html'
Then within address_formset.html, render the formset like this:
<form method="post">
...
{{ formset }}
...
<input type="submit" value="Submit" />
</form>
ModelFormSetView
Define a ModelFormSetView, a view which works as FormSetView but instead renders a model formset using django.forms.modelformset_factory.
from extra_views import ModelFormSetView
class ItemFormSetView(ModelFormSetView):
model = Item
fields = ['name', 'sku']
template_name = 'item_formset.html'
CreateWithInlinesView or UpdateWithInlinesView
Define CreateWithInlinesView and UpdateWithInlinesView, views which render a form to create/update a model instance and its related inline formsets. Each of the InlineFormSetFactory classes use similar class definitions as the ModelFormSetView.
from extra_views import CreateWithInlinesView, UpdateWithInlinesView, InlineFormSetFactory
class ItemInline(InlineFormSetFactory):
model = Item
fields = ['sku', 'price', 'name']
class ContactInline(InlineFormSetFactory):
model = Contact
fields = ['name', 'email']
class CreateOrderView(CreateWithInlinesView):
model = Order
inlines = [ItemInline, ContactInline]
fields = ['customer', 'name']
template_name = 'order_and_items.html'
class UpdateOrderView(UpdateWithInlinesView):
model = Order
inlines = [ItemInline, ContactInline]
fields = ['customer', 'name']
template_name = 'order_and_items.html'
Then within order_and_items.html, render the formset like this:
<form method="post">
...
{{ form }}
{% for formset in inlines %}
{{ formset }}
{% endfor %}
...
<input type="submit" value="Submit" />
</form>
=3.5" is a better way to declare Python compatibility">
![[Feature] Use slug fields instead of pk in formset templates](https://avatars.githubusercontent.com/u/26400787?v=4)
1 Dec 08, 2021
0 Aug 30, 2022
1 Feb 08, 2022
107 Dec 12, 2022
5.6k Jan 01, 2023
1 Nov 19, 2021
1 Jan 19, 2022
1 Nov 08, 2021
408 Jan 06, 2023
3 Sep 14, 2022
1.7k Jan 01, 2023
360 Jan 05, 2023
2 Feb 14, 2022
2 Jan 09, 2022
378 Jan 01, 2023
12 Jun 04, 2022
1 Dec 09, 2021
3 Sep 03, 2022
8 Jan 14, 2022
0 Jun 23, 2022