如何使用django-filter包处理参数列表？

Question

我想要使用django-filter来筛选我的模型。如果我按照一个id进行过滤，它可以很好地工作：

http://localhost:8000/accommodations?accommodationType_id=1

但我不知道如何按多个id进行筛选，类似于：

http://localhost:8000/accommodations?accommodationType_id=1,2

我的实际 ViewSet 看起来像这样：

class AccommodationViewSet(viewsets.ReadOnlyModelViewSet):
    """
        REST API endpoint for 'accommodation' resource
    """
    queryset = Accommodation.objects.all()
    serializer_class = AccommodationSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_fields = ('accommodationType_id', 'name')

我希望有一个解决方案。

- abuder

---

你尝试过这个链接吗：http://localhost:8000/accommodations?accommodationType_id=1&accommodationType_id=2？ - mariodev

是的，我可以获取accommodationType_id=2的最后一个对象吗？ - abuder

在我的测试中，传递多个相同的参数会返回所有值匹配的结果，即AND。 - James Maguire

Answer 1

我知道这是一个旧问题，但更新答案可能是值得的。

Django-filter贡献者添加了一个名为BaseInFilter的字段，您可以将其与其他过滤器组合以验证内容。

请参阅文档：https://django-filter.readthedocs.io/en/latest/ref/filters.html#baseinfilter

例如，在您的情况下，可以这样使用：

from django_filters import rest_framework as filters


class NumberInFilter(filters.BaseInFilter, filters.NumberFilter):
    pass


class AccommodationFilter(filters.FilterSet):
    accommodationType_id_in = NumberInFilter(field_name='accommodationType_id', lookup_expr='in')

    class Meta:
        model = Accommodation
        fields = ['accommodationType_id_in', ]

然后您将能够按ID列表进行过滤：http://localhost:8000/accommodations?accommodationType_id_in=1,2

- Agey

---

非常有用，真棒！ - GustavoNogueira

甚至更简单的是，django-filter将“fields”作为字典处理，您可以在其中指定查找。详情请参阅：https://django-filter.readthedocs.io/en/stable/ref/filterset.html#declaring-filterable-fields这个答案中最先发现它：https://dev59.com/mr7pa4cB1Zd3GeqPwlho - movileanuv

Answer 2

我为我的问题找到了以下解决方案 :)

https://gist.github.com/aBuder/654fb945f085b17358d8

from webapp.serializers import *
from rest_framework import viewsets
from rest_framework import filters
from django_filters import Filter, FilterSet


class ListFilter(Filter):
    def filter(self, qs, value):
        if not value:
            return qs

        # For django-filter versions < 0.13, use lookup_type instead of lookup_expr
        self.lookup_expr = 'in'
        values = value.split(',')
        return super(ListFilter, self).filter(qs, values)


class AccommodationFilter(FilterSet):
    ids = ListFilter(name='id')
    accommodationType_ids = ListFilter(name='accommodationType_id')

    class Meta:
        model = Accommodation
        fields = ['ids', 'accommodationType_ids']


class AccommodationViewSet(viewsets.ReadOnlyModelViewSet):
    """
        REST API endpoint for 'accommodation' resource
    """
    queryset = Accommodation.objects.all()
    serializer_class = AccommodationSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_class = AccommodationFilter

- abuder

---

谢谢！这对我帮助很大。如果你在这方面有其他的技巧，我会非常感激！我经常需要根据列表获取项目。 - Diesel

Answer 3

现在有一种更简单的方法来实现这个。在django-filter文档中，它提到你可以使用“字段名称映射到查询列表的字典”。

您的代码将会更新如下：

class AccommodationViewSet(viewsets.ReadOnlyModelViewSet):
    """
        REST API endpoint for 'accommodation' resource
    """
    queryset = Accommodation.objects.all()
    serializer_class = AccommodationSerializer
    filter_backends = (filters.DjangoFilterBackend,)
    filter_fields = {
        'accommodationType_id': ["in", "exact"], # note the 'in' field
        'name': ["exact"]
    }

现在在URL中，您需要在提供参数列表之前将__in添加到筛选器中，这样它才能按照您的期望工作。

http://localhost:8000/accommodations?accommodationType_id__in=1,2

django-filter文档中提供的查找过滤器非常简略，但是Django文档本身提到了in查找过滤器。

- Josh Correia

---

如何自定义URL参数中的字段名称？即不想在URL中使用“__in”后缀。 - Ersain

很遗憾，我不知道有什么方法可以避免使用__in。 - Josh Correia