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

Представления на основе даты, предоставленные в 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 [source]

Главная страница индекса, отображающая «последние» объекты по дате. Объекты с датой в будущем не включаются, если вы не установите 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 [source]

Страница годового архива, отображающая все доступные месяцы в данном году. Объекты с датой в будущем не отображаются, если вы не установите 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 [source]

Страница месячного архива, отображающая все объекты за данный месяц. Объекты с датой в будущем не отображаются, если вы не установили 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 [source]

Страница архива по неделям, показывающая все объекты за определённую неделю. Объекты с датой в будущем не отображаются, если вы не установите 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, где неделя начинается с понедельника.

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

`DayArchiveView`

class DayArchiveView [source]

Страница архива по дням, отображающая все объекты за данный день. Дни в будущем вызывают ошибку 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 [source]

Страница архива по дням, отображающая все объекты за сегодня. Это точно так же, как 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 [source]

Страница, представляющая отдельный объект. Если у объекта есть дата в будущем, по умолчанию будет выброшена ошибка 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 [source]

class BaseYearArchiveView [source]

class BaseMonthArchiveView [source]

class BaseWeekArchiveView [source]

class BaseDayArchiveView [source]

class BaseTodayArchiveView [source]

class BaseDateDetailView [source]

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