Django 1.4 documentation

Djbook.ru | Главная | Содержание | Алфавитный указатель | Модули | Состояние перевода

« previous | up | next »

Создаем свое первое приложение с Django, часть 2

Этот раздел – продолжение первой части учебника. Мы продолжим разрабатывать приложение для голосования и создадим интерфейс администратора.

Philosophy

Создание интерфейса администратора для добавления, изменения и удаления содержимого сайта – в основном скучная некреативная задача. Django значительно автоматизирует и упрощает эту задачу.

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

Интерфейс администратора не предназначен для использования пользователями. Он создан для менеджеров и администраторов сайта.

Активация интерфейса администратора

Интерфейс администратора не активирован по умолчанию. Что бы его активировать выполните следующие действия:

• Раскомментируйте "django.contrib.admin" в настройке INSTALLED_APPS.

• Выполните python manage.py syncdb. После добавления приложения в INSTALLED_APPS база данных должна быть обновлена.

• Отредактируйте файл mysite/urls.py раскомментировав строки, которые относятся к интерфейсу администратора – всего должно быть три строки. Этот файл – конфигурация URL-ов, подробнее мы изучим его следующем разделе учебника. Все что вам нужно сейчас знать – он определяет соответствие URL-ов приложениям. У вас должен получиться следующий файл urls.py:

  from django.conf.urls import patterns, include, url
  
  # Uncomment the next two lines to enable the admin:
  from django.contrib import admin
  admin.autodiscover()
  
  urlpatterns = patterns('',
      # Examples:
      # url(r'^$', '{{ project_name }}.views.home', name='home'),
      # url(r'^{{ project_name }}/', include('{{ project_name }}.foo.urls')),
  
      # Uncomment the admin/doc line below to enable admin documentation:
      # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
  
      # Uncomment the next line to enable the admin:
      url(r'^admin/', include(admin.site.urls)),
  )
  

  (Жирным выделены строки, которые должны быть раскомментированы.)

Запускаем сервер для разработки

Давайте запустим встроенный сервер для разработки и посмотрим на наш интерфейс администратора.

Напомним, что сервер для разработки запускается следующим образом:

python manage.py runserver

Откроем “/admin/” локального домена в браузере – например, http://127.0.0.1:8000/admin/. Вы должны увидеть страницу авторизации интерфейса администратора:

Doesn’t match what you see?

Если вместо страницы авторизации вы получили ошибку:

ImportError at /admin/
cannot import name patterns
...

значит вы используете не верную версию Django. Смотрите учебник для используемой версии или обновите Django.

Заходим в интерфейс администратора

Теперь авторизируемся. (Вы создали суперпользователя в первой части учебника, помните? Если вы этого не сделали или забыли пароль, создайте еще одного.) Вы должны увидеть главную страницу интерфейса администратора Django:

Вы должны увидеть несколько разделов включая группы, пользователей и сайты. Это встроенные основные приложения Django.

Добавим приложение голосования в интерфейс администратора

А где же наше приложение голосования? Оно не отображается в интерфейсе администратора.

Нам нужно указать, что объекты модели Poll могут редактироваться в интерфейсе администратора. Для этого создадим файл admin.py в каталоге polls, и отредактируем следующим образом:

from polls.models import Poll
from django.contrib import admin

admin.site.register(Poll)

Теперь перезапустим сервер. Обычно сервер самостоятельно перезапускается после изменений кода, но не при создании нового файла.

Изучим возможности интерфейса администратора

После регистрации модели Poll Django отобразит ее на главной странице:

Нажмите “Polls”. Вы попали на страницу “списка объектов” для голосований. Эта страница содержим все объекты из базы данных и позволяет выбрать один из них для редактирования. Мы видим голосование “What’s up?”, которое создали в первой части учебника:

Нажмите “What’s up?” что бы отредактировать его:

Заметим:

• Форма автоматически создается с модели голосования.
• Для различных типов полей модели (DateTimeField, CharField) используются соответствующие HTML поля. Каждое поле знает как отобразить себя в интерфейсе администратора.
• К полям DateTimeField добавлен JavaScript виджет. Для даты добавлена кнопка “Сегодня” и календарь, для времени добавлена кнопка “Сейчас” и список распространенных значений.

