Создание первого приложения Django, часть 7

Настройка формы администрирования

Зарегистрировав модель Question в admin.site.register(Question), Django смог создать представление формы по умолчанию. Часто возникает необходимость настроить внешний вид и работу формы администрирования. Для этого нужно указать Django нужные параметры при регистрации объекта.

Давайте посмотрим, как это работает, изменив порядок полей в форме редактирования. Замените строку admin.site.register(Question) на:

from django.contrib import admin

from .models import Question


class QuestionAdmin(admin.ModelAdmin):
    fields = ["pub_date", "question_text"]


admin.site.register(Question, QuestionAdmin)

Всякий раз, когда потребуется изменить параметры администрирования модели, придерживайтесь этого подхода: создайте класс администрирования модели, а затем передайте его вторым аргументом в admin.site.register().

Это изменение помещает поле «Дата публикации» перед полем «Вопрос»:

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

Раз уж мы заговорили о формах с десятками полей, возможно, вам будет удобнее разделить форму на группы полей:

from django.contrib import admin

from .models import Question


class QuestionAdmin(admin.ModelAdmin):
    fieldsets = [
        (None, {"fields": ["question_text"]}),
        ("Date information", {"fields": ["pub_date"]}),
    ]


admin.site.register(Question, QuestionAdmin)

Первый элемент каждого кортежа в fieldsets — это заголовок группы полей. Теперь наша форма выглядит так:

Добавление связанных объектов

Итак, у нас есть страница администрирования вопросов, но у Question может быть несколько Choice, а на странице администрирования варианты ответов не отображаются.

Пока.

Есть два способа решить эту проблему. Первый — зарегистрировать Choice в администрировании так же, как мы это сделали для Question:

from django.contrib import admin

from .models import Choice, Question

# ...
admin.site.register(Choice)

Теперь в администрировании Django доступен пункт «Варианты ответов». Форма «Добавить вариант ответа» выглядит так:

В этой форме поле «Вопрос» — это список выбора, содержащий все вопросы из базы данных. Django знает, что ForeignKey нужно представить в администрировании в виде поля <select>. В нашем случае на этом этапе существует только один вопрос.

Также обратите внимание на ссылку «Добавить ещё один вопрос» рядом с полем «Вопрос». Такая возможность предоставляется автоматически для каждого объекта, связанного с другим объектом отношением ForeignKey. Нажав «Добавить ещё один вопрос», вы откроете всплывающее окно с формой «Добавить вопрос». Если вы добавите вопрос в этом окне и нажмёте «Сохранить», Django сохранит вопрос в базе данных и динамически добавит его как выбранный вариант в открытую форму «Добавить вариант ответа».

Но на самом деле это неэффективный способ добавления в систему объектов Choice. Было бы удобнее добавлять сразу несколько вариантов ответов при создании объекта Question. Давайте это исправим.

Удалите вызов register() для модели Choice. Затем измените код регистрации Question следующим образом:

from django.contrib import admin

from .models import Choice, Question


class ChoiceInline(admin.StackedInline):
    model = Choice
    extra = 3


class QuestionAdmin(admin.ModelAdmin):
    fieldsets = [
        (None, {"fields": ["question_text"]}),
        ("Date information", {"fields": ["pub_date"], "classes": ["collapse"]}),
    ]
    inlines = [ChoiceInline]


admin.site.register(Question, QuestionAdmin)

Этим мы сообщаем Django: «Объекты Choice редактируются на странице администрирования Question. По умолчанию предоставьте достаточно полей для 3 вариантов ответа».

Откройте страницу «Добавить вопрос», чтобы посмотреть, как это выглядит:

Это работает следующим образом: предусмотрено три поля для связанных вариантов ответа — как указано в extra, — и каждый раз, когда вы возвращаетесь на страницу изменения уже созданного объекта, появляются ещё три дополнительных поля.

В конце трёх имеющихся полей вы найдёте ссылку «Добавить ещё один вариант ответа». Нажав её, вы добавите новое поле. Чтобы удалить добавленное поле, нажмите на крестик в его верхнем правом углу. На изображении показано добавленное поле:

Однако есть небольшая проблема. Для отображения всех полей ввода связанных объектов Choice требуется много места на экране. Поэтому Django предлагает табличный способ отображения связанных объектов в строках формы. Чтобы использовать его, измените объявление ChoiceInline следующим образом:

class ChoiceInline(admin.TabularInline): ...

С этим TabularInline (вместо StackedInline) связанные объекты отображаются в более компактном табличном формате:

Обратите внимание на дополнительный столбец «Удалить?», который позволяет удалять строки, добавленные с помощью кнопки «Добавить ещё один вариант ответа», а также уже сохранённые строки.

