How Do You Use Django-filter's '__in' Lookup?

I am using Django REST framework with the django-filter package, but my question is mostly about django-filter. I don't understand how to use filters with '__in' lookup. For exampl

Solution 1:

There's a simple solution with django_filter now:

classBookView(viewsets.ReadOnlyModelViewSet):
   serializer_class = BookSerializer()
   model = Bookfilter_fields= {
      'id': ['exact', 'in'],
      'name': ['exact']
   }

And then you can use it in your query string exactly as you wanted: ?id__in=1,2,3.

Solution 2:

The question is discussed in this issue: https://github.com/alex/django-filter/issues/137#issuecomment-77697870

The suggested solution would be to create a custom filter as follows:

from django_filters import Filter
from django_filters.fields import Lookup

from .models import Product

classListFilter(Filter):
    deffilter(self, qs, value):
        value_list = value.split(u',')
        returnsuper(ListFilter, self).filter(qs, Lookup(value_list, 'in'))

classProductFilterSet(django_filters.FilterSet):
    id = ListFilter(name='id')

    classMeta:
        model = Product
        fields = ['id']

And the you can write the following:

products/?id=7,8,9

Solution 3:

The django-filter provides BaseInFilter to be used in conjunction with other filter classes, such as NumberFilter, CharFilter. This class only validates that the incoming request is comma-separated.So if you're using the Web Browsable API, you can send request as /book/?id__in=1%2C3 where %2C is comma.

filters.py

import django_filters


classNumberInFilter(django_filters.BaseInFilter, django_filters.NumberFilter):
    pass


class BookFilter(django_filters.FilterSet):
    id__in =NumberInFilter(field_name="id", lookup_expr="in")

views.py

from rest_framework import viewsets
from django_filters import rest_framework as filters

from book.filters import BookFilter
from book.models import Book
from book.serializers import BookSerializer


classBookViewSet(viewsets.ReadOnlyModelViewSet):
    queryset = Book.objects.all()
    filter_backends = (filters.DjangoFilterBackend, )
    filterset_class = BookFilter
    serializer_class = BookSerializer

Solution 4:

The documentation for django-filter is sparse. You could try creating a custom filter and specifying the lookup type. It's rather convoluted:

classBookFilter(django_filters.FilterSet):
    id = django_filters.NumberFilter(name="id", lookup_type="in")

    classMeta:
        model = Bookfields= ['id']

And then modify your view to use the filter class:

classBookView(viewsets.ReadOnlyModelViewSet):
    serializer_class = BookSerializer()
    model = Bookfilter_fields= ('id', 'name')
    filter_class = BookFilter

You'll then be able to lookup books via their ids (note "__in" not used):

/v1/books/?id=1,2,3
/v1/books/?id=1

Solution 5:

Customize PKsField and PKsFilter for your id field(AutoField), and then the query params will work: '/v1/books/?id__in=1,2,3'

from django.forms import Field
from django_filters.filters import Filter
from django.db.models import AutoField


class PKsField(Field):

    def clean(self, value): # convert '1,2,3' to {1, 2, 3}
        return set(int(v) for v in value.split(',') if v.isnumeric()) if value else ()


class PKsFilter(Filter):
    field_class = PKsField


class BookFilter(FilterSet):
    # ids = PKsFilter(name='id', lookup_type="in") # another way, query string: ?ids=1,2,3

    filter_overrides = {
        AutoField: {
            'filter_class': PKsFilter, # override default NumberFilter by the PKsFilter
            'extra': lambda f: {
                'lookup_type': 'in',
            }
        }
    }

    class Meta:
        model = Book
        fields = {
            'id': ('in',),
        }


from rest_framework import viewsets


class BookView(viewsets.ModelViewSet):
    queryset = ...
    serializer_class = ...
    filter_class = BookFilter

Hope that can help. Thx.