flattened-index.txt 35 KB

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