Настройка списка объектов в администрировании

Теперь страница администрирования вопросов выглядит хорошо. Давайте внесём несколько изменений на страницу «списка объектов» — ту, на которой отображаются все вопросы в системе.

Сейчас она выглядит так:

По умолчанию Django отображает str() каждого объекта. Но иногда было бы полезнее показывать отдельные поля. Для этого используйте параметр администрирования list_display — список имён полей, которые будут отображаться в виде столбцов на странице списка объектов:

class QuestionAdmin(admin.ModelAdmin):
    # ...
    list_display = ["question_text", "pub_date"]

Для полноты картины добавим также метод was_published_recently() из руководства 2:

class QuestionAdmin(admin.ModelAdmin):
    # ...
    list_display = ["question_text", "pub_date", "was_published_recently"]

Теперь страница списка вопросов выглядит так:

Вы можете щёлкнуть заголовок столбца, чтобы отсортировать список по соответствующим значениям, — за исключением заголовка was_published_recently, поскольку сортировка по результату произвольного метода не поддерживается. Также обратите внимание, что заголовком столбца was_published_recently по умолчанию служит имя метода (подчёркивания заменяются пробелами), а в каждой строке отображается строковое представление результата.

Это можно улучшить, добавив к методу декоратор display() (изменив файл polls/models.py, созданный в руководстве 2), например так:

from django.contrib import admin


class Question(models.Model):
    # ...
    @admin.display(
        boolean=True,
        ordering="pub_date",
        description="Published recently?",
    )
    def was_published_recently(self):
        now = timezone.now()
        return now - datetime.timedelta(days=1) <= self.pub_date <= now

Подробнее о свойствах, которые можно настроить с помощью декоратора, см. в разделе list_display.

Снова откройте файл polls/admin.py и улучшите страницу списка объектов Question, добавив фильтры с помощью параметра list_filter. Добавьте следующую строку в QuestionAdmin:

list_filter = ["pub_date"]

Это добавит боковую панель «Фильтр», позволяющую фильтровать список объектов по полю pub_date:

Тип отображаемого фильтра зависит от типа поля, по которому выполняется фильтрация. Поскольку pub_date — это DateTimeField, Django подбирает подходящие варианты фильтрации: «Любая дата», «Сегодня», «За последние 7 дней», «В этом месяце», «В этом году».

Всё выглядит хорошо. Давайте добавим возможность поиска:

search_fields = ["question_text"]

В верхней части списка объектов появится поле поиска. Когда пользователь вводит поисковый запрос, Django выполняет поиск по полю question_text. Можно указать сколько угодно полей, но поскольку за кулисами выполняется запрос LIKE, разумное количество полей поиска упростит работу базы данных.

Заодно отметим, что списки объектов поддерживают постраничную навигацию. По умолчанию на каждой странице отображается 100 элементов. Параметры Change list pagination, search boxes, filters, date-hierarchies и column-header-ordering работают вместе именно так, как и ожидается.

Настройка внешнего вида администрирования

Очевидно, что надпись «Администрирование Django» в верхней части каждой страницы администрирования выглядит нелепо. Это всего лишь текст-заполнитель.

Однако её можно изменить с помощью системы шаблонов Django. Администрирование Django работает на самом Django, а его интерфейсы используют собственную систему шаблонов Django.

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [BASE_DIR / "templates"],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
            ],
        },
    },
]

$ python -c "import django; print(django.__path__)"

...\> py -c "import django; print(django.__path__)"

{% block branding %}
<div id="site-name"><a href="{% url 'admin:index' %}">Polls Administration</a></div>
{% if user.is_anonymous %}
  {% include "admin/color_theme_toggle.html" %}
{% endif %}
{% endblock %}

Настройка главной страницы администрирования

Кроме того, вы можете настроить внешний вид главной страницы администрирования Django.

По умолчанию на ней отображаются все приложения из INSTALLED_APPS, зарегистрированные в приложении администрирования, в алфавитном порядке. Возможно, вы захотите существенно изменить расположение элементов. Ведь главная страница — вероятно, самая важная страница администрирования, и пользоваться ею должно быть легко.

Для настройки предназначен шаблон admin/index.html. (Сделайте то же, что и с admin/base_site.html в предыдущем разделе: скопируйте его из каталога по умолчанию в свой каталог шаблонов.) Откройте файл и увидите, что в нём используется переменная шаблона app_list. Она содержит все установленные приложения Django. Вместо неё вы можете задать ссылки на страницы администрирования отдельных объектов любым удобным способом.

Когда освоитесь с администрированием, прочитайте часть 8 этого руководства, чтобы узнать, как использовать сторонние пакеты.