Question

使用django-filters，我看到了如何在单个查询字符串中提交相同类型的多个参数的各种解决方案，例如多个ID。它们都建议使用包含以逗号分隔的值列表的单独字段，例如：

http://example.com/api/cities?ids=1,2,3

是否有使用单个参数但提交一次或多次的一般解决方案？ E.g：

http://example.com/api/cities?id=1&id=2&id=3

我尝试使用MultipleChoiceFilter，但它希望定义实际选择，而我想传递任意ID（其中一些甚至可能不存在于DB中）。

Answer 1

这是使用自定义Filter和自定义Field的可重用解决方案。

自定义Field重用Django的MultipleChoiceField，但替换了验证功能。而是使用传递给构造函数的另一个Field类进行验证。

from django.forms.fields import MultipleChoiceField

class MultipleValueField(MultipleChoiceField):
    def __init__(self, *args, field_class, **kwargs):
        self.inner_field = field_class()
        super().__init__(*args, **kwargs)

    def valid_value(self, value):
        return self.inner_field.validate(value)

    def clean(self, values):
        return values and [self.inner_field.clean(value) for value in values]

自定义Filter使用MultipleValueField并转发field_class参数。还将默认值lookup_expr设置为in。

from django_filters.filters import Filter

class MultipleValueFilter(Filter):
    field_class = MultipleValueField

    def __init__(self, *args, field_class, **kwargs):
        kwargs.setdefault('lookup_expr', 'in')
        super().__init__(*args, field_class=field_class, **kwargs)

要使用此过滤器，只需使用适当的MultipleValueFilter创建一个field_class。例如，要用City过滤id，我们可以使用IntegerField，如下所示：

from django.forms.fields import IntegerField

class CityFilterSet(FilterSet):
    id = MultipleValueFilter(field_class=IntegerField)
    name = filters.CharFilter(lookup_expr='icontains')

    class Meta:
        model = City
        fields = ['name']

Answer 2

我建议您使用自定义过滤器，如下所示

from django_filters.filters import Filter
from rest_framework.serializers import ValidationError
from django_filters.fields import Lookup


class ListFilter(Filter):
    def filter(self, queryset, value):
        list_values = value.split(',')
        if not all(item.isdigit() for item in list_values):
            raise ValidationError('All values in %s the are not integer' % str(list_values))
        return super(ListFilter, self).filter(queryset, Lookup(list_values, 'in'))

Answer 3

使用自定义过滤器解决，灵感来自Jerin的回答：

class ListFilter(Filter):
    def filter(self, queryset, value):
        try:
            request = self.parent.request
        except AttributeError:
            return None

        values = request.GET.getlist(self.name)
        values = {int(item) for item in values if item.isdigit()}

        return super(ListFilter, self).filter(queryset, Lookup(values, 'in'))

如果值是非数字的，例如color=blue&color=red然后isdigit()验证当然没有必要。

Answer 4

http://example.com/api/cities?ids=1,2,3

get_ids=1,2,3
id_list = list(get_ides]
Mdele_name.objects.filter(id__in= id_list)

Answer 5

我对this solution有问题

所以我做了一点改动：

class ListFilter(Filter):
    def __init__(self, query_param, *args, **kwargs):
        super(ListFilter, self).__init__(*args, **kwargs)
        # url = /api/cities/?id=1&id=2&id=3 or /api/cities/?id=1,2,3
        # or /api/cities/?id=1&id=2&id=3?id=4,5,6
        self.query_param = query_param 
        self.lookup_expr = 'in'

    def filter(self, queryset, value):
        try:
            request = self.parent.request
        except AttributeError:
            return None

        values = set()
        query_list = request.GET.getlist(self.query_param)
        for v in query_list:
            values = values.union(set(v.split(',')))
        values = set(map(int, values))

        return super(ListFilter, self).filter(queryset, values)

class CityFilter(filterset.FilterSet):
    id = ListFilter(field_name='id', query_param='id')
    name = filters.CharFilter(field_name='name', lookup_expr='icontains')

    class Meta:
        model = City
        fields = ['name']

如果要使用自定义查询参数名称，请更改query_param参数。

Answer 6

作为选择

class CityFilterSet(django_filters.FilterSet):
    id = django_filters.NumberFilter(method='filter_id')

    def filter_id(self, qs, name, value):
        return qs.filter(id__in=self.request.GET.getlist('id'))

Answer 7

Benoit Blanchon 拥有最好的 imo

但我已经尝试改进它以允许更多类型的lookup_expr。有关完整的代码片段，请参阅他的 answer。

from django.db.models import Q

class MultipleValueFilter(Filter):
    field_class = MultipleValueField

    def __init__(self, *args, field_class, **kwargs):
        kwargs.setdefault('lookup_expr', 'in')
        super().__init__(*args, field_class=field_class, **kwargs)

    def filter(self, qs, value):
        # if it's not a list then let the parent deal with it
        if self.lookup_expr == 'in' or not isinstance(value, list):
            return super().filter(qs, value)

        # empty list
        if not value:
            return qs
        if self.distinct:
            qs = qs.distinct()

        lookup = '%s__%s' % (self.field_name, self.lookup_expr)
        filters = Q()
        for v in value:
            filters |= Q(**{lookup: v})
        qs = self.get_method(qs)(filters)
        return qs

通过此更改，您现在可以使用 iexact 为例。您也可以使用 gte 等，但这些可能没有多大意义。

Django-filters：单个查询字符串中的多个ID

7 个答案: