class documentation

class BaseYearArchiveView(YearMixin, BaseDateListView):

Known subclasses: django.views.generic.YearArchiveView

View In Hierarchy

List of objects published in a given year.
Method get​_dated​_items Return (date_list, items, extra_context) for this request.
Method get​_make​_object​_list Return True if this view should contain the full list of objects in the given year.
Class Variable date​_list​_period Undocumented
Class Variable make​_object​_list Undocumented

Inherited from YearMixin:

Method get​_next​_year Get the next valid year.
Method get​_previous​_year Get the previous valid year.
Method get​_year Return the year for which this view should display data.
Method get​_year​_format Get a year format string in strptime syntax to be used to parse the year from url variables.
Class Variable year Undocumented
Class Variable year​_format Undocumented
Method ​_get​_current​_year Return the start date of the current interval.
Method ​_get​_next​_year Return the start date of the next interval.

Inherited from BaseDateListView:

Method get​_date​_list Get a date list by calling queryset.dates/datetimes(), checking along the way for empty lists that aren't allowed.
Method get​_date​_list​_period Get the aggregation period for the list of dates: 'year', 'month', or 'day'.
Method get​_dated​_queryset Get a queryset properly filtered according to allow_future and any extra lookup kwargs.
Class Variable allow​_empty Undocumented
Method get Undocumented
Method get​_ordering Return the field or fields to use for ordering the queryset; use the date field by default.
Instance Variable date​_list Undocumented
Instance Variable object​_list Undocumented

Inherited from MultipleObjectMixin (via BaseDateListView):

Method get​_allow​_empty Return True if the view should display empty lists and False if a 404 should be raised instead.
Method get​_context​_data Get the context for this view.
Method get​_context​_object​_name Get the name of the item to be used in the context.
Method get​_paginate​_by Get the number of items to paginate by, or None for no pagination.
Method get​_paginate​_orphans Return the maximum number of orphans extend the last page by when paginating.
Method get​_paginator Return an instance of the paginator for this view.
Method get​_queryset Return the list of items for this view.
Method paginate​_queryset Paginate the queryset, if needed.
Class Variable context​_object​_name Undocumented
Class Variable model Undocumented
Class Variable ordering Undocumented
Class Variable page​_kwarg Undocumented
Class Variable paginate​_by Undocumented
Class Variable paginate​_orphans Undocumented
Class Variable queryset Undocumented

Inherited from ContextMixin (via BaseDateListView, MultipleObjectMixin):

Class Variable extra​_context Undocumented

Inherited from DateMixin (via BaseDateListView):

Method get​_allow​_future Return True if the view should be allowed to display objects from the future.
Method get​_date​_field Get the name of the date field to be used to filter by.
Class Variable allow​_future Undocumented
Class Variable date​_field Undocumented
Method ​_make​_date​_lookup​_arg Convert a date into a datetime when the date field is a DateTimeField.
Method ​_make​_single​_date​_lookup Get the lookup kwargs for filtering on a single date.
Property uses​_datetime​_field Return True if the date field is a DateTimeField and False if it's a DateField.
def get_dated_items(self):
Return (date_list, items, extra_context) for this request.
def get_make_object_list(self):
Return True if this view should contain the full list of objects in the given year.
date_list_period: str =
make_object_list: bool =

Undocumented