MultipleObjectMixinLink to this heading#A mixin that can be used to display a list of objects.
\nIf paginate_by is specified, Django will paginate the results returned\nby this. You can specify the page number in the URL in one of two ways:
Use the page parameter in the URLconf. For example, this is what\nyour URLconf might look like:
path("objects/page<int:page>/", PaginatedView.as_view()),\nPass the page number via the page query-string parameter. For\nexample, a URL would look like this:
/objects/?page=3\nThese values and lists are 1-based, not 0-based, so the first page would be\nrepresented as page 1.
For more on pagination, read the pagination documentation.
\nAs a special case, you are also permitted to use last as a value for\npage:
/objects/?page=last\nThis allows you to access the final page of results without first having to\ndetermine how many pages there are.
\nNote that page must be either a valid page number or the value\nlast; any other value for page will result in a 404 error.
Extends
\n\nMethods and Attributes
\nA boolean specifying whether to display the page if no objects are\navailable. If this is False and no objects are available, the view\nwill raise a 404 instead of displaying an empty page. By default, this\nis True.
The model that this view will display data for. Specifying model\n= Foo is effectively the same as specifying queryset =\nFoo.objects.all(), where objects stands for Foo’s\ndefault manager.
A QuerySet that represents the objects. If provided, the value of\nqueryset supersedes the value provided for model.
A string or list of strings specifying the ordering to apply to the queryset.\nValid values are the same as those for order_by().
An integer specifying how many objects should be displayed per page. If\nthis is given, the view will paginate objects with\npaginate_by objects per page. The view will\nexpect either a page query string parameter (via request.GET)\nor a page variable specified in the URLconf.
An integer specifying the number of “overflow” objects the last page\ncan contain. This extends the paginate_by limit on the last\npage by up to paginate_orphans, in order to keep the last page from\nhaving a very small number of objects.
A string specifying the name to use for the page parameter.\nThe view will expect this parameter to be available either as a query\nstring parameter (via request.GET) or as a kwarg variable specified\nin the URLconf. Defaults to page.
The paginator class to be used for pagination. By default,\ndjango.core.paginator.Paginator is used. If the custom paginator\nclass doesn’t have the same constructor interface as\ndjango.core.paginator.Paginator, you will also need to\nprovide an implementation for get_paginator().
Designates the name of the variable to use in the context.
\nGet the list of items for this view. This must be an iterable and may\nbe a queryset (in which queryset-specific behavior will be enabled).
\nReturns a string (or iterable of strings) that defines the ordering that\nwill be applied to the queryset.
Returns ordering by default.
Returns a 4-tuple containing (paginator, page, object_list,\nis_paginated).
Constructed by paginating queryset into pages of size page_size.\nIf the request contains a page argument, either as a captured URL\nargument or as a GET argument, object_list will correspond to the\nobjects from that page.
Returns the number of items to paginate by, or None for no\npagination. By default this returns the value of paginate_by.
Returns an instance of the paginator to use for this view. By default,\ninstantiates an instance of paginator_class.
An integer specifying the number of “overflow” objects the last page\ncan contain. By default this returns the value of\npaginate_orphans.
Return a boolean specifying whether to display the page if no objects\nare available. If this method returns False and no objects are\navailable, the view will raise a 404 instead of displaying an empty\npage. By default, this is True.
Return the context variable name that will be used to contain\nthe list of data that this view is manipulating. If\nobject_list is a queryset of Django objects and\ncontext_object_name is not set,\nthe context name will be the model_name of the model that\nthe queryset is composed from, with postfix '_list'\nappended. For example, the model Article would have a\ncontext object named article_list.
Returns context data for displaying the list of objects.
\nContext
\nobject_list: The list of objects that this view is displaying. If\ncontext_object_name is specified, that variable will also be set\nin the context, with the same value as object_list.
is_paginated: A boolean representing whether the results are\npaginated. Specifically, this is set to False if no page size has\nbeen specified, or if the available objects do not span multiple\npages.
paginator: An instance of\ndjango.core.paginator.Paginator. If the page is not\npaginated, this context variable will be None.
page_obj: An instance of\ndjango.core.paginator.Page. If the page is not paginated,\nthis context variable will be None.
MultipleObjectTemplateResponseMixinLink to this heading#A mixin class that performs template-based response rendering for views\nthat operate upon a list of object instances. Requires that the view it is\nmixed with provides self.object_list, the list of object instances that\nthe view is operating on. self.object_list may be, but is not required\nto be, a QuerySet.
Extends
\n\nMethods and Attributes
\nThe suffix to append to the auto-generated candidate template name.\nDefault suffix is _list.
Returns a list of candidate template names. Returns the following list:
\nthe value of template_name on the view (if provided)
<app_label>/<model_name><template_name_suffix>.html