Общие представления дат

Основанные на датах общие представления, предоставленные в 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`

class ArchiveIndexView

Страница верхнего уровня, показывающая «самые свежие» объекты по дате. Объекты с датой в будущем не включаются, если вы не установите allow_future в True.

Предки (MRO)

Контекст

В дополнение к контексту, предоставляемому 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`

class YearArchiveView

Страница ежегодного архива, показывающая все доступные месяцы в данном году. Объекты с датой в будущем не отображаются, если вы не установите allow_future в True.

Предки (MRO)

make_object_list: Булево значение, указывающее, нужно ли извлекать полный список объектов для данного года и передавать их в шаблон. Если True, список объектов будет доступен в контексте. Если False, будет использоваться набор данных None в качестве списка объектов. По умолчанию это False.

get_make_object_list(): Определяет, будет ли возвращен список объектов в составе контекста. По умолчанию возвращает make_object_list.

Контекст

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`

class MonthArchiveView

Страница ежемесячного архива, отображающая все объекты за данный месяц. Объекты с датой в будущем не отображаются, если вы не установите allow_future в True.

Предки (MRO)

Контекст

В дополнение к контексту, предоставляемому 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`

class WeekArchiveView

Страница еженедельного архива, отображающая все объекты за заданную неделю. Объекты с датой в будущем не отображаются, если вы не установите allow_future в True.

Предки (MRO)

Контекст

В дополнение к контексту, предоставляемому 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.
- '%V': Номер недели ISO 8601, где неделя начинается с понедельника.
  
  Добавлено в Django 3.2:
  Добавлена поддержка формата недели '%V'.

Пример 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', не всегда совпадают с теми, которые вычислены с помощью strftime() и strptime() со строкой формата '%W'. Например, для года 2015 номера недель, выведенные фильтром date, будут на единицу больше, чем выведенные strftime(). В date нет эквивалента для строки формата '%U' strftime(). Поэтому следует избегать использования date для генерации URL-адресов для WeekArchiveView.

`DayArchiveView`

class DayArchiveView

Страница архива на день, показывающая все объекты на заданный день. Дни в будущем вызывают ошибку 404, независимо от того, существуют ли какие-либо объекты для будущих дней, если вы не установите allow_future в значение True.

Предки (MRO)

Контекст

В дополнение к контексту, предоставляемому 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`

class TodayArchiveView

Страница архива на день, показывающая все объекты за сегодняшний день. Это точно так же, как django.views.generic.dates.DayArchiveView, за исключением того, что используется дата сегодняшнего дня вместо аргументов year/month/day.

Предки (MRO)

Примечания

Использует по умолчанию 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`

class DateDetailView

Страница, представляющая отдельный объект. Если у объекта есть значение даты в будущем, по умолчанию будет выброшено ошибку 404, если вы не установите allow_future в True.

Предки (MRO)

Контекст

Включает единственный объект, связанный со 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):

class BaseArchiveIndexView

class BaseYearArchiveView

class BaseMonthArchiveView

class BaseWeekArchiveView

class BaseDayArchiveView

class BaseTodayArchiveView

class BaseDateDetailView

© Django Software Foundation and individual contributors
Licensed under the BSD License.
https://docs.djangoproject.com/en/3.2/ref/class-based-views/generic-date-based/