Generic date ビュー¶

日付ベースの汎用ビュー (django.views.generic.dates 内で提供されています) は、日付ベースのデータのために、ドリルダウンページを描画するためのビューです。

注釈

このページの例のいくつかは、myapp/models.py 内で下記の通り Article モデルが定義されていると仮定します:

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.dates.BaseDateListView を通じた) django.views.generic.list.MultipleObjectMixin によって提供されたコンテキストに加えて、テンプレートのコンテキストは以下のようになります:

date_list: queryset に従ってオブジェクトを利用可能にするすべての年を含む QuerySet オブジェクトです。datetime.datetime オブジェクトとして表され、降順で表示されます。

ノート

デフォルトの 最新 の context_object_name を使います。
デフォルトの _archive の template_name_suffix を使います。
年によって 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>

これは、すべての記事 (article) を出力します。

`YearArchiveView`¶

class YearArchiveView¶

与えられた年の中で有効な月を表示する、年次のアーカイブページです。allow_future を True にセットしない限り、未来の日付を伴うオブジェクトは表示されません。

継承元 (MRO)

make_object_list¶: A boolean specifying whether to retrieve the full list of objects for this year and pass those to the template. If True, the list of objects will be made available to the context. If False, the None queryset will be used as the object list. By default, this is False.

get_make_object_list()¶: Determine if an object list will be returned as part of the context. Returns make_object_list by default.

コンテキスト

(django.views.generic.dates.BaseDateListView を通じた) django.views.generic.list.MultipleObjectMixin によって提供されたコンテキストに加えて、テンプレートのコンテキストは以下のようになります:

date_list: A QuerySet object containing all months that have objects available according to queryset, represented as datetime.datetime objects, in ascending order.
year: A date object representing the given year.
next_year: A date object representing the first day of the next year, according to allow_empty and allow_future.
previous_year: A date object representing the first day of the previous year, according to allow_empty and allow_future.

ノート

Uses a default template_name_suffix of _archive_year.

Example 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"),
]

Example 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)

コンテキスト

In addition to the context provided by MultipleObjectMixin (via BaseDateListView), the template's context will be:

date_list: A QuerySet object containing all days that have objects available in the given month, according to queryset, represented as datetime.datetime objects, in ascending order.
month: A date object representing the given month.
next_month: A date object representing the first day of the next month, according to allow_empty and allow_future.
previous_month: A date object representing the first day of the previous month, according to allow_empty and allow_future.

ノート

Uses a default template_name_suffix of _archive_month.

Example 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"),
]

Example 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)

コンテキスト

In addition to the context provided by MultipleObjectMixin (via BaseDateListView), the template's context will be:

week: A date object representing the first day of the given week.
next_week: A date object representing the first day of the next week, according to allow_empty and allow_future.
previous_week: A date object representing the first day of the previous week, according to allow_empty and allow_future.

ノート

Uses a default template_name_suffix of _archive_week.
The week_format attribute is a strptime() format string used to parse the week number. The following values are supported:
- '%U': Based on the United States week system where the week begins on Sunday. This is the default value.
- '%W': Similar to '%U', except it assumes that the week begins on Monday. This is not the same as the ISO 8601 week number.
- '%V': ISO 8601 week number where the week begins on Monday.
  
  New in Django 3.2:
  Support for the '%V' week format was added.

Example 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"),
]

Example 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>

In this example, you are outputting the week number. Keep in mind that week numbers computed by the date template filter with the 'W' format character are not always the same as those computed by strftime() and strptime() with the '%W' format string. For year 2015, for example, week numbers output by date are higher by one compared to those output by strftime(). There isn't an equivalent for the '%U' strftime() format string in date. Therefore, you should avoid using date to generate URLs for WeekArchiveView.

`DayArchiveView`¶

class DayArchiveView¶

与えられた日の中で有効な全オブジェクトを表示する、日次のアーカイブページです。allow_future を True にセットしない限り、未来の日付に対するオブジェクトがするかどうかにかかわらず、未来の日付は 404 エラーを返します。

継承元 (MRO)

コンテキスト

In addition to the context provided by MultipleObjectMixin (via BaseDateListView), the template's context will be:

day: A date object representing the given day.
next_day: A date object representing the next day, according to allow_empty and allow_future.
previous_day: A date object representing the previous day, according to allow_empty and allow_future.
next_month: A date object representing the first day of the next month, according to allow_empty and allow_future.
previous_month: A date object representing the first day of the previous month, according to allow_empty and allow_future.

ノート

Uses a default template_name_suffix of _archive_day.

Example 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"),
]

Example 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 とまったく同じです。

継承元 (MRO)

ノート

Uses a default template_name_suffix of _archive_today.

Example 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¶

個別のオブジェクトを表示するページです。オブジェクトが未来の日付値を持っている場合、allow_future を True にセットしない限り、デフォルトでビューは 404 エラーを返します。

継承元 (MRO)

コンテキスト

Includes the single object associated with the model specified in the DateDetailView.

ノート

Uses a default template_name_suffix of _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"),
]

Example myapp/article_detail.html:

<h1>{{ object.title }}</h1>

注釈

All of the generic views listed above have matching Base views that only differ in that they do not include the MultipleObjectTemplateResponseMixin (for the archive views) or SingleObjectTemplateResponseMixin (for the DateDetailView):

class BaseArchiveIndexView¶

class BaseYearArchiveView¶

class BaseMonthArchiveView¶

class BaseWeekArchiveView¶

class BaseDayArchiveView¶

class BaseTodayArchiveView¶

class BaseDateDetailView¶

Django 4.0.6 ドキュメント

Generic date ビュー¶

`ArchiveIndexView`¶

`YearArchiveView`¶

`MonthArchiveView`¶

`WeekArchiveView`¶

`DayArchiveView`¶

`TodayArchiveView`¶

`DateDetailView`¶

目次

前のトピックへ

次のトピックへ

関連キーワード

Last update:

Django 4.0.6 ドキュメント

Generic date ビュー¶

ArchiveIndexView¶

YearArchiveView¶

MonthArchiveView¶

WeekArchiveView¶

DayArchiveView¶

TodayArchiveView¶

DateDetailView¶

Last update:

`ArchiveIndexView`¶

`YearArchiveView`¶

`MonthArchiveView`¶

`WeekArchiveView`¶

`DayArchiveView`¶

`TodayArchiveView`¶

`DateDetailView`¶