Built-in class-based views API

Class-based views API reference. For introductory material, see theClass-based views topic guide.

• Base views
  • View
  • TemplateView
  • RedirectView
• Generic display views
  • DetailView
  • ListView
• Generic editing views
  • FormView
  • CreateView
  • UpdateView
  • DeleteView
• Generic date views
  • ArchiveIndexView
  • YearArchiveView
  • MonthArchiveView
  • WeekArchiveView
  • DayArchiveView
  • TodayArchiveView
  • DateDetailView
• Class-based views mixins
  • Simple mixins
    • ContextMixin
    • TemplateResponseMixin
  • Single object mixins
    • SingleObjectMixin
    • SingleObjectTemplateResponseMixin
  • Multiple object mixins
    • MultipleObjectMixin
    • MultipleObjectTemplateResponseMixin
  • Editing mixins
    • FormMixin
    • ModelFormMixin
    • ProcessFormView
    • DeletionMixin
  • Date-based mixins
    • YearMixin
    • MonthMixin
    • DayMixin
    • WeekMixin
    • DateMixin
    • BaseDateListView
• Class-based generic views - flattened index
  • Simple generic views
    • View
    • TemplateView
    • RedirectView
  • Detail Views
    • DetailView
  • List Views
    • ListView
  • Editing views
    • FormView
    • CreateView
    • UpdateView
    • DeleteView
  • Date-based views
    • ArchiveIndexView
    • YearArchiveView
    • MonthArchiveView
    • WeekArchiveView
    • DayArchiveView
    • TodayArchiveView
    • DateDetailView

Specification

Each request served by a class-based view has an independent state; therefore,it is safe to store state variables on the instance (i.e., self.foo = 3 isa thread-safe operation).

A class-based view is deployed into a URL pattern using theas_view() classmethod:

urlpatterns = [
    path('view/', MyView.as_view(size=42)),
]

Thread safety with view arguments

Arguments passed to a view are shared between every instance of a view.This means that you shouldn’t use a list, dictionary, or any othermutable object as an argument to a view. If you do and the shared objectis modified, the actions of one user visiting your view could have aneffect on subsequent users visiting the same view.

Arguments passed into as_view() willbe assigned onto the instance that is used to service a request. Using theprevious example, this means that every request on MyView is able to useself.size. Arguments must correspond to attributes that already exist onthe class (return True on a hasattr check).

Base vs Generic views

Base class-based views can be thought of as parent views, which can beused by themselves or inherited from. They may not provide all thecapabilities required for projects, in which case there are Mixins whichextend what base views can do.

Django’s generic views are built off of those base views, and were developedas a shortcut for common usage patterns such as displaying the details of anobject. They take certain common idioms and patterns found in viewdevelopment and abstract them so that you can quickly write common views ofdata without having to repeat yourself.

Most generic views require the queryset key, which is a QuerySetinstance; see Making queries for more information about QuerySetobjects.