Django_-_podrobnoe_rukovodstvo

Обобщенные представления для списка/детализации

Обобщенные представления для списка/детализации (в модуле django. views.generic.list_detail) предназначены для типичного случая, когда требуется в одном представлении показать список элементов, а в другом – детальное описание одного элемента списка.

Список объектов

Функция представления: django.views.generic.list_detail.object_list. Применяется для вывода страницы со списком объектов.

Пример

Мы можем воспользоваться представлением object_list для вывода простого списка авторов (объекты Author, описанные в главе 5), включив в конфигурацию URL следующий фрагмент:

from mysite.books.models import Author from django.conf.urls.defaults import *

from django.views.generic import list_detail

author_list_info = {

‘queryset’: Author.objects.all(),

}

urlpatterns = patterns(‘’,

(r’authors/$’, list_detail.object_list, author_list_info)

)

Обязательные аргументы

•• queryset: объект QuerySet, содержащий набор объектов для отображения (см. табл. C.1).

Необязательные аргументы

•• paginate_by: целое число, равное количеству объектов на одной странице. Если задан, то представление разбивает набор на страницы по paginate_by элементов в каждой. Представление ожидает, что либо в строке GET-запроса присутствует параметр page, обозначающий номер страницы (нумерация начинается с единицы), либо в конфигурации URL задана переменная page. (См. ниже врезку «Замечание о разбиении на страницы»).

Дополнительно представление принимает следующие аргументы (описанные в табл. C.1).

•• allow_empty

•• context_processors

•• extra_context

•• mimetype

•• template_loader

•• template_name

•• template_object_name

Имя шаблона­

Вслучае отсутствия аргумента template_name представление будет искать шаблон­ с именем <app_label>/<model_name>_list.html. Метка приложения (app_label) и имя модели (model_name) формируются на основе параметра queryset. Метка приложения – это имя приложения, в котором определена модель, а имя модели совпадает с именем класса модели, записанным строчными буквами.

Впредыдущем примере, где в качестве аргумента queryset был передан набор Author.objects.all(), метка приложения равна books, а имя модели – author. Следовательно, шаблон­ по умолчанию будет называться

books/author_list.html.

Контекст шаблона­

Помимо extra_context, в контекст шаблона­ добавляются следующие переменные:

•• object_list: список объектов. Имя этой переменной зависит от параметра template_object_name, который по умолчанию имеет значение ‘object’. Если бы этот параметр имел значение ‘foo’, то переменная называлась бы foo_list.

•• is_paginated: булевское значение, показывающее, разбит ли список на страницы. Если общее количество объектов не превышает величины paginate_by, эта переменная будет иметь значение False.

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

•• results_per_page: количество объектов на одной странице (равно параметру paginate_by).

•• has_next: булевский флаг, показывающий, существует ли следующая страница.

•• has_previous: булевский флаг, показывающий, существует ли предыдущая страница.

•• page: номер текущей страницы, целое число. Нумерация начинается с 1.

•• next: номер следующей страницы, целое число. Даже если следующей страницы нет, эта переменная будет содержать ее гипотетический номер. Нумерация начинается с 1.

•• previous: номер предыдущей страницы, целое число. Нумерация начинается с 1.

•• pages: общее количество страниц, целое число.

•• hits: общее количество объектов на всех страницах, а не только на текущей.

Замечание о разбиении на страницы

Если задан параметр paginate_by, то Django разбивает список на страницы.НомерстраницыможноуказатьвURLдвумяспособами:

•• Указать параметр page в образце URL, например, так:

(r’^objects/page(?P<page>[0-9]+)/$’, ‘object_list’, dict(info_dict))

•• Передать номер страницы в параметре строки запроса, например, с помощью URL такого вида:

/objects/?page=3

В обоих случаях нумерация начинается с 1, а не с нуля, поэтому номер первой страницы равен 1.

Детальное представление

Функция представления: django.views.generic.list_detail.object_detail.

Применяется для вывода страницы с детальным описанием одного объекта.

Пример

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

from mysite.books.models import Author from django.conf.urls.defaults import *

from django.views.generic import list_detail

author_list_info = {

‘queryset’ : Author.objects.all(),

}

author_detail_info = {

“queryset” : Author.objects.all(), “template_object_name” : “author”,

}

urlpatterns = patterns(‘’,

(r’authors/$’, list_detail.object_list, author_list_info), (r’^authors/(?P<object_id>d+)/$’, list_detail.object_detail,

author_detail_info),

)

Контекст шаблона­

Помимо extra_context, в контекст шаблона­ добавляется следующая переменная:

•• object: сам объект. Имя этой переменной зависит от параметра template_object_name, который по умолчанию имеет значение ‘object’. Если бы этот параметр имел значение ‘foo’, то переменная называлась бы foo.

Обобщенные представления датированных объектов

Обычно такие представления применяются для вывода архивных страниц для датированных материалов. Вспомните о газетных архивах на указанную дату (день/месяц/год) или об архиве типичного блога.

Совет

По умолчанию эти представления игнорируют объекты с датами в будущем. Это означает, что при попытке зайти на страницу архива с датой в будущем Django автоматически вернет ошибку 404 («Страница не найдена»), даже если объекты, опубликованные в этот день, существуют. Таким образом, можно заранее публиковать объекты, которые будут недоступны до наступления указанной даты. Однако для некоторых типов датированных объектов такой подход не годится (например, календарь запланированных мероприятий). В этом случае можно передать параметр allow_future со значением True – и объекты с датой в будущем станут доступны (что даст пользователю возможность зайти на страницу «будущего» архива).

Указатель архивов

Функция представления: django.views.generic.date_based.archive_index.

Выводит указатель архивов верхнего уровня, в котором присутствуют «самые поздние» (недавно опубликованные) объекты, отсортированные по дате.

Пример

Предположим, что типичное издательство хочет организовать страницу с недавно опубликованными книгами. Если предположить, что имеется класс Book, содержащий поле publication_date, то для решения этой задачи можно воспользоваться представлением archive_index:

from mysite.books.models import Book from django.conf.urls.defaults import *

from django.views.generic import date_based

book_info = {

“queryset” : Book.objects.all(),

“date_field” : “publication_date”

}

urlpatterns = patterns(‘’,

(r’^books/$’, date_based.archive_index, book_info),

)

Обязательные аргументы

•• date_field: имя поля типа DateField или DateTimeField в модели, связанной с объектом QuerySet, которое используется, чтобы определить, какие объекты показывать на странице.

•• queryset: набор QuerySet, содержащий архивные объекты.

Необязательные аргументы

•• allow_future: булевский флаг, показывающий, следует ли помещать на страницу объекты с датой в «будущем» (см. совет выше).

•• num_latest: количество «недавних» объектов, помещаемых в контекст шаблона­. По умолчанию равно 15.

В представление могут быть переданы также следующие общие аргументы (см. табл. C.1):

•• allow_empty

•• context_processors

•• extra_context

•• mimetype

•• template_loader

•• template_name

Имя шаблона­

В случае отсутствия аргумента template_name представление будет искать шаблон­ с именем <app_label>/<model_name>_archive.html.

Контекст шаблона­

Помимо extra_context, в контекст шаблона­ добавляются следующие переменные:

•• date_list: список объектов datetime.date, представляющий годы, для которых в наборе queryset есть объекты. Отсортирован в порядке убывания.

Например, если в блоге имеются записи с 2003 по 2006 год, то список будет содержать четыре объекта datetime.date, по одному для каждого года.

•• latest: num_latest объектов, отсортированных в порядке убывания значений поля date_field. Например, если значение num_latest рав-

но 10, то список latest будет содержать 10 объектов из набора queryset с наибольшими датами.

Архивы за год

Функция представления: django.views.generic.date_based.archive_year.

Применяется для вывода страниц с архивами за год. На таких страницах размещается список месяцев, для которых существует хотя бы один объект, и дополнительно могут отображаться все объекты, опубликованные в данном году.

Пример

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

from mysite.books.models import Book from django.conf.urls.defaults import *

from django.views.generic import date_based

book_info = {

“queryset” : Book.objects.all(), “date_field” : “publication_date”

}

urlpatterns = patterns(‘’,

(r’^books/$’, date_based.archive_index, book_info), (r’^books/(?P<year>d{4})/?$’, date_based.archive_year, book_info),

)

Обязательные аргументы

•• date_field: то же, что для представления archive_index (см. предыдущий раздел).

•• queryset: объект QuerySet, содержащий архивные объекты.

•• year: четырехзначный номер года, за который выводится архив (обычно берется из URL, как в примере конфигурации выше).

Необязательные аргументы

•• make_object_list: булевский флаг, показывающий, нужно ли выбирать из базы и передавать в шаблон­ полный список объектов за данный год. Если имеет значение True, то список объектов будет доступен в шаблоне­ в виде переменной object_list (вместо имени object_ list может быть задано другое; см. следующий далее раздел «Контекст шаблона»)­ . По умолчанию имеет значение False.

•• allow_future: булевский флаг, показывающий, следует ли помещать на страницу объекты с датой в будущем (см. совет выше).

В представление могут быть переданы также следующие общие аргументы (см. табл. C.1):

•• allow_empty

•• context_processors

•• extra_context

•• mimetype

•• template_loader

•• template_name

•• template_object_name

Имя шаблона­

В случае отсутствия аргумента template_name представление будет искать шаблон­ с именем <app_label>/<model_name>_archive_year.html.

Контекст шаблона­

Помимо extra_context, в контекст шаблона­ добавляются следующие переменные:

•• date_list: список объектов datetime.date, представляющий месяцы, для которых в наборе queryset имеется хотя бы один объект. Отсортирован в порядке возрастания.

•• year: год в виде строки из четырех цифр.

•• object_list: если аргумент make_object_list имеет значение True, то в этой переменной передается список всех объектов за указанный год, отсортированный по дате. Имя переменной зависит от аргумента template_object_name, который по умолчанию имеет значение ‘object’. Если в аргументе template_object_name передать значение ‘foo’, то переменная будет называться foo_list. Если аргумент make_object_list будет иметь значение False, то в переменной object_list будет передан пустой список.

Архивы за месяц

Функция представления: django.views.generic.date_based.archive_month. Применяется для вывода страниц с архивами за указанный месяц.

Пример

Продолжая предыдущий пример, добавим представление для вывода архивов за месяц:

urlpatterns = patterns(‘’,

(r’^books/$’, date_based.archive_index, book_info), (r’^books/(?P<year>d{4})/?$’, date_based.archive_year, book_info),

(

r’^(?P<year>d{4})/(?P<month>[a-z]{3})/$’, date_based.archive_month,

book_info