Общие представления на основе даты ¶
Общие представления на основе даты, определенные в django.views.generic.dates
, представляют собой представления, предназначенные для отображения страниц с подробными данными по дате.
Заметка
Некоторые примеры на этой странице основаны на шаблоне, Article
определенном следующим образом в myapp/models.py
:
from django.db import models
from django.urls import reverse
class Article(models.Model):
title = models.CharField(max_length=200)
pub_date = models.DateField()
def get_absolute_url(self):
return reverse('article-detail', kwargs={'pk': self.pk})
ArchiveIndexView
¶
-
класс
ArchiveIndexView
¶ Страница сводки верхнего уровня, показывающая "последние" элементы по дате. Объекты с датой в будущем не включаются, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseArchiveIndexView
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
контекст
В дополнение к контексту, предоставленному
django.views.generic.list.MultipleObjectMixin
(черезdjango.views.generic.dates.BaseDateListView
), контекст шаблона будет:date_list
: объект,QuerySet
содержащий все годы с доступными объектами на основеqueryset
, представленный как объектыdatetime.datetime
в обратном хронологическом порядке.
Ноты
- По умолчанию
context_object_name
этоlatest
. - По умолчанию
template_name_suffix
это_archive
. - Поведение по умолчанию -
date_list
по годам, но также можно использовать месяцы или дни, изменив атрибутdate_list_period
. Это также относится ко всем подклассам этого представления.
Пример Myapp / urls.py :
from django.urls import path from django.views.generic.dates import ArchiveIndexView from myapp.models import Article urlpatterns = [ path('archive/', ArchiveIndexView.as_view(model=Article, date_field="pub_date"), name="article_archive"), ]
Пример из myapp / article_archive.html :
<ul> {% for article in latest %} <li>{{ article.pub_date }}: {{ article.title }}</li> {% endfor %} </ul>
Здесь отображаются все статьи.
YearArchiveView
¶
-
класс
YearArchiveView
¶ Страница годового архива, показывающая все доступные месяцы в данном году. Объекты с датой в будущем не включаются, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseYearArchiveView
django.views.generic.dates.YearMixin
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
-
make_object_list
¶ Логическое значение, указывающее, следует ли получить полный список объектов за текущий год и передать их в шаблон. Если значение равно
True
, список будет доступен в контексте. В противном случае, если значение равноFalse
, набор запросаNone
будет использоваться как список объектов. По умолчанию это значениеFalse
.
-
get_make_object_list
() ¶ Определяет, возвращается ли список объектов как часть контекста. Возврат
make_object_list
по умолчанию.
контекст
В дополнение к контексту, предоставленному
django.views.generic.list.MultipleObjectMixin
(черезdjango.views.generic.dates.BaseDateListView
), контекст шаблона будет:date_list
: Объект ,QuerySet
содержащий все месяцы, доступные объекты , основанные наqueryset
, представленные в виде объектовdatetime.datetime
в хронологическом порядке.year
: объект,date
представляющий указанный год.next_year
: объект,date
представляющий первый день следующего года, в зависимости отallow_empty
иallow_future
.previous_year
: объект,date
представляющий первый день предыдущего года, в зависимости отallow_empty
иallow_future
.
Ноты
- По умолчанию
template_name_suffix
это_archive_year
.
Пример Myapp / views.py :
from django.views.generic.dates import YearArchiveView from myapp.models import Article class ArticleYearArchiveView(YearArchiveView): queryset = Article.objects.all() date_field = "pub_date" make_object_list = True allow_future = True
Пример Myapp / urls.py :
from django.urls import path from myapp.views import ArticleYearArchiveView urlpatterns = [ path('<int:year>/', ArticleYearArchiveView.as_view(), name="article_year_archive"), ]
Пример myapp / article_archive_year.html :
<ul> {% for date in date_list %} <li>{{ date|date }}</li> {% endfor %} </ul> <div> <h1>All Articles for {{ year|date:"Y" }}</h1> {% for obj in object_list %} <p> {{ obj.title }} - {{ obj.pub_date|date:"F j, Y" }} </p> {% endfor %} </div>
MonthArchiveView
¶
-
класс
MonthArchiveView
¶ Страница ежемесячного архива, на которой показаны все доступные элементы за данный месяц. Объекты с датой в будущем не включаются, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseMonthArchiveView
django.views.generic.dates.YearMixin
django.views.generic.dates.MonthMixin
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
контекст
В дополнение к контексту, предоставленному классом
MultipleObjectMixin
(черезBaseDateListView
), контекст шаблона будет:date_list
: Объект,QuerySet
содержащий все дни, в которых есть объекты, доступные в указанном месяце, на основеqueryset
, представленные как объектыdatetime.datetime
в хронологическом порядке.month
: объект,date
представляющий данный месяц.next_month
: объект,date
представляющий первый день следующего месяца, в зависимости отallow_empty
иallow_future
.previous_month
: объект,date
представляющий первый день предыдущего месяца на основеallow_empty
иallow_future
.
Ноты
- По умолчанию
template_name_suffix
это_archive_month
.
Пример Myapp / views.py :
from django.views.generic.dates import MonthArchiveView from myapp.models import Article class ArticleMonthArchiveView(MonthArchiveView): queryset = Article.objects.all() date_field = "pub_date" allow_future = True
Пример Myapp / urls.py :
from django.urls import path from myapp.views import ArticleMonthArchiveView urlpatterns = [ # Example: /2012/08/ path('<int:year>/<int:month>/', ArticleMonthArchiveView.as_view(month_format='%m'), name="archive_month_numeric"), # Example: /2012/aug/ path('<int:year>/<str:month>/', ArticleMonthArchiveView.as_view(), name="archive_month"), ]
Пример myapp / article_archive_month.html :
<ul> {% for article in object_list %} <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li> {% endfor %} </ul> <p> {% if previous_month %} Previous Month: {{ previous_month|date:"F Y" }} {% endif %} {% if next_month %} Next Month: {{ next_month|date:"F Y" }} {% endif %} </p>
WeekArchiveView
¶
-
класс
WeekArchiveView
¶ Страница еженедельного архива, на которой показаны все доступные элементы за данную неделю. Объекты с датой в будущем не включаются, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseWeekArchiveView
django.views.generic.dates.YearMixin
django.views.generic.dates.WeekMixin
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
контекст
В дополнение к контексту, предоставленному классом
MultipleObjectMixin
(черезBaseDateListView
), контекст шаблона будет:week
: объект,date
представляющий первый день указанной недели.next_week
: объект,date
представляющий первый день следующей недели в соответствии сallow_empty
иallow_future
.previous_week
: объект,date
представляющий первый день предыдущей недели на основеallow_empty
иallow_future
.
Ноты
- По умолчанию
template_name_suffix
это_archive_week
. - Атрибут
week_format
представляет собой строку формата,strptime()
используемую для получения номера недели. Поддерживаются следующие значения:'%U'
: На основе недельной системы США, где неделя начинается в воскресенье. Это значение по умолчанию.'%W'
: аналогично'%U'
, за исключением недели, начинающейся с понедельника. Это не то же самое, что номер недели ISO 8601.
Пример Myapp / views.py :
from django.views.generic.dates import WeekArchiveView from myapp.models import Article class ArticleWeekArchiveView(WeekArchiveView): queryset = Article.objects.all() date_field = "pub_date" week_format = "%W" allow_future = True
Пример Myapp / urls.py :
from django.urls import path from myapp.views import ArticleWeekArchiveView urlpatterns = [ # Example: /2012/week/23/ path('<int:year>/week/<int:week>/', ArticleWeekArchiveView.as_view(), name="archive_week"), ]
Пример myapp / article_archive_week.html :
<h1>Week {{ week|date:'W' }}</h1> <ul> {% for article in object_list %} <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li> {% endfor %} </ul> <p> {% if previous_week %} Previous Week: {{ previous_week|date:"W" }} of year {{ previous_week|date:"Y" }} {% endif %} {% if previous_week and next_week %}--{% endif %} {% if next_week %} Next week: {{ next_week|date:"W" }} of year {{ next_week|date:"Y" }} {% endif %} </p>
В этом примере отображается номер недели. Помните , что номер недели , произведенный шаблон фильтр
date
с форматированием символа'W'
не всегда совпадает с номерами недель , произведенных в формате строка'%W'
изstrftime()
иstrptime()
. Например, для 2015 года номера недель, произведенные с помощьюdate
, на единицу больше, чем номера недельstrftime()
. Там не соответствует формату строки'%U'
изstrftime()
дляdate
. Поэтому нам следует избегать использованияdate
для генерации URL-адресов для представленияWeekArchiveView
.
DayArchiveView
¶
-
класс
DayArchiveView
¶ Страница ежедневного архива, показывающая все доступные элементы за данный день. Дни с датой в будущем генерируют ошибку 404 независимо от того, существуют ли объекты для будущих дней, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseDayArchiveView
django.views.generic.dates.YearMixin
django.views.generic.dates.MonthMixin
django.views.generic.dates.DayMixin
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
контекст
В дополнение к контексту, предоставленному классом
MultipleObjectMixin
(черезBaseDateListView
), контекст шаблона будет:day
: объект,date
представляющий указанный день.next_day
: объект,date
представляющий следующий день, в зависимости отallow_empty
иallow_future
.previous_day
: объект,date
представляющий предыдущий день, в зависимости отallow_empty
иallow_future
.next_month
: объект,date
представляющий первый день следующего месяца, в зависимости отallow_empty
иallow_future
.previous_month
: объект,date
представляющий первый день предыдущего месяца на основеallow_empty
иallow_future
.
Ноты
- По умолчанию
template_name_suffix
это_archive_day
.
Пример Myapp / views.py :
from django.views.generic.dates import DayArchiveView from myapp.models import Article class ArticleDayArchiveView(DayArchiveView): queryset = Article.objects.all() date_field = "pub_date" allow_future = True
Пример Myapp / urls.py :
from django.urls import path from myapp.views import ArticleDayArchiveView urlpatterns = [ # Example: /2012/nov/10/ path('<int:year>/<str:month>/<int:day>/', ArticleDayArchiveView.as_view(), name="archive_day"), ]
Пример myapp / article_archive_day.html :
<h1>{{ day }}</h1> <ul> {% for article in object_list %} <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li> {% endfor %} </ul> <p> {% if previous_day %} Previous Day: {{ previous_day }} {% endif %} {% if previous_day and next_day %}--{% endif %} {% if next_day %} Next Day: {{ next_day }} {% endif %} </p>
TodayArchiveView
¶
-
класс
TodayArchiveView
¶ Страница ежедневного архива, на которой показаны все элементы, доступные на сегодня . Это точно такое же представление
django.views.generic.dates.DayArchiveView
, за исключением того, что учитывается сегодняшняя дата вместо параметровyear
/month
/day
.Предки (ТОиР)
django.views.generic.list.MultipleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseTodayArchiveView
django.views.generic.dates.BaseDayArchiveView
django.views.generic.dates.YearMixin
django.views.generic.dates.MonthMixin
django.views.generic.dates.DayMixin
django.views.generic.dates.BaseDateListView
django.views.generic.list.MultipleObjectMixin
django.views.generic.dates.DateMixin
django.views.generic.base.View
Ноты
- По умолчанию
template_name_suffix
это_archive_today
.
Пример Myapp / views.py :
from django.views.generic.dates import TodayArchiveView from myapp.models import Article class ArticleTodayArchiveView(TodayArchiveView): queryset = Article.objects.all() date_field = "pub_date" allow_future = True
Пример Myapp / urls.py :
from django.urls import path from myapp.views import ArticleTodayArchiveView urlpatterns = [ path('today/', ArticleTodayArchiveView.as_view(), name="archive_today"), ]
Где образец шаблона
TodayArchiveView
?По умолчанию в этом представлении используется тот же шаблон, что и
DayArchiveView
в предыдущем примере. Если вам нужен другой шаблон, установите атрибутtemplate_name
с именем нового шаблона.
DateDetailView
¶
-
класс
DateDetailView
¶ Страница, представляющая отдельный объект. Если объект содержит значение даты в будущем, по умолчанию отображается ошибка 404, если
allow_future
не установлено значениеTrue
.Предки (ТОиР)
django.views.generic.detail.SingleObjectTemplateResponseMixin
django.views.generic.base.TemplateResponseMixin
django.views.generic.dates.BaseDateDetailView
django.views.generic.dates.YearMixin
django.views.generic.dates.MonthMixin
django.views.generic.dates.DayMixin
django.views.generic.dates.DateMixin
django.views.generic.detail.BaseDetailView
django.views.generic.detail.SingleObjectMixin
django.views.generic.base.View
контекст
- Включает уникальный объект, связанный с
model
определенным в представленииDateDetailView
.
Ноты
- По умолчанию
template_name_suffix
это_detail
.
Пример Myapp / urls.py :
from django.urls import path from django.views.generic.dates import DateDetailView urlpatterns = [ path('<int:year>/<str:month>/<int:day>/<int:pk>/', DateDetailView.as_view(model=Article, date_field="pub_date"), name="archive_date_detail"), ]
Пример myapp / article_detail.html :
<h1>{{ object.title }}</h1>
Заметка
Все упомянутые выше общие представления имеют Base
соответствующие представления , единственное отличие которых состоит в том, что они не включают MultipleObjectTemplateResponseMixin
(для архивных представлений) и SingleObjectTemplateResponseMixin
(для DateDetailView
):
-
класс
BaseArchiveIndexView
¶
-
класс
BaseYearArchiveView
¶
-
класс
BaseMonthArchiveView
¶
-
класс
BaseWeekArchiveView
¶
-
класс
BaseDayArchiveView
¶
-
класс
BaseTodayArchiveView
¶
-
класс
BaseDateDetailView
¶