django-viewsdjango-class-based-viewsdjango-filter

Simple example of how to use a class based view and django-filter?


The example in the documentation, https://django-filter.readthedocs.org/en/latest/usage.html, is I think for a function based view. I am currently researching how to do this with a class based view.

def product_list(request):
    f = ProductFilter(request.GET, queryset=Product.objects.all())
    return render_to_response('my_app/template.html', {'filter': f})

Solution

  • A bit more digging and I have managed to answer it. I have used the code from here https://github.com/rasca/django-enhanced-cbv.

    I added the contents of list.py into my main app as main_app/filter_mixin.py

    Then in the app I was adding a search to the list view I added the file filter.py like this (identical to documentation)

    from django_filters import FilterSet
    from .models import Contact
    
    
    class ContactFilter(FilterSet):
        class Meta:
            model = Contact
            fields = ['name_first', 'name_last']
    

    Now the view.py becomes:

    from vanilla import ListView
    
    from .filter import ContactFilter
    from galleria.filter_mixin import ListFilteredMixin
    
    
    class ContactList(ListFilteredMixin, ListView):
        filter_set = ContactFilter