Date-based generic views, provided in django.views.generic.dates
, are views for displaying drilldown pages for date-based data.
A top-level index page showing the latest objects, by date. Objects with a date in the future are not included unless you set allow_future
to True
.
Context
In addition to the context provided by django.views.generic.list.MultipleObjectMixin
(via django.views.generic.dates.BaseDateListView
), the template's context will be:
date_list
: ADateQuerySet
object containing all years that have objects available according toqueryset
, represented asdatetime.datetime
objects, in descending order
Notes
- Uses a default
context_object_name
oflatest
. - Uses a default
template_name_suffix
of_archive
. - Defaults to providing
date_list
by year, but this can be altered to month or day using the attributedate_list_period
. This also applies to all subclass views:
Example myapp/urls.py: from django.conf.urls import url from django.views.generic.dates import ArchiveIndexView from myapp.models import Article urlpatterns = [ url(r'^archive/$', ArchiveIndexView.as_view(model=Article, date_field="pub_date"), name="article_archive"), ]
Example myapp/article_archive.html:
<ul> {% for article in latest %} <li>{{ article.pub_date }}: {{ article.title }}</li> {% endfor %} </ul>
This will output all articles.
A yearly archive page showing all available months in a given year. Objects with a date in the future are not displayed unless you set allow_future
to True
.
Context
In addition to the context provided by django.views.generic.list.MultipleObjectMixin
(via django.views.generic.dates.BaseDateListView
), the template's context will be:
date_list
: ADateQuerySet
object containing all months that have objects available according toqueryset
, represented asdatetime.datetime
objects, in ascending orderyear
: Adate
object representing the given yearnext_year
: Adate
object representing the first day of the next year, according toallow_empty
andallow_future
previous_year
: Adate
object representing the first day of the previous year, according toallow_empty
andallow_future
Notes
- 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
Example myapp/urls.py:
from django.conf.urls import url from myapp.views import ArticleYearArchiveView urlpatterns = [ url(r'^(?P<year>[0-9]{4})/$', 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>
A monthly archive page showing all objects in a given month. Objects with a date in the future are not displayed unless you set allow_future
to True
.
Context
In addition to the context provided by MultipleObjectMixin
(via BaseDateListView
), the template's context will be:
date_list
: ADateQuerySet
object containing all days that have objects available in the given month, according toqueryset
, represented asdatetime.datetime
objects, in ascending ordermonth
: Adate
object representing the given monthnext_month
: Adate
object representing the first day of the next month, according toallow_empty
andallow_future
previous_month
: Adate
object representing the first day of the previous month, according toallow_empty
andallow_future
Notes
- 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" make_object_list = True allow_future = True
Example myapp/urls.py:
from django.conf.urls import url from myapp.views import ArticleMonthArchiveView urlpatterns = [ # Example: /2012/aug/ url(r'^(?P<year>[0-9]{4})/(?P<month>[-\w]+)/$', ArticleMonthArchiveView.as_view(), name="archive_month"), # Example: /2012/08/ url(r'^(?P<year>[0-9]{4})/(?P<month>[0-9]+)/$', ArticleMonthArchiveView.as_view(month_format='%m'), name="archive_month_numeric"), ]
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>
A weekly archive page showing all objects in a given week. Objects with a date in the future are not displayed unless you set allow_future
to True
.
Context
In addition to the context provided by MultipleObjectMixin
(via BaseDateListView
), the template's context will be:
week
: Adate
object representing the first day of the given weeknext_week
: Adate
object representing the first day of the next week, according toallow_empty
andallow_future
previous_week
: Adate
object representing the first day of the previous week, according toallow_empty
andallow_future
Notes
- Uses a default
template_name_suffix
of_archive_week
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" make_object_list = True week_format = "%W" allow_future = True
Example myapp/urls.py:
from django.conf.urls import url from myapp.views import ArticleWeekArchiveView urlpatterns = [ # Example: /2012/week/23/ url(r'^(?P<year>[0-9]{4})/week/(?P<week>[0-9]+)/$', 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:"F Y" }} {% endif %} {% if previous_week and next_week %}--{% endif %} {% if next_week %} Next week: {{ next_week|date:"F Y" }} {% endif %} </p>
In this example, you are outputting the week number. The default week_format
in the WeekArchiveView
uses week format "%U
" which is based on the United States week system where the week begins on a Sunday. The "%W
" format uses the ISO week format and its week begins on a Monday. The "%W
" format is the same in both the strftime()
and the date
.
However, the date
template filter does not have an equivalent output format that supports the US based week system. The date
filter "%U
" outputs the number of seconds since the Unix epoch.
A day archive page showing all objects in a given day. Days in the future throw a 404 error, regardless of whether any objects exist for future days, unless you set allow_future
to True
.
Context
In addition to the context provided by MultipleObjectMixin
(via BaseDateListView
), the template's context will be:
day
: Adate
object representing the given daynext_day
: Adate
object representing the next day, according toallow_empty
andallow_future
previous_day
: Adate
object representing the previous day, according toallow_empty
andallow_future
next_month
: Adate
object representing the first day of the next month, according toallow_empty
andallow_future
previous_month
: Adate
object representing the first day of the previous month, according toallow_empty
andallow_future
Notes
- 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" make_object_list = True allow_future = True
Example myapp/urls.py:
from django.conf.urls import url from myapp.views import ArticleDayArchiveView urlpatterns = [ # Example: /2012/nov/10/ url(r'^(?P<year>[0-9]{4})/(?P<month>[-\w]+)/(?P<day>[0-9]+)/$', 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>
A day archive page showing all objects for today. This is exactly the same as django.views.generic.dates.DayArchiveView
, except today's date is used instead of the year
/month
/day
arguments.
Notes
- 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" make_object_list = True allow_future = True
Example myapp/urls.py:
from django.conf.urls import url from myapp.views import ArticleTodayArchiveView urlpatterns = [ url(r'^today/$', ArticleTodayArchiveView.as_view(), name="archive_today"), ]
Where is the example template for TodayArchiveView
?
This view uses by default the same template as the DayArchiveView
, which is in the previous example. If you need a different template, set the template_name
attribute to be the name of the new template.
A page representing an individual object. If the object has a date value in the future, the view will throw a 404 error by default, unless you set allow_future
to True
.
Context
- Includes the single object associated with the
model
specified in theDateDetailView
Notes
- Uses a default
template_name_suffix
of_detail
Example myapp/urls.py: from django.conf.urls import url from django.views.generic.dates import DateDetailView urlpatterns = [ url(r'^(?P<year>[0-9]+)/(?P<month>[-\w]+)/(?P<day>[0-9]+)/ (?P<pk>[0-9]+)/$', DateDetailView.as_view(model=Article, date_field="pub_date"), name="archive_date_detail"), ]
Example myapp/article_detail.html:
<h1>{{ object.title }}</h1>