Как использовать ModelMultipleChoiceFilter?

Я наткнулся на этот вопрос, пытаясь решить почти идентичную вам проблему, и хотя я мог просто написать собственный фильтр, ваш вопрос меня заинтриговал, и мне пришлось копнуть глубже!

Оказывается, ModelMultipleChoiceFilter делает только одно изменение по сравнению с обычным Filter, как видно из исходного кода django_filters ниже:

class ModelChoiceFilter(Filter):
    field_class = forms.ModelChoiceField

class ModelMultipleChoiceFilter(MultipleChoiceFilter):
    field_class = forms.ModelMultipleChoiceField

То есть он изменяет field_class на ModelMultipleChoiceField из встроенных форм Django.

Взглянув на исходный код для ModelMultipleChoiceField, один из обязательных аргументов для __init__() — это queryset, так что вы были на правильном пути.

Другая часть головоломки исходит от метода ModelMultipleChoiceField.clean() со строкой: key = self.to_field_name or 'pk'. Это означает, что по умолчанию он примет любое значение, которое вы ему передадите (например, "cooking"), и попытается найти Tag.objects.filter(pk="cooking"), когда, очевидно, мы хотим, чтобы он посмотрел на имя, и, как мы можем видеть в этой строке, что поле, с которым оно сравнивается, контролируется self.to_field_name.

К счастью, метод Filter.field() django_filters включает следующее при создании фактического поля.

self._field = self.field_class(required=self.required,
    label=self.label, widget=self.widget, **self.extra)

Особо следует отметить **self.extra, который происходит от Filter.__init__(): self.extra = kwargs, поэтому все, что нам нужно сделать, это передать дополнительный to_field_name kwarg в ModelMultipleChoiceFilter, и он будет передан нижележащему ModelMultipleChoiceField.

Итак (пропустите здесь фактическое решение!), фактический код, который вам нужен,

tags = django_filters.ModelMultipleChoiceFilter(
    name='sitetags__name',
    to_field_name='name',
    lookup_type='in',
    queryset=SiteTag.objects.all()
)

Итак, вы были очень близки с кодом, который вы разместили выше! Я не знаю, будет ли это решение актуально для вас, но, надеюсь, оно может помочь кому-то еще в будущем!

Решение, которое сработало для меня, состояло в том, чтобы использовать файл MultipleChoiceFilter. В моем случае у меня есть судьи, у которых есть гонки, и я хочу, чтобы мой API позволял людям запрашивать, скажем, черных или белых судей.

В итоге получается фильтр:

race = filters.MultipleChoiceFilter(
    choices=Race.RACES,
    action=lambda queryset, value:
        queryset.filter(race__race__in=value)
)

Race - это поле "многие ко многим" из Judge:

class Race(models.Model):
    RACES = (
        ('w', 'White'),
        ('b', 'Black or African American'),
        ('i', 'American Indian or Alaska Native'),
        ('a', 'Asian'),
        ('p', 'Native Hawaiian or Other Pacific Islander'),
        ('h', 'Hispanic/Latino'),
    )
    race = models.CharField(
        choices=RACES,
        max_length=5,
    )

Обычно я не большой поклонник lambda функций, но здесь это имело смысл, потому что это такая маленькая функция. По сути, это устанавливает MultipleChoiceFilter, который передает значения из параметров GET в поле race модели Race. Они передаются в виде списка, поэтому параметр in работает.

Итак, мои пользователи могут:

/api/judges/?race=w&race=b

И они вернут судей, которые идентифицировали себя как черных или белых.

_{PS: Да, я понимаю, что это не весь набор возможных рас. Но это именно то, что собирает перепись населения США!}