Создание первого приложения на 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. Форма «Добавить выбор» выглядит следующим образом:

В этой форме поле «Вопрос» представляет собой поле выбора, содержащее каждый вопрос в базе данных. Джанго знает, что a 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 - и каждый раз, когда вы возвращаетесь на страницу «Изменить» для уже созданного объекта, вы получаете еще три дополнительных слота.

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

Но есть одна небольшая проблема. Для отображения всех полей для ввода связанных объектов 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) следующим образом:

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 элементов на странице. Изменить нумерацию, поля поиска, filters, по дате и :attr:`сортировка по заголовкам <django.contrib.admin.ModelAdmin.list_display>`all работать вместе, как вы думаете, они должны.

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

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

Однако вы можете изменить его, используя систему шаблонов 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.debug",
                "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>
{% endblock %}

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

Аналогично вы можете настроить внешний вид главной страницы админки Django.

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

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

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