flattened-index.txt 39 KB

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