{"title":"Generic date views","version":"2.2","locale":"en","docname":"ref/class-based-views/generic-date-based","url":"/en/2.2/ref/class-based-views/generic-date-based/","canonical":"https://djangodocs.dev/en/2.2/ref/class-based-views/generic-date-based/","summary":"Date-based generic views, provided in django.views.generic.dates, are views for displaying drilldown pages for date-based data.","html":"

Generic date viewsLink to this heading#

\n

Date-based generic views, provided in django.views.generic.dates, are\nviews for displaying drilldown pages for date-based data.

\n\n
\n

ArchiveIndexViewLink to this heading#

\n
\n
\nclass ArchiveIndexViewLink to this definition#
\n

A top-level index page showing the “latest” objects, by date. Objects with\na date in the future are not included unless you set allow_future to\nTrue.

\n

Ancestors (MRO)

\n\n

Context

\n

In addition to the context provided by\ndjango.views.generic.list.MultipleObjectMixin (via\ndjango.views.generic.dates.BaseDateListView), the template’s\ncontext will be:

\n
    \n

  • date_list: A QuerySet\nobject containing all years that have objects available according to\nqueryset, represented as datetime.datetime objects, in\ndescending order.

    • \n
\n

Notes

\n
    \n

  • Uses a default context_object_name of latest.

    • \n

  • Uses a default template_name_suffix of _archive.

    • \n

  • Defaults to providing date_list by year, but this can be altered to\nmonth or day using the attribute date_list_period. This also applies\nto all subclass views.

    • \n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\nfrom django.views.generic.dates import ArchiveIndexView\n\nfrom myapp.models import Article\n\nurlpatterns = [\n    path('archive/',\n         ArchiveIndexView.as_view(model=Article, date_field="pub_date"),\n         name="article_archive"),\n]\n
\n

Example myapp/article_archive.html:

\n
Django template
<ul>\n    {% for article in latest %}\n        <li>{{ article.pub_date }}: {{ article.title }}</li>\n    {% endfor %}\n</ul>\n
\n

This will output all articles.

\n
\n\n
\n
\n

YearArchiveViewLink to this heading#

\n
\n
\nclass YearArchiveViewLink to this definition#
\n

A yearly archive page showing all available months in a given year. Objects\nwith a date in the future are not displayed unless you set\nallow_future to True.

\n

Ancestors (MRO)

\n\n
\n
\nmake_object_listLink to this definition#
\n

A boolean specifying whether to retrieve the full list of objects for\nthis year and pass those to the template. If True, the list of\nobjects will be made available to the context. If False, the\nNone queryset will be used as the object list. By default, this is\nFalse.

\n
\n\n
\n
\nget_make_object_list()Link to this definition#
\n

Determine if an object list will be returned as part of the context.\nReturns make_object_list by default.

\n
\n\n

Context

\n

In addition to the context provided by\ndjango.views.generic.list.MultipleObjectMixin (via\ndjango.views.generic.dates.BaseDateListView), the template’s\ncontext will be:

\n
    \n

  • date_list: A QuerySet\nobject containing all months that have objects available according to\nqueryset, represented as datetime.datetime objects, in\nascending order.

    • \n

  • year: A date object\nrepresenting the given year.

    • \n

  • next_year: A date object\nrepresenting the first day of the next year, according to\nallow_empty and\nallow_future.

    • \n

  • previous_year: A date object\nrepresenting the first day of the previous year, according to\nallow_empty and\nallow_future.

    • \n
\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _archive_year.

    • \n
\n

Example myapp/views.py:

\n
Code
from django.views.generic.dates import YearArchiveView\n\nfrom myapp.models import Article\n\nclass ArticleYearArchiveView(YearArchiveView):\n    queryset = Article.objects.all()\n    date_field = "pub_date"\n    make_object_list = True\n    allow_future = True\n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\n\nfrom myapp.views import ArticleYearArchiveView\n\nurlpatterns = [\n    path('<int:year>/',\n         ArticleYearArchiveView.as_view(),\n         name="article_year_archive"),\n]\n
\n

Example myapp/article_archive_year.html:

\n
Django template
<ul>\n    {% for date in date_list %}\n        <li>{{ date|date }}</li>\n    {% endfor %}\n</ul>\n\n<div>\n    <h1>All Articles for {{ year|date:"Y" }}</h1>\n    {% for obj in object_list %}\n        <p>\n            {{ obj.title }} - {{ obj.pub_date|date:"F j, Y" }}\n        </p>\n    {% endfor %}\n</div>\n
\n
\n\n
\n
\n

MonthArchiveViewLink to this heading#

\n
\n
\nclass MonthArchiveViewLink to this definition#
\n

A monthly archive page showing all objects in a given month. Objects with a\ndate in the future are not displayed unless you set allow_future to\nTrue.

\n

Ancestors (MRO)

\n\n

Context

\n

In addition to the context provided by\nMultipleObjectMixin (via\nBaseDateListView), the template’s\ncontext will be:

\n
    \n

  • date_list: A QuerySet\nobject containing all days that have objects available in the given month,\naccording to queryset, represented as datetime.datetime\nobjects, in ascending order.

    • \n

  • month: A date object\nrepresenting the given month.

    • \n

  • next_month: A date object\nrepresenting the first day of the next month, according to\nallow_empty and\nallow_future.

    • \n

  • previous_month: A date object\nrepresenting the first day of the previous month, according to\nallow_empty and\nallow_future.

    • \n
\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _archive_month.

    • \n
\n

Example myapp/views.py:

\n
Code
from django.views.generic.dates import MonthArchiveView\n\nfrom myapp.models import Article\n\nclass ArticleMonthArchiveView(MonthArchiveView):\n    queryset = Article.objects.all()\n    date_field = "pub_date"\n    allow_future = True\n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\n\nfrom myapp.views import ArticleMonthArchiveView\n\nurlpatterns = [\n    # Example: /2012/08/\n    path('<int:year>/<int:month>/',\n         ArticleMonthArchiveView.as_view(month_format='%m'),\n         name="archive_month_numeric"),\n    # Example: /2012/aug/\n    path('<int:year>/<str:month>/',\n         ArticleMonthArchiveView.as_view(),\n         name="archive_month"),\n]\n
\n

Example myapp/article_archive_month.html:

\n
Django template
<ul>\n    {% for article in object_list %}\n        <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>\n    {% endfor %}\n</ul>\n\n<p>\n    {% if previous_month %}\n        Previous Month: {{ previous_month|date:"F Y" }}\n    {% endif %}\n    {% if next_month %}\n        Next Month: {{ next_month|date:"F Y" }}\n    {% endif %}\n</p>\n
\n
\n\n
\n
\n

WeekArchiveViewLink to this heading#

\n
\n
\nclass WeekArchiveViewLink to this definition#
\n

A weekly archive page showing all objects in a given week. Objects with a\ndate in the future are not displayed unless you set allow_future to\nTrue.

\n

Ancestors (MRO)

\n\n

Context

\n

In addition to the context provided by\nMultipleObjectMixin (via\nBaseDateListView), the template’s\ncontext will be:

\n
    \n

  • week: A date object\nrepresenting the first day of the given week.

    • \n

  • next_week: A date object\nrepresenting the first day of the next week, according to\nallow_empty and\nallow_future.

    • \n

  • previous_week: A date object\nrepresenting the first day of the previous week, according to\nallow_empty and\nallow_future.

    • \n
\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _archive_week.

    • \n

  • The week_format attribute is a strptime() format string\nused to parse the week number. The following values are supported:

    \n
      \n

    • '%U': Based on the United States week system where the week\nbegins on Sunday. This is the default value.

      • \n

    • '%W': Similar to '%U', except it assumes that the week\nbegins on Monday. This is not the same as the ISO 8601 week number.

      • \n
    \n
    • \n
\n

Example myapp/views.py:

\n
Code
from django.views.generic.dates import WeekArchiveView\n\nfrom myapp.models import Article\n\nclass ArticleWeekArchiveView(WeekArchiveView):\n    queryset = Article.objects.all()\n    date_field = "pub_date"\n    week_format = "%W"\n    allow_future = True\n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\n\nfrom myapp.views import ArticleWeekArchiveView\n\nurlpatterns = [\n    # Example: /2012/week/23/\n    path('<int:year>/week/<int:week>/',\n         ArticleWeekArchiveView.as_view(),\n         name="archive_week"),\n]\n
\n

Example myapp/article_archive_week.html:

\n
Django template
<h1>Week {{ week|date:'W' }}</h1>\n\n<ul>\n    {% for article in object_list %}\n        <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>\n    {% endfor %}\n</ul>\n\n<p>\n    {% if previous_week %}\n        Previous Week: {{ previous_week|date:"W" }} of year {{ previous_week|date:"Y" }}\n    {% endif %}\n    {% if previous_week and next_week %}--{% endif %}\n    {% if next_week %}\n        Next week: {{ next_week|date:"W" }} of year {{ next_week|date:"Y" }}\n    {% endif %}\n</p>\n
\n

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

\n
\n\n
\n
\n

DayArchiveViewLink to this heading#

\n
\n
\nclass DayArchiveViewLink to this definition#
\n

A day archive page showing all objects in a given day. Days in the future\nthrow a 404 error, regardless of whether any objects exist for future days,\nunless you set allow_future to True.

\n

Ancestors (MRO)

\n\n

Context

\n

In addition to the context provided by\nMultipleObjectMixin (via\nBaseDateListView), the template’s\ncontext will be:

\n\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _archive_day.

    • \n
\n

Example myapp/views.py:

\n
Code
from django.views.generic.dates import DayArchiveView\n\nfrom myapp.models import Article\n\nclass ArticleDayArchiveView(DayArchiveView):\n    queryset = Article.objects.all()\n    date_field = "pub_date"\n    allow_future = True\n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\n\nfrom myapp.views import ArticleDayArchiveView\n\nurlpatterns = [\n    # Example: /2012/nov/10/\n    path('<int:year>/<str:month>/<int:day>/',\n         ArticleDayArchiveView.as_view(),\n         name="archive_day"),\n]\n
\n

Example myapp/article_archive_day.html:

\n
Django template
<h1>{{ day }}</h1>\n\n<ul>\n    {% for article in object_list %}\n        <li>{{ article.pub_date|date:"F j, Y" }}: {{ article.title }}</li>\n    {% endfor %}\n</ul>\n\n<p>\n    {% if previous_day %}\n        Previous Day: {{ previous_day }}\n    {% endif %}\n    {% if previous_day and next_day %}--{% endif %}\n    {% if next_day %}\n        Next Day: {{ next_day }}\n    {% endif %}\n</p>\n
\n
\n\n
\n
\n

TodayArchiveViewLink to this heading#

\n
\n
\nclass TodayArchiveViewLink to this definition#
\n

A day archive page showing all objects for today. This is exactly the\nsame as django.views.generic.dates.DayArchiveView, except today’s\ndate is used instead of the year/month/day arguments.

\n

Ancestors (MRO)

\n\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _archive_today.

    • \n
\n

Example myapp/views.py:

\n
Code
from django.views.generic.dates import TodayArchiveView\n\nfrom myapp.models import Article\n\nclass ArticleTodayArchiveView(TodayArchiveView):\n    queryset = Article.objects.all()\n    date_field = "pub_date"\n    allow_future = True\n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\n\nfrom myapp.views import ArticleTodayArchiveView\n\nurlpatterns = [\n    path('today/',\n         ArticleTodayArchiveView.as_view(),\n         name="archive_today"),\n]\n
\n\n
\n\n
\n
\n

DateDetailViewLink to this heading#

\n
\n
\nclass DateDetailViewLink to this definition#
\n

A page representing an individual object. If the object has a date value in\nthe future, the view will throw a 404 error by default, unless you set\nallow_future to True.

\n

Ancestors (MRO)

\n\n

Context

\n
    \n

  • Includes the single object associated with the model specified in\nthe DateDetailView.

    • \n
\n

Notes

\n
    \n

  • Uses a default template_name_suffix of _detail.

    • \n
\n

Example myapp/urls.py:

\n
Code
from django.urls import path\nfrom django.views.generic.dates import DateDetailView\n\nurlpatterns = [\n    path('<int:year>/<str:month>/<int:day>/<int:pk>/',\n         DateDetailView.as_view(model=Article, date_field="pub_date"),\n         name="archive_date_detail"),\n]\n
\n

Example myapp/article_detail.html:

\n
Django template
<h1>{{ object.title }}</h1>\n
\n
\n\n\n
","rootId":"module-django.views.generic.dates","toc":[{"title":"ArchiveIndexView","anchor":"archiveindexview","children":[]},{"title":"YearArchiveView","anchor":"yeararchiveview","children":[]},{"title":"MonthArchiveView","anchor":"montharchiveview","children":[]},{"title":"WeekArchiveView","anchor":"weekarchiveview","children":[]},{"title":"DayArchiveView","anchor":"dayarchiveview","children":[]},{"title":"TodayArchiveView","anchor":"todayarchiveview","children":[]},{"title":"DateDetailView","anchor":"datedetailview","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/en/2.2/ref/"},{"docname":"ref/class-based-views/index","title":"Built-in class-based views API","url":"/en/2.2/ref/class-based-views/"}],"prev":{"docname":"ref/class-based-views/generic-editing","title":"Generic editing views","url":"/en/2.2/ref/class-based-views/generic-editing/"},"next":{"docname":"ref/class-based-views/mixins","title":"Class-based views mixins","url":"/en/2.2/ref/class-based-views/mixins/"},"formats":{"html":"/en/2.2/ref/class-based-views/generic-date-based/","markdown":"/en/2.2/ref/class-based-views/generic-date-based.md","json":"/en/2.2/ref/class-based-views/generic-date-based.json"},"source":"https://github.com/django/django/blob/stable/2.2.x/docs/ref/class-based-views/generic-date-based.txt","official":"https://docs.djangoproject.com/en/2.2/ref/class-based-views/generic-date-based/","inVersions":["dev","6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9","1.8"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}