class BaseDateListView
[source]
A base class that provides common behavior for all date-based views. There won’t normally be a reason to instantiate BaseDateListView
; instantiate one of the subclasses instead.
While this view (and its subclasses) are executing, self.object_list
will contain the list of objects that the view is operating upon, and self.date_list
will contain the list of dates for which data is available.
Mixins
DateMixin
MultipleObjectMixin
Methods and Attributes
-
allow_empty
-
A boolean specifying whether to display the page if no objects are available. If this is
True
and no objects are available, the view will display an empty page instead of raising a 404.This is identical to
django.views.generic.list.MultipleObjectMixin.allow_empty
, except for the default value, which isFalse
.
-
date_list_period
-
Optional A string defining the aggregation period for
date_list
. It must be one of'year'
(default),'month'
, or'day'
.
-
get_dated_items()
[source] -
Returns a 3-tuple containing (
date_list
,object_list
,extra_context
).date_list
is the list of dates for which data is available.object_list
is the list of objects.extra_context
is a dictionary of context data that will be added to any context data provided by theMultipleObjectMixin
.
-
get_dated_queryset(**lookup)
[source] -
Returns a queryset, filtered using the query arguments defined by
lookup
. Enforces any restrictions on the queryset, such asallow_empty
andallow_future
.
-
get_date_list_period()
[source] -
Returns the aggregation period for
date_list
. Returnsdate_list_period
by default.
-
get_date_list(queryset, date_type=None, ordering='ASC')
[source] -
Returns the list of dates of type
date_type
for whichqueryset
contains entries. For example,get_date_list(qs, 'year')
will return the list of years for whichqs
has entries. Ifdate_type
isn’t provided, the result ofget_date_list_period()
is used.date_type
andordering
are simply passed toQuerySet.dates()
.
Please login to continue.