class documentation

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): (source)

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): (source)

Get the context for this view.

def get_context_object_name(self, object_list): (source)

Get the name of the item to be used in the context.

def get_ordering(self): (source)

Return the field or fields to use for ordering the queryset.

def get_paginate_by(self, queryset): (source)

Get the number of items to paginate by, or ``None`` for no pagination.

def get_paginate_orphans(self): (source)

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): (source)

Return an instance of the paginator for this view.

def get_queryset(self): (source)

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): (source)

Paginate the queryset, if needed.

context_object_name = (source)

Undocumented

ordering = (source)

Undocumented

page_kwarg: str = (source)

Undocumented

paginate_orphans: int = (source)

Undocumented

queryset = (source)

Undocumented