Фильтры списка ModelAdmin

ModelAdmin классы могут определять фильтры списка, которые отображаются в правом боковом меню страницы изменения списка админки, как показано на следующем скриншоте:

Для активации фильтрации по полям, установите ModelAdmin.list_filter в список или кортеж элементов, где каждый элемент имеет один из следующих типов:

• Имя поля.
• Подкласс django.contrib.admin.SimpleListFilter.
• 2-кортеж, содержащий имя поля и подкласс django.contrib.admin.FieldListFilter.

См. примеры ниже для обсуждения каждого из этих вариантов определения list_filter.

Использование имени поля

Самый простой вариант — указать необходимые имена полей из вашей модели.

Каждое указанное поле должно быть BooleanField, CharField, DateField, DateTimeField, IntegerField, ForeignKey или ManyToManyField, например:

class PersonAdmin(admin.ModelAdmin):
    list_filter = ["is_staff", "company"]

Имена полей в list_filter также могут охватывать отношения, используя __ поиск, например:

class PersonAdmin(admin.UserAdmin):
    list_filter = ["company__name"]

Использование SimpleListFilter

Для пользовательской фильтрации можно определить собственный фильтр списка, унаследовав от django.contrib.admin.SimpleListFilter. Вам необходимо предоставить атрибуты title и parameter_name, и переопределить методы lookups и queryset, например:

from datetime import date

from django.contrib import admin
from django.utils.translation import gettext_lazy as _


class DecadeBornListFilter(admin.SimpleListFilter):
    # Human-readable title which will be displayed in the
    # right admin sidebar just above the filter options.
    title = _("decade born")

    # Parameter for the filter that will be used in the URL query.
    parameter_name = "decade"

    def lookups(self, request, model_admin):
        """
        Returns a list of tuples. The first element in each
        tuple is the coded value for the option that will
        appear in the URL query. The second element is the
        human-readable name for the option that will appear
        in the right sidebar.
        """
        return [
            ("80s", _("in the eighties")),
            ("90s", _("in the nineties")),
        ]

    def queryset(self, request, queryset):
        """
        Returns the filtered queryset based on the value
        provided in the query string and retrievable via
        `self.value()`.
        """
        # Compare the requested value (either '80s' or '90s')
        # to decide how to filter the queryset.
        if self.value() == "80s":
            return queryset.filter(
                birthday__gte=date(1980, 1, 1),
                birthday__lte=date(1989, 12, 31),
            )
        if self.value() == "90s":
            return queryset.filter(
                birthday__gte=date(1990, 1, 1),
                birthday__lte=date(1999, 12, 31),
            )


class PersonAdmin(admin.ModelAdmin):
    list_filter = [DecadeBornListFilter]

class AuthDecadeBornListFilter(DecadeBornListFilter):
    def lookups(self, request, model_admin):
        if request.user.is_superuser:
            return super().lookups(request, model_admin)

    def queryset(self, request, queryset):
        if request.user.is_superuser:
            return super().queryset(request, queryset)

class AdvancedDecadeBornListFilter(DecadeBornListFilter):
    def lookups(self, request, model_admin):
        """
        Only show the lookups if there actually is
        anyone born in the corresponding decades.
        """
        qs = model_admin.get_queryset(request)
        if qs.filter(
            birthday__gte=date(1980, 1, 1),
            birthday__lte=date(1989, 12, 31),
        ).exists():
            yield ("80s", _("in the eighties"))
        if qs.filter(
            birthday__gte=date(1990, 1, 1),
            birthday__lte=date(1999, 12, 31),
        ).exists():
            yield ("90s", _("in the nineties"))

Использование имени поля и явного FieldListFilter

Наконец, если вы хотите указать явный тип фильтра для использования с полем, вы можете предоставить элемент list_filter в виде 2-кортежа, где первый элемент — имя поля, а второй — класс, унаследованный от django.contrib.admin.FieldListFilter, например:

class PersonAdmin(admin.ModelAdmin):
    list_filter = [
        ("is_staff", admin.BooleanFieldListFilter),
    ]

Здесь поле is_staff будет использовать BooleanFieldListFilter. Если указать только имя поля, поля автоматически будут использовать соответствующий фильтр в большинстве случаев, но этот формат позволяет контролировать используемый фильтр.

В следующих примерах показаны доступные классы фильтров, которые необходимо включить для использования.

Вы можете ограничить выбор связанной модели объектами, участвующими в этом отношении, используя RelatedOnlyFieldListFilter:

class BookAdmin(admin.ModelAdmin):
    list_filter = [
        ("author", admin.RelatedOnlyFieldListFilter),
    ]

Предполагая, что author является ForeignKey к модели User, это ограничит выбор list_filter пользователями, которые написали книгу, вместо того чтобы перечислять всех пользователей.

Вы можете фильтровать пустые значения, используя EmptyFieldListFilter, который может фильтровать как пустые строки, так и NULL, в зависимости от того, что поле разрешено хранить:

class BookAdmin(admin.ModelAdmin):
    list_filter = [
        ("title", admin.EmptyFieldListFilter),
    ]

Определяя фильтр с помощью __in поиска, можно фильтровать любой из группы значений. Вам нужно переопределить метод expected_parameters и указать атрибут lookup_kwargs с соответствующим именем поля. По умолчанию несколько значений в строке запроса будут разделены запятыми, но это можно настроить через атрибут list_separator. Следующий пример демонстрирует такой фильтр с использованием вертикальной черты в качестве разделителя:

class FilterWithCustomSeparator(admin.FieldListFilter):
    # custom list separator that should be used to separate values.
    list_separator = "|"

    def __init__(self, field, request, params, model, model_admin, field_path):
        self.lookup_kwarg = "%s__in" % field_path
        super().__init__(field, request, params, model, model_admin, field_path)

    def expected_parameters(self):
        return [self.lookup_kwarg]

Фильтры списка обычно отображаются только если у фильтра больше одного выбора. Метод has_output() фильтра контролирует его отображение.

Возможна настройка пользовательской шаблона для отображения фильтра списка:

class FilterWithCustomTemplate(admin.SimpleListFilter):
    template = "custom_template.html"

См. шаблон по умолчанию, предоставляемый Django (admin/filter.html) для конкретного примера.

Фильтры facets

По умолчанию подсчеты для каждого фильтра, известные как facets, могут быть показаны, включив их в админском интерфейсе. Эти подсчеты будут обновляться в соответствии с текущими примененными фильтрами. См. ModelAdmin.show_facets для получения более подробной информации.