flattened-index.txt 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. ===========================================
  2. Class-based generic views - flattened index
  3. ===========================================
  4. This index provides an alternate organization of the reference documentation
  5. for class-based views. For each view, the effective attributes and methods from
  6. the class tree are represented under that view. For the reference
  7. documentation organized by the class which defines the behavior, see
  8. :doc:`Class-based views</ref/class-based-views/index>`.
  9. .. seealso::
  10. `Classy Class-Based Views <https://ccbv.co.uk/>`_ provides a nice interface
  11. to navigate the class hierarchy of the built-in class-based views.
  12. Simple generic views
  13. ====================
  14. ``View``
  15. --------
  16. .. class:: View()
  17. **Attributes** (with optional accessor):
  18. * :attr:`~django.views.generic.base.View.http_method_names`
  19. **Methods**
  20. * :meth:`~django.views.generic.base.View.as_view`
  21. * :meth:`~django.views.generic.base.View.dispatch`
  22. * ``head()``
  23. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  24. ``TemplateView``
  25. ----------------
  26. .. class:: TemplateView()
  27. **Attributes** (with optional accessor):
  28. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  29. * :attr:`~django.views.generic.base.View.http_method_names`
  30. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  31. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  32. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  33. **Methods**
  34. * :meth:`~django.views.generic.base.View.as_view`
  35. * :meth:`~django.views.generic.base.View.dispatch`
  36. * ``get()``
  37. * :meth:`~django.views.generic.base.ContextMixin.get_context_data`
  38. * ``head()``
  39. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  40. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  41. ``RedirectView``
  42. ----------------
  43. .. class:: RedirectView()
  44. **Attributes** (with optional accessor):
  45. * :attr:`~django.views.generic.base.View.http_method_names`
  46. * :attr:`~django.views.generic.base.RedirectView.pattern_name`
  47. * :attr:`~django.views.generic.base.RedirectView.permanent`
  48. * :attr:`~django.views.generic.base.RedirectView.query_string`
  49. * :attr:`~django.views.generic.base.RedirectView.url` [:meth:`~django.views.generic.base.RedirectView.get_redirect_url`]
  50. **Methods**
  51. * :meth:`~django.views.generic.base.View.as_view`
  52. * ``delete()``
  53. * :meth:`~django.views.generic.base.View.dispatch`
  54. * ``get()``
  55. * ``head()``
  56. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  57. * ``options()``
  58. * ``post()``
  59. * ``put()``
  60. Detail Views
  61. ============
  62. ``DetailView``
  63. --------------
  64. .. class:: DetailView()
  65. **Attributes** (with optional accessor):
  66. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  67. * :attr:`~django.views.generic.detail.SingleObjectMixin.context_object_name` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name`]
  68. * :attr:`~django.views.generic.base.View.http_method_names`
  69. * :attr:`~django.views.generic.detail.SingleObjectMixin.model`
  70. * :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
  71. * :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset`]
  72. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  73. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_field` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field`]
  74. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_url_kwarg`
  75. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  76. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  77. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field`
  78. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
  79. **Methods**
  80. * :meth:`~django.views.generic.base.View.as_view`
  81. * :meth:`~django.views.generic.base.View.dispatch`
  82. * ``get()``
  83. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
  84. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
  85. * ``head()``
  86. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  87. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  88. List Views
  89. ==========
  90. ``ListView``
  91. ------------
  92. .. class:: ListView()
  93. **Attributes** (with optional accessor):
  94. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  95. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  96. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  97. * :attr:`~django.views.generic.base.View.http_method_names`
  98. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  99. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  100. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  101. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  102. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  103. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  104. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  105. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  106. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  107. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  108. **Methods**
  109. * :meth:`~django.views.generic.base.View.as_view`
  110. * :meth:`~django.views.generic.base.View.dispatch`
  111. * :meth:`~django.views.generic.list.BaseListView.get`
  112. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  113. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  114. * ``head()``
  115. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  116. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  117. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  118. Editing views
  119. =============
  120. ``FormView``
  121. ------------
  122. .. class:: FormView()
  123. **Attributes** (with optional accessor):
  124. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  125. * :attr:`~django.views.generic.edit.FormMixin.form_class` [:meth:`~django.views.generic.edit.FormMixin.get_form_class`]
  126. * :attr:`~django.views.generic.base.View.http_method_names`
  127. * :attr:`~django.views.generic.edit.FormMixin.initial` [:meth:`~django.views.generic.edit.FormMixin.get_initial`]
  128. * :attr:`~django.views.generic.edit.FormMixin.prefix` [:meth:`~django.views.generic.edit.FormMixin.get_prefix`]
  129. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  130. * :attr:`~django.views.generic.edit.FormMixin.success_url` [:meth:`~django.views.generic.edit.FormMixin.get_success_url`]
  131. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  132. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  133. **Methods**
  134. * :meth:`~django.views.generic.base.View.as_view`
  135. * :meth:`~django.views.generic.base.View.dispatch`
  136. * :meth:`~django.views.generic.edit.FormMixin.form_invalid`
  137. * :meth:`~django.views.generic.edit.FormMixin.form_valid`
  138. * :meth:`~django.views.generic.edit.ProcessFormView.get`
  139. * :meth:`~django.views.generic.edit.FormMixin.get_context_data`
  140. * :meth:`~django.views.generic.edit.FormMixin.get_form`
  141. * :meth:`~django.views.generic.edit.FormMixin.get_form_kwargs`
  142. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  143. * :meth:`~django.views.generic.edit.ProcessFormView.post`
  144. * :meth:`~django.views.generic.edit.ProcessFormView.put`
  145. ``CreateView``
  146. --------------
  147. .. class:: CreateView()
  148. **Attributes** (with optional accessor):
  149. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  150. * :attr:`~django.views.generic.detail.SingleObjectMixin.context_object_name` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name`]
  151. * :attr:`~django.views.generic.edit.ModelFormMixin.fields`
  152. * :attr:`~django.views.generic.edit.FormMixin.form_class` [:meth:`~django.views.generic.edit.ModelFormMixin.get_form_class`]
  153. * :attr:`~django.views.generic.base.View.http_method_names`
  154. * :attr:`~django.views.generic.edit.FormMixin.initial` [:meth:`~django.views.generic.edit.FormMixin.get_initial`]
  155. * :attr:`~django.views.generic.detail.SingleObjectMixin.model`
  156. * :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
  157. * :attr:`~django.views.generic.edit.FormMixin.prefix` [:meth:`~django.views.generic.edit.FormMixin.get_prefix`]
  158. * :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset`]
  159. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  160. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_field` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field`]
  161. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_url_kwarg`
  162. * :attr:`~django.views.generic.edit.FormMixin.success_url` [:meth:`~django.views.generic.edit.ModelFormMixin.get_success_url`]
  163. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  164. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  165. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field`
  166. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
  167. **Methods**
  168. * :meth:`~django.views.generic.base.View.as_view`
  169. * :meth:`~django.views.generic.base.View.dispatch`
  170. * :meth:`~django.views.generic.edit.FormMixin.form_invalid`
  171. * :meth:`~django.views.generic.edit.ModelFormMixin.form_valid`
  172. * :meth:`~django.views.generic.edit.ProcessFormView.get`
  173. * :meth:`~django.views.generic.edit.FormMixin.get_context_data`
  174. * :meth:`~django.views.generic.edit.FormMixin.get_form`
  175. * :meth:`~django.views.generic.edit.ModelFormMixin.get_form_kwargs`
  176. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
  177. * ``head()``
  178. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  179. * :meth:`~django.views.generic.edit.ProcessFormView.post`
  180. * ``put()``
  181. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  182. ``UpdateView``
  183. --------------
  184. .. class:: UpdateView()
  185. **Attributes** (with optional accessor):
  186. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  187. * :attr:`~django.views.generic.detail.SingleObjectMixin.context_object_name` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name`]
  188. * :attr:`~django.views.generic.edit.ModelFormMixin.fields`
  189. * :attr:`~django.views.generic.edit.FormMixin.form_class` [:meth:`~django.views.generic.edit.ModelFormMixin.get_form_class`]
  190. * :attr:`~django.views.generic.base.View.http_method_names`
  191. * :attr:`~django.views.generic.edit.FormMixin.initial` [:meth:`~django.views.generic.edit.FormMixin.get_initial`]
  192. * :attr:`~django.views.generic.detail.SingleObjectMixin.model`
  193. * :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
  194. * :attr:`~django.views.generic.edit.FormMixin.prefix` [:meth:`~django.views.generic.edit.FormMixin.get_prefix`]
  195. * :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset`]
  196. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  197. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_field` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field`]
  198. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_url_kwarg`
  199. * :attr:`~django.views.generic.edit.FormMixin.success_url` [:meth:`~django.views.generic.edit.ModelFormMixin.get_success_url`]
  200. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  201. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  202. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field`
  203. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
  204. **Methods**
  205. * :meth:`~django.views.generic.base.View.as_view`
  206. * :meth:`~django.views.generic.base.View.dispatch`
  207. * :meth:`~django.views.generic.edit.FormMixin.form_invalid`
  208. * :meth:`~django.views.generic.edit.ModelFormMixin.form_valid`
  209. * :meth:`~django.views.generic.edit.ProcessFormView.get`
  210. * :meth:`~django.views.generic.edit.FormMixin.get_context_data`
  211. * :meth:`~django.views.generic.edit.FormMixin.get_form`
  212. * :meth:`~django.views.generic.edit.ModelFormMixin.get_form_kwargs`
  213. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
  214. * ``head()``
  215. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  216. * :meth:`~django.views.generic.edit.ProcessFormView.post`
  217. * ``put()``
  218. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  219. ``DeleteView``
  220. --------------
  221. .. class:: DeleteView()
  222. **Attributes** (with optional accessor):
  223. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  224. * :attr:`~django.views.generic.detail.SingleObjectMixin.context_object_name` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name`]
  225. * :attr:`~django.views.generic.base.View.http_method_names`
  226. * :attr:`~django.views.generic.detail.SingleObjectMixin.model`
  227. * :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
  228. * :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset`]
  229. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  230. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_field` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field`]
  231. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_url_kwarg`
  232. * :attr:`~django.views.generic.edit.DeletionMixin.success_url` [:meth:`~django.views.generic.edit.DeletionMixin.get_success_url`]
  233. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  234. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  235. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field`
  236. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
  237. **Methods**
  238. * :meth:`~django.views.generic.base.View.as_view`
  239. * ``delete()``
  240. * :meth:`~django.views.generic.base.View.dispatch`
  241. * ``get()``
  242. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
  243. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
  244. * ``head()``
  245. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  246. * ``post()``
  247. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  248. Date-based views
  249. ================
  250. ``ArchiveIndexView``
  251. --------------------
  252. .. class:: ArchiveIndexView()
  253. **Attributes** (with optional accessor):
  254. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  255. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  256. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  257. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  258. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  259. * :attr:`~django.views.generic.base.View.http_method_names`
  260. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  261. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  262. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  263. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  264. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  265. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  266. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  267. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  268. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  269. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  270. **Methods**
  271. * :meth:`~django.views.generic.base.View.as_view`
  272. * :meth:`~django.views.generic.base.View.dispatch`
  273. * ``get()``
  274. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  275. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  276. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  277. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  278. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  279. * ``head()``
  280. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  281. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  282. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  283. ``YearArchiveView``
  284. -------------------
  285. .. class:: YearArchiveView()
  286. **Attributes** (with optional accessor):
  287. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  288. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  289. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  290. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  291. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  292. * :attr:`~django.views.generic.base.View.http_method_names`
  293. * :attr:`~django.views.generic.dates.YearArchiveView.make_object_list` [:meth:`~django.views.generic.dates.YearArchiveView.get_make_object_list`]
  294. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  295. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  296. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  297. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  298. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  299. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  300. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  301. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  302. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  303. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  304. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  305. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  306. **Methods**
  307. * :meth:`~django.views.generic.base.View.as_view`
  308. * :meth:`~django.views.generic.base.View.dispatch`
  309. * ``get()``
  310. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  311. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  312. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  313. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  314. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  315. * ``head()``
  316. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  317. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  318. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  319. ``MonthArchiveView``
  320. --------------------
  321. .. class:: MonthArchiveView()
  322. **Attributes** (with optional accessor):
  323. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  324. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  325. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  326. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  327. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  328. * :attr:`~django.views.generic.base.View.http_method_names`
  329. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  330. * :attr:`~django.views.generic.dates.MonthMixin.month` [:meth:`~django.views.generic.dates.MonthMixin.get_month`]
  331. * :attr:`~django.views.generic.dates.MonthMixin.month_format` [:meth:`~django.views.generic.dates.MonthMixin.get_month_format`]
  332. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  333. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  334. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  335. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  336. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  337. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  338. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  339. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  340. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  341. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  342. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  343. **Methods**
  344. * :meth:`~django.views.generic.base.View.as_view`
  345. * :meth:`~django.views.generic.base.View.dispatch`
  346. * ``get()``
  347. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  348. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  349. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  350. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  351. * :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
  352. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  353. * :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
  354. * ``head()``
  355. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  356. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  357. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  358. ``WeekArchiveView``
  359. -------------------
  360. .. class:: WeekArchiveView()
  361. **Attributes** (with optional accessor):
  362. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  363. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  364. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  365. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  366. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  367. * :attr:`~django.views.generic.base.View.http_method_names`
  368. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  369. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  370. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  371. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  372. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  373. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  374. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  375. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  376. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  377. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  378. * :attr:`~django.views.generic.dates.WeekMixin.week` [:meth:`~django.views.generic.dates.WeekMixin.get_week`]
  379. * :attr:`~django.views.generic.dates.WeekMixin.week_format` [:meth:`~django.views.generic.dates.WeekMixin.get_week_format`]
  380. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  381. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  382. **Methods**
  383. * :meth:`~django.views.generic.base.View.as_view`
  384. * :meth:`~django.views.generic.base.View.dispatch`
  385. * ``get()``
  386. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  387. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  388. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  389. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  390. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  391. * ``head()``
  392. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  393. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  394. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  395. ``DayArchiveView``
  396. ------------------
  397. .. class:: DayArchiveView()
  398. **Attributes** (with optional accessor):
  399. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  400. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  401. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  402. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  403. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  404. * :attr:`~django.views.generic.dates.DayMixin.day` [:meth:`~django.views.generic.dates.DayMixin.get_day`]
  405. * :attr:`~django.views.generic.dates.DayMixin.day_format` [:meth:`~django.views.generic.dates.DayMixin.get_day_format`]
  406. * :attr:`~django.views.generic.base.View.http_method_names`
  407. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  408. * :attr:`~django.views.generic.dates.MonthMixin.month` [:meth:`~django.views.generic.dates.MonthMixin.get_month`]
  409. * :attr:`~django.views.generic.dates.MonthMixin.month_format` [:meth:`~django.views.generic.dates.MonthMixin.get_month_format`]
  410. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  411. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  412. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  413. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  414. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  415. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  416. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  417. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  418. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  419. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  420. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  421. **Methods**
  422. * :meth:`~django.views.generic.base.View.as_view`
  423. * :meth:`~django.views.generic.base.View.dispatch`
  424. * ``get()``
  425. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  426. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  427. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  428. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  429. * :meth:`~django.views.generic.dates.DayMixin.get_next_day`
  430. * :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
  431. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  432. * :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
  433. * :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
  434. * ``head()``
  435. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  436. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  437. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  438. ``TodayArchiveView``
  439. --------------------
  440. .. class:: TodayArchiveView()
  441. **Attributes** (with optional accessor):
  442. * :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_allow_empty`]
  443. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  444. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  445. * :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
  446. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  447. * :attr:`~django.views.generic.dates.DayMixin.day` [:meth:`~django.views.generic.dates.DayMixin.get_day`]
  448. * :attr:`~django.views.generic.dates.DayMixin.day_format` [:meth:`~django.views.generic.dates.DayMixin.get_day_format`]
  449. * :attr:`~django.views.generic.base.View.http_method_names`
  450. * :attr:`~django.views.generic.list.MultipleObjectMixin.model`
  451. * :attr:`~django.views.generic.dates.MonthMixin.month` [:meth:`~django.views.generic.dates.MonthMixin.get_month`]
  452. * :attr:`~django.views.generic.dates.MonthMixin.month_format` [:meth:`~django.views.generic.dates.MonthMixin.get_month_format`]
  453. * :attr:`~django.views.generic.list.MultipleObjectMixin.ordering` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_ordering`]
  454. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
  455. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
  456. * :attr:`~django.views.generic.list.MultipleObjectMixin.paginator_class`
  457. * :attr:`~django.views.generic.list.MultipleObjectMixin.queryset` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset`]
  458. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  459. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  460. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  461. * :attr:`~django.views.generic.list.MultipleObjectTemplateResponseMixin.template_name_suffix`
  462. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  463. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  464. **Methods**
  465. * :meth:`~django.views.generic.base.View.as_view`
  466. * :meth:`~django.views.generic.base.View.dispatch`
  467. * ``get()``
  468. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
  469. * :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
  470. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
  471. * :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
  472. * :meth:`~django.views.generic.dates.DayMixin.get_next_day`
  473. * :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
  474. * :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
  475. * :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
  476. * :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
  477. * ``head()``
  478. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  479. * :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
  480. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
  481. ``DateDetailView``
  482. ------------------
  483. .. class:: DateDetailView()
  484. **Attributes** (with optional accessor):
  485. * :attr:`~django.views.generic.dates.DateMixin.allow_future` [:meth:`~django.views.generic.dates.DateMixin.get_allow_future`]
  486. * :attr:`~django.views.generic.base.TemplateResponseMixin.content_type`
  487. * :attr:`~django.views.generic.detail.SingleObjectMixin.context_object_name` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name`]
  488. * :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
  489. * :attr:`~django.views.generic.dates.DayMixin.day` [:meth:`~django.views.generic.dates.DayMixin.get_day`]
  490. * :attr:`~django.views.generic.dates.DayMixin.day_format` [:meth:`~django.views.generic.dates.DayMixin.get_day_format`]
  491. * :attr:`~django.views.generic.base.View.http_method_names`
  492. * :attr:`~django.views.generic.detail.SingleObjectMixin.model`
  493. * :attr:`~django.views.generic.dates.MonthMixin.month` [:meth:`~django.views.generic.dates.MonthMixin.get_month`]
  494. * :attr:`~django.views.generic.dates.MonthMixin.month_format` [:meth:`~django.views.generic.dates.MonthMixin.get_month_format`]
  495. * :attr:`~django.views.generic.detail.SingleObjectMixin.pk_url_kwarg`
  496. * :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset`]
  497. * :attr:`~django.views.generic.base.TemplateResponseMixin.response_class` [:meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`]
  498. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_field` [:meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field`]
  499. * :attr:`~django.views.generic.detail.SingleObjectMixin.slug_url_kwarg`
  500. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_engine`
  501. * :attr:`~django.views.generic.base.TemplateResponseMixin.template_name` [:meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names`]
  502. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_field`
  503. * :attr:`~django.views.generic.detail.SingleObjectTemplateResponseMixin.template_name_suffix`
  504. * :attr:`~django.views.generic.dates.YearMixin.year` [:meth:`~django.views.generic.dates.YearMixin.get_year`]
  505. * :attr:`~django.views.generic.dates.YearMixin.year_format` [:meth:`~django.views.generic.dates.YearMixin.get_year_format`]
  506. **Methods**
  507. * :meth:`~django.views.generic.base.View.as_view`
  508. * :meth:`~django.views.generic.base.View.dispatch`
  509. * ``get()``
  510. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
  511. * :meth:`~django.views.generic.dates.DayMixin.get_next_day`
  512. * :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
  513. * :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
  514. * :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
  515. * :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
  516. * ``head()``
  517. * :meth:`~django.views.generic.base.View.http_method_not_allowed`
  518. * :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`