{"title":"Built-in class-based views API","version":"5.0","locale":"en","docname":"ref/class-based-views/index","url":"/en/5.0/ref/class-based-views/","canonical":"https://djangodocs.dev/en/5.0/ref/class-based-views/","summary":"Class-based views API reference. For introductory material, see the Class-based views topic guide.","html":"

Built-in class-based views APILink to this heading#

\n

Class-based views API reference. For introductory material, see the\nClass-based views topic guide.

\n
\n\n
\n
\n

SpecificationLink to this heading#

\n

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

\n

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

\n
Code
urlpatterns = [\n    path("view/", MyView.as_view(size=42)),\n]\n
\n\n

Arguments passed into as_view() will\nbe assigned onto the instance that is used to service a request. Using the\nprevious example, this means that every request on MyView is able to use\nself.size. Arguments must correspond to attributes that already exist on\nthe class (return True on a hasattr check).

\n
\n
\n

Base vs Generic viewsLink to this heading#

\n

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

\n

Django’s generic views are built off of those base views, and were developed\nas a shortcut for common usage patterns such as displaying the details of an\nobject. They take certain common idioms and patterns found in view\ndevelopment and abstract them so that you can quickly write common views of\ndata without having to repeat yourself.

\n

Most generic views require the queryset key, which is a QuerySet\ninstance; see Making queries for more information about QuerySet\nobjects.

\n
","rootId":"built-in-class-based-views-api","toc":[{"title":"Specification","anchor":"specification","children":[]},{"title":"Base vs Generic views","anchor":"base-vs-generic-views","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/en/5.0/ref/"}],"prev":{"docname":"ref/checks","title":"System check framework","url":"/en/5.0/ref/checks/"},"next":{"docname":"ref/class-based-views/base","title":"Base views","url":"/en/5.0/ref/class-based-views/base/"},"formats":{"html":"/en/5.0/ref/class-based-views/","markdown":"/en/5.0/ref/class-based-views.md","json":"/en/5.0/ref/class-based-views.json"},"source":"https://github.com/django/django/blob/stable/5.0.x/docs/ref/class-based-views/index.txt","official":"https://docs.djangoproject.com/en/5.0/ref/class-based-views/","inVersions":["dev","6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9","1.8"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}