YearMixinLink to this heading#A mixin that can be used to retrieve and provide parsing information for a\nyear component of a date.
\nMethods and Attributes
\nThe strftime() format to use when parsing the year.\nBy default, this is '%Y'.
Optional The value for the year, as a string. By default, set to\nNone, which means the year will be determined using other means.
Returns the strftime() format to use when parsing the\nyear. Returns year_format by default.
Returns the year for which this view will display data, as a string.\nTries the following sources, in order:
\nThe value of the YearMixin.year attribute.
The value of the year argument captured in the URL pattern.
The value of the year GET query argument.
Raises a 404 if no valid year specification can be found.
\nReturns a date object containing the first day of the year after the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
Returns a date object containing the first day of the year before the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
MonthMixinLink to this heading#A mixin that can be used to retrieve and provide parsing information for a\nmonth component of a date.
\nMethods and Attributes
\nThe strftime() format to use when parsing the month. By\ndefault, this is '%b'.
Optional The value for the month, as a string. By default, set to\nNone, which means the month will be determined using other means.
Returns the strftime() format to use when parsing the\nmonth. Returns month_format by default.
Returns the month for which this view will display data, as a string.\nTries the following sources, in order:
\nThe value of the MonthMixin.month attribute.
The value of the month argument captured in the URL pattern.
The value of the month GET query argument.
Raises a 404 if no valid month specification can be found.
\nReturns a date object containing the first day of the month after the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
Returns a date object containing the first day of the month before the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
DayMixinLink to this heading#A mixin that can be used to retrieve and provide parsing information for a\nday component of a date.
\nMethods and Attributes
\nThe strftime() format to use when parsing the day. By\ndefault, this is '%d'.
Optional The value for the day, as a string. By default, set to\nNone, which means the day will be determined using other means.
Returns the strftime() format to use when parsing the day.\nReturns day_format by default.
Returns the day for which this view will display data, as a string.\nTries the following sources, in order:
\nThe value of the DayMixin.day attribute.
The value of the day argument captured in the URL pattern.
The value of the day GET query argument.
Raises a 404 if no valid day specification can be found.
\nReturns a date object containing the next valid day after the date\nprovided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
Returns a date object containing the previous valid day. This function\ncan also return None or raise an Http404\nexception, depending on the values of\nallow_empty and\nallow_future.
WeekMixinLink to this heading#A mixin that can be used to retrieve and provide parsing information for a\nweek component of a date.
\nMethods and Attributes
\nThe strftime() format to use when parsing the week. By\ndefault, this is '%U', which means the week starts on Sunday. Set\nit to '%W' if your week starts on Monday.
Optional The value for the week, as a string. By default, set to\nNone, which means the week will be determined using other means.
Returns the strftime() format to use when parsing the\nweek. Returns week_format by default.
Returns the week for which this view will display data, as a string.\nTries the following sources, in order:
\nThe value of the WeekMixin.week attribute.
The value of the week argument captured in the URL pattern
The value of the week GET query argument.
Raises a 404 if no valid week specification can be found.
\nReturns a date object containing the first day of the week after the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
Returns a date object containing the first day of the week before the\ndate provided. This function can also return None or raise an\nHttp404 exception, depending on the values of\nallow_empty and\nallow_future.
DateMixinLink to this heading#A mixin class providing common behavior for all date-based views.
\nMethods and Attributes
\nThe name of the DateField or DateTimeField in the\nQuerySet’s model that the date-based archive should use to\ndetermine the list of objects to display on the page.
When time zone support is enabled and\ndate_field is a DateTimeField, dates are assumed to be in the\ncurrent time zone. Otherwise, the queryset could include objects from\nthe previous or the next day in the end user’s time zone.
A boolean specifying whether to include «future» objects on this page,\nwhere «future» means objects in which the field specified in\ndate_field is greater than the current date/time. By default, this\nis False.
Returns the name of the field that contains the date data that this\nview will operate on. Returns date_field by default.
Determine whether to include «future» objects on this page, where\n«future» means objects in which the field specified in date_field\nis greater than the current date/time. Returns\nallow_future by default.
BaseDateListViewLink to this heading#A base class that provides common behavior for all date-based views. There\nwon’t normally be a reason to instantiate\nBaseDateListView; instantiate one of\nthe subclasses instead.
While this view (and its subclasses) are executing, self.object_list\nwill contain the list of objects that the view is operating upon, and\nself.date_list will contain the list of dates for which data is\navailable.
Mixins
\n\nMethods and Attributes
\nA boolean specifying whether to display the page if no objects are\navailable. If this is True and no objects are available, the view\nwill display an empty page instead of raising a 404.
This is identical to\ndjango.views.generic.list.MultipleObjectMixin.allow_empty,\nexcept for the default value, which is False.
Optional A string defining the aggregation period for\ndate_list. It must be one of 'year' (default), 'month', or\n'day'.
Returns a 3-tuple containing (date_list, object_list,\nextra_context).
date_list is the list of dates for which data is available.\nobject_list is the list of objects. extra_context is a\ndictionary of context data that will be added to any context data\nprovided by the\nMultipleObjectMixin.
Returns a queryset, filtered using the query arguments defined by\nlookup. Enforces any restrictions on the queryset, such as\nallow_empty and allow_future.
Returns the aggregation period for date_list. Returns\ndate_list_period by default.
Returns the list of dates of type date_type for which queryset\ncontains entries. For example, get_date_list(qs, 'year') will\nreturn the list of years for which qs has entries. If\ndate_type isn’t provided, the result of\nget_date_list_period() is used. date_type\nand ordering are simply passed to\nQuerySet.dates().