class documentation

class MultipleObjectMixin(ContextMixin):

Known subclasses: django.views.generic.dates.BaseDateListView, django.views.generic.list.BaseListView

View In Hierarchy

A mixin for views manipulating multiple objects.
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​_ordering Return the field or fields to use for ordering the queryset.
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 allow​_empty Undocumented
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:

Class Variable extra​_context Undocumented
def get_allow_empty(self):
Return True if the view should display empty lists and False if a 404 should be raised instead.
def get_context_data(self, *, object_list=None, **kwargs):
Get the context for this view.
def get_context_object_name(self, object_list):
Get the name of the item to be used in the context.
def get_ordering(self):
Return the field or fields to use for ordering the queryset.
def get_paginate_by(self, queryset):
Get the number of items to paginate by, or None for no pagination.
def get_paginate_orphans(self):
Return the maximum number of orphans extend the last page by when paginating.
def get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs):
Return an instance of the paginator for this view.
def get_queryset(self):

Return the list of items for this view.

The return value must be an iterable and may be an instance of QuerySet in which case QuerySet specific behavior will be enabled.

def paginate_queryset(self, queryset, page_size):
Paginate the queryset, if needed.
allow_empty: bool =

Undocumented

context_object_name =
model =

Undocumented

ordering =

Undocumented

page_kwarg: str =

Undocumented

paginate_orphans: int =

Undocumented

queryset =

Undocumented