В нижней части страницы мы видим несколько кнопок:

• Save – сохранить изменения и вернуться на страницу списка объектов.
• Save and continue editing – сохранить изменения и снова загрузить страницу редактирования текущего объекта.
• Save and add another – Сохранить изменения и перейти на страницу создания нового объекта.
• Delete – Показывает страницу подтверждения удаления.

Если значение “Date published” не совпадает с временем создания объекта в первой части учебника, возможно вы не верно определили настройку TIME_ZONE. Измените ее и перезагрузите страницу.

Измените “Date published” нажав “Today” и “Now”. Затем нажмите “Save and continue editing.” Теперь нажмите “History” в правом верхнем углу страницы. Вы увидите все изменения объекта сделанные через интерфейс администратора, время изменений и пользователя, который их сделал:

Настройка формы

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

Вот как это работает. Давайте поменяем порядок полей в форме. Замените admin.site.register(Poll) на:

class PollAdmin(admin.ModelAdmin):
    fields = ['pub_date', 'question']

admin.site.register(Poll, PollAdmin)

Создаем объект ModelAdmin и предаем его в admin.site.register().

Теперь поле “Publication date” отображается перед полем “Question”:

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

Для форм с большим количеством полей можно разбить форму на группу полей:

class PollAdmin(admin.ModelAdmin):
    fieldsets = [
        (None,               {'fields': ['question']}),
        ('Date information', {'fields': ['pub_date']}),
    ]

admin.site.register(Poll, PollAdmin)

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

Вы можете добавить HTML классы для каждой группы полей. Django предоставляет класс "collapse", который отображает группу полей изначально скрытой. Это полезно, если форма содержит поля, которые редко редактируются:

class PollAdmin(admin.ModelAdmin):
    fieldsets = [
        (None,               {'fields': ['question']}),
        ('Date information', {'fields': ['pub_date'], 'classes': ['collapse']}),
    ]

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

Отлично, теперь модель Poll имеет свою собственную страницу в интерфейсе администратора. Но Poll содержит несколько Choices, которые интерфейс администратора не отображает.

Пока что.

Есть два способа это сделать. Первый - зарегистрировать модель Choice в интерфейсе администратора, так же как и Poll. Это просто:

from polls.models import Choice

admin.site.register(Choice)

Теперь “Choices” отображается в интерфейсе администратора. Форма добавления варианта ответа выглядит следующим образом:

В этой форме поле “Poll” представлено <select> с объектами Poll из базы данных. Django знает, что поле ForeignKey должно быть представлено как <select>. В нашем случае можно выбрать только одно голосование.

Обратите внимание на ссылку “Add Another” возле поля “Poll.” Он будет добавлен для каждого поля ForeignKey. При нажатии на “Add Another,” будет показано всплывающее окно с формой добавления голосования. Если вы добавите голосование и нажмете “Save,” Django сохранит объект в базу данных и выберет его в поле.

Но, на самом деле, это совсем не удобный способ добавлять варианты ответов для голосования. Было бы удобнее добавлять варианты ответов при добавлении голосования. Давайте сделаем это.

Уберите вызов register() для модели Choice. И отредактируйте код для регистрации Poll в интерфейсе администратора:

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

class PollAdmin(admin.ModelAdmin):
    fieldsets = [
        (None,               {'fields': ['question']}),
        ('Date information', {'fields': ['pub_date'], 'classes': ['collapse']}),
    ]
    inlines = [ChoiceInline]

admin.site.register(Poll, PollAdmin)

Это говорит Django: “Варианты ответов редактируются на странице голосования. По умолчанию, покажите 3 формы для добавления вариантов ответа.”

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

Это работает следующим образом: Есть три формы для добавления вариантов ответа – как определяет параметр extra – и при каждой загрузке этой страницы будет три формы для добавления новых вариантов ответа.

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

class ChoiceInline(admin.TabularInline):
    #...

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

Настройка страницы списка объектов

Теперь, когда страница добавления/редактирования голосования выглядит хорошо, давай улучшим страницу отображения списка голосований.

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

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

class PollAdmin(admin.ModelAdmin):
    # ...
    list_display = ('question', 'pub_date')

Для примера давайте еще и добавим метод was_published_recently из Части 1 учебника:

class PollAdmin(admin.ModelAdmin):
    # ...
    list_display = ('question', 'pub_date', 'was_published_recently')

Теперь страница списка объектов Poll выглядит следующим образом:

Вы можете нажать на заголовок колонки что бы отсортировать записи по полю – но не для was_published_recently, так как сортировка по методу не поддерживается. Название колонки для was_published_recently по умолчанию равно названию метода (нижние подчеркивание заменяется на пробелы), а значение равно строковому представлению результата выполнения метода.

Вы можете исправить это добавив несколько атрибутов (в models.py) этому методу:

class Poll(models.Model):
    # ...
    def was_published_recently(self):
        return self.pub_date >= timezone.now() - datetime.timedelta(days=1)
    was_published_recently.admin_order_field = 'pub_date'
    was_published_recently.boolean = True
    was_published_recently.short_description = 'Published recently?'

Отредактируем файл admin.py снова и добавим на страницу Фильтры. Добавьте следующую строку в PollAdmin:

list_filter = ['pub_date']

Это добавляет “Фильтр” по полю pub_date в боковой панели:

Тип фильтра зависит от типа поля. Так как pub_date является DateTimeField, Django отображает соответствующие варианты для фильтрации: “Any date,” “Today,” “Past 7 days,” “This month,” “This year.”

Теперь добавим поиск:

search_fields = ['question']

Это добавляет поле для поиска в верхней части страницы. При вводе запроса, Django будет искать по полю question. Вы можете использовать любое количество полей – учтите что используется запрос LIKE, так что постарайтесь не перегрузить вашу базу данных.

И наконец, так как объекты Poll содержат поле даты, было бы удобно просматривать записи по дням, месяцам и тд. Добавьте следующую строку:

date_hierarchy = 'pub_date'

Это добавит иерархическую навигацию по дате в верхнюю часть страницы. Она содержит доступные года, месяца и дни.

Страница списка объектов так же содержит постраничное отображение. По умолчанию отображается 100 объектов на страницу.

Настраиваем внешний вид

“Django administration” в “шапке” страницы выглядит нелепо. Это просто замещающий текст.

Его очень легко заменить использую систему шаблонов Django. Интерфейс администратора работает благодаря Django и использует систему шаблонов Django.

Откройте файл настроек (напомним это mysite/settings.py) и найдите настройку TEMPLATE_DIRS. TEMPLATE_DIRS являет собой кортеж путей к каталогам, который указывает Django будет искать шаблоны.

По умолчанию TEMPLATE_DIRS пустая. Давайте добавим значением, что бы указать где находятся шаблоны:

TEMPLATE_DIRS = (
    '/home/my_username/mytemplates', # Change this to your own directory.
)

Скопируйте шаблон admin/base_site.html из каталога шаблонов приложения администратора Django (django/contrib/admin/templates) в подкаталог admin каталога указанного в настройке TEMPLATE_DIRS. Например, если TEMPLATE_DIRS содержит '/home/my_username/mytemplates', скопируйте django/contrib/admin/templates/admin/base_site.html в /home/my_username/mytemplates/admin/base_site.html. Не забудьте про подкаталог admin.

Отредактируйте файл и замените текст по умолчанию на название вашего сайта.

Этот шаблон содержит текст подобный {% block branding %} и {{ title }}. Теги {% и {{ – это части синтаксиса системы шаблонов Django. При выполнении шаблона admin/base_site.html Django создаст HTML страницу. Не волнуйтесь если ничего не понимаете в этом – в шаблонах Django мы разберемся в Части 3.

Любой шаблон интерфейса администратора можно переопределить. Чтобы переопределить шаблон, сделайте тоже что и с base_site.html – скопируйте его в каталог с шаблонами проекта и внесите изменения.

Внимательные читатели спросят: если TEMPLATE_DIRS пустая по умолчанию, как Django находит шаблоны интерфейса администратора по умолчанию? Django пытается найти шаблон в подкаталоге templates/ каждого приложении. Подробности смотрите в разделе о загрузке шаблонов.

Настроим главную страницу

Возможно вам понадобиться настроить главную страницу интерфейса администратора.

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

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

Если вы освоили интерфейс администратора, переходите к части 3 этого учебника.

Последнее обновление:

Feb 03, 2013

« previous | up | next »