mirror of
https://github.com/django/django.git
synced 2025-10-24 06:06:09 +00:00
Fixed #19516 - Fixed remaining broken links.
Added -n to sphinx builds to catch issues going forward.
This commit is contained in:
@@ -49,9 +49,13 @@ View
|
||||
|
||||
**Attributes**
|
||||
|
||||
.. attribute:: http_method_names = ['get', 'post', 'put', 'delete', 'head', 'options', 'trace']
|
||||
.. attribute:: http_method_names
|
||||
|
||||
The default list of HTTP method names that this view will accept.
|
||||
The list of HTTP method names that this view will accept.
|
||||
|
||||
Default::
|
||||
|
||||
['get', 'post', 'put', 'delete', 'head', 'options', 'trace']
|
||||
|
||||
**Methods**
|
||||
|
||||
@@ -68,12 +72,11 @@ View
|
||||
|
||||
The default implementation will inspect the HTTP method and attempt to
|
||||
delegate to a method that matches the HTTP method; a ``GET`` will be
|
||||
delegated to :meth:`~View.get()`, a ``POST`` to :meth:`~View.post()`,
|
||||
and so on.
|
||||
delegated to ``get()``, a ``POST`` to ``post()``, and so on.
|
||||
|
||||
By default, a ``HEAD`` request will be delegated to :meth:`~View.get()`.
|
||||
By default, a ``HEAD`` request will be delegated to ``get()``.
|
||||
If you need to handle ``HEAD`` requests in a different way than ``GET``,
|
||||
you can override the :meth:`~View.head()` method. See
|
||||
you can override the ``head()`` method. See
|
||||
:ref:`supporting-other-http-methods` for an example.
|
||||
|
||||
The default implementation also sets ``request``, ``args`` and
|
||||
@@ -111,9 +114,9 @@ TemplateView
|
||||
|
||||
**Method Flowchart**
|
||||
|
||||
1. :meth:`dispatch()`
|
||||
2. :meth:`http_method_not_allowed()`
|
||||
3. :meth:`get_context_data()`
|
||||
1. :meth:`~django.views.generic.base.View.dispatch()`
|
||||
2. :meth:`~django.views.generic.base.View.http_method_not_allowed()`
|
||||
3. :meth:`~django.views.generic.base.ContextMixin.get_context_data()`
|
||||
|
||||
**Example views.py**::
|
||||
|
||||
@@ -169,8 +172,8 @@ RedirectView
|
||||
|
||||
**Method Flowchart**
|
||||
|
||||
1. :meth:`dispatch()`
|
||||
2. :meth:`http_method_not_allowed()`
|
||||
1. :meth:`~django.views.generic.base.View.dispatch()`
|
||||
2. :meth:`~django.views.generic.base.View.http_method_not_allowed()`
|
||||
3. :meth:`get_redirect_url()`
|
||||
|
||||
**Example views.py**::
|
||||
@@ -230,9 +233,8 @@ RedirectView
|
||||
|
||||
Constructs the target URL for redirection.
|
||||
|
||||
The default implementation uses :attr:`~RedirectView.url` as a starting
|
||||
The default implementation uses :attr:`url` as a starting
|
||||
string, performs expansion of ``%`` parameters in that string, as well
|
||||
as the appending of query string if requested by
|
||||
:attr:`~RedirectView.query_string`. Subclasses may implement any
|
||||
behavior they wish, as long as the method returns a redirect-ready URL
|
||||
string.
|
||||
as the appending of query string if requested by :attr:`query_string`.
|
||||
Subclasses may implement any behavior they wish, as long as the method
|
||||
returns a redirect-ready URL string.
|
||||
|
||||
@@ -23,7 +23,7 @@ View
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
|
||||
TemplateView
|
||||
@@ -40,9 +40,9 @@ TemplateView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.base.TemplateView.get`
|
||||
* :meth:`~django.views.generic.base.TemplateView.get_context_data`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.base.ContextMixin.get_context_data`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
@@ -60,15 +60,15 @@ RedirectView
|
||||
**Methods**
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.RedirectView.delete`
|
||||
* ``delete()``
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.base.RedirectView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.base.RedirectView.get_redirect_url`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.base.RedirectView.options`
|
||||
* :meth:`~django.views.generic.base.RedirectView.post`
|
||||
* :meth:`~django.views.generic.base.RedirectView.put`
|
||||
* ``options()``
|
||||
* ``post()``
|
||||
* ``put()``
|
||||
|
||||
Detail Views
|
||||
------------
|
||||
@@ -95,10 +95,10 @@ DetailView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.detail.BaseDetailView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
@@ -130,7 +130,7 @@ ListView
|
||||
* :meth:`~django.views.generic.list.BaseListView.get`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -161,10 +161,10 @@ FormView
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form`
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form_kwargs`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.post`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.put`
|
||||
* ``post()``
|
||||
* ``put()``
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
CreateView
|
||||
@@ -199,10 +199,10 @@ CreateView
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form`
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form_kwargs`
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.post`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.put`
|
||||
* ``put()``
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
UpdateView
|
||||
@@ -237,10 +237,10 @@ UpdateView
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form`
|
||||
* :meth:`~django.views.generic.edit.FormMixin.get_form_kwargs`
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.post`
|
||||
* :meth:`~django.views.generic.edit.ProcessFormView.put`
|
||||
* ``put()``
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
DeleteView
|
||||
@@ -265,14 +265,14 @@ DeleteView
|
||||
**Methods**
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.edit.DeletionMixin.delete`
|
||||
* ``delete()``
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.detail.BaseDetailView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.edit.DeletionMixin.post`
|
||||
* ``post()``
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
Date-based views
|
||||
@@ -302,13 +302,13 @@ ArchiveIndexView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -324,7 +324,7 @@ YearArchiveView
|
||||
* :attr:`~django.views.generic.list.MultipleObjectMixin.context_object_name` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name`]
|
||||
* :attr:`~django.views.generic.dates.DateMixin.date_field` [:meth:`~django.views.generic.dates.DateMixin.get_date_field`]
|
||||
* :attr:`~django.views.generic.base.View.http_method_names`
|
||||
* :attr:`~django.views.generic.dates.BaseYearArchiveView.make_object_list` [:meth:`~django.views.generic.dates.BaseYearArchiveView.get_make_object_list`]
|
||||
* :attr:`~django.views.generic.dates.YearArchiveView.make_object_list` [:meth:`~django.views.generic.dates.YearArchiveView.get_make_object_list`]
|
||||
* :attr:`~django.views.generic.list.MultipleObjectMixin.model`
|
||||
* :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_by` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_by`]
|
||||
* :attr:`~django.views.generic.list.MultipleObjectMixin.paginate_orphans` [:meth:`~django.views.generic.list.MultipleObjectMixin.get_paginate_orphans`]
|
||||
@@ -340,13 +340,13 @@ YearArchiveView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -379,7 +379,7 @@ MonthArchiveView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
@@ -387,7 +387,7 @@ MonthArchiveView
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -420,13 +420,13 @@ WeekArchiveView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_queryset`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -461,7 +461,7 @@ DayArchiveView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
@@ -471,7 +471,7 @@ DayArchiveView
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -506,7 +506,7 @@ TodayArchiveView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_date_list`
|
||||
* :meth:`~django.views.generic.dates.BaseDateListView.get_dated_items`
|
||||
@@ -516,7 +516,7 @@ TodayArchiveView
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.get_paginator`
|
||||
* :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.list.MultipleObjectMixin.paginate_queryset`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
@@ -551,13 +551,13 @@ DateDetailView
|
||||
|
||||
* :meth:`~django.views.generic.base.View.as_view`
|
||||
* :meth:`~django.views.generic.base.View.dispatch`
|
||||
* :meth:`~django.views.generic.detail.BaseDetailView.get`
|
||||
* ``get()``
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data`
|
||||
* :meth:`~django.views.generic.dates.DayMixin.get_next_day`
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_next_month`
|
||||
* :meth:`~django.views.generic.detail.SingleObjectMixin.get_object`
|
||||
* :meth:`~django.views.generic.dates.DayMixin.get_previous_day`
|
||||
* :meth:`~django.views.generic.dates.MonthMixin.get_previous_month`
|
||||
* :meth:`~django.views.generic.base.View.head`
|
||||
* ``head()``
|
||||
* :meth:`~django.views.generic.base.View.http_method_not_allowed`
|
||||
* :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response`
|
||||
|
||||
@@ -580,7 +580,7 @@ DateDetailView
|
||||
* :class:`django.views.generic.dates.MonthMixin`
|
||||
* :class:`django.views.generic.dates.DayMixin`
|
||||
* :class:`django.views.generic.dates.DateMixin`
|
||||
* :class:`django.views.generic.detail.BaseDetailView`
|
||||
* ``django.views.generic.detail.BaseDetailView``
|
||||
* :class:`django.views.generic.detail.SingleObjectMixin`
|
||||
* :class:`django.views.generic.base.View`
|
||||
|
||||
|
||||
@@ -19,22 +19,22 @@ DetailView
|
||||
|
||||
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
|
||||
* :class:`django.views.generic.base.TemplateResponseMixin`
|
||||
* :class:`django.views.generic.detail.BaseDetailView`
|
||||
* ``django.views.generic.detail.BaseDetailView``
|
||||
* :class:`django.views.generic.detail.SingleObjectMixin`
|
||||
* :class:`django.views.generic.base.View`
|
||||
|
||||
**Method Flowchart**
|
||||
|
||||
1. :meth:`dispatch()`
|
||||
2. :meth:`http_method_not_allowed()`
|
||||
3. :meth:`get_template_names()`
|
||||
4. :meth:`get_slug_field()`
|
||||
5. :meth:`get_queryset()`
|
||||
6. :meth:`get_object()`
|
||||
7. :meth:`get_context_object_name()`
|
||||
8. :meth:`get_context_data()`
|
||||
9. :meth:`get()`
|
||||
10. :meth:`render_to_response()`
|
||||
1. :meth:`~django.views.generic.base.View.dispatch()`
|
||||
2. :meth:`~django.views.generic.base.View.http_method_not_allowed()`
|
||||
3. :meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names()`
|
||||
4. :meth:`~django.views.generic.detail.SingleObjectMixin.get_slug_field()`
|
||||
5. :meth:`~django.views.generic.detail.SingleObjectMixin.get_queryset()`
|
||||
6. :meth:`~django.views.generic.detail.SingleObjectMixin.get_object()`
|
||||
7. :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_object_name()`
|
||||
8. :meth:`~django.views.generic.detail.SingleObjectMixin.get_context_data()`
|
||||
9. ``get()``
|
||||
10. :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response()`
|
||||
|
||||
**Example views.py**::
|
||||
|
||||
@@ -86,14 +86,14 @@ ListView
|
||||
|
||||
**Method Flowchart**
|
||||
|
||||
1. :meth:`dispatch()`
|
||||
2. :meth:`http_method_not_allowed()`
|
||||
3. :meth:`get_template_names()`
|
||||
4. :meth:`get_queryset()`
|
||||
5. :meth:`get_objects()`
|
||||
6. :meth:`get_context_data()`
|
||||
7. :meth:`get()`
|
||||
8. :meth:`render_to_response()`
|
||||
1. :meth:`~django.views.generic.base.View.dispatch()`
|
||||
2. :meth:`~django.views.generic.base.View.http_method_not_allowed()`
|
||||
3. :meth:`~django.views.generic.base.TemplateResponseMixin.get_template_names()`
|
||||
4. :meth:`~django.views.generic.list.MultipleObjectMixin.get_queryset()`
|
||||
5. :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_object_name()`
|
||||
6. :meth:`~django.views.generic.list.MultipleObjectMixin.get_context_data()`
|
||||
7. ``get()``
|
||||
8. :meth:`~django.views.generic.base.TemplateResponseMixin.render_to_response()`
|
||||
|
||||
|
||||
**Example views.py**::
|
||||
@@ -140,7 +140,7 @@ ListView
|
||||
|
||||
.. method:: get(request, *args, **kwargs)
|
||||
|
||||
Adds :attr:`object_list` to the context. If
|
||||
Adds ``object_list`` to the context. If
|
||||
:attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty`
|
||||
is True then display an empty list. If
|
||||
:attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` is
|
||||
|
||||
@@ -38,7 +38,7 @@ FormView
|
||||
|
||||
* :class:`django.views.generic.edit.FormView`
|
||||
* :class:`django.views.generic.base.TemplateResponseMixin`
|
||||
* :class:`django.views.generic.edit.BaseFormView`
|
||||
* ``django.views.generic.edit.BaseFormView``
|
||||
* :class:`django.views.generic.edit.FormMixin`
|
||||
* :class:`django.views.generic.edit.ProcessFormView`
|
||||
* :class:`django.views.generic.base.View`
|
||||
@@ -86,7 +86,7 @@ CreateView
|
||||
* :class:`django.views.generic.edit.CreateView`
|
||||
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
|
||||
* :class:`django.views.generic.base.TemplateResponseMixin`
|
||||
* :class:`django.views.generic.edit.BaseCreateView`
|
||||
* ``django.views.generic.edit.BaseCreateView``
|
||||
* :class:`django.views.generic.edit.ModelFormMixin`
|
||||
* :class:`django.views.generic.edit.FormMixin`
|
||||
* :class:`django.views.generic.detail.SingleObjectMixin`
|
||||
@@ -128,7 +128,7 @@ UpdateView
|
||||
* :class:`django.views.generic.edit.UpdateView`
|
||||
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
|
||||
* :class:`django.views.generic.base.TemplateResponseMixin`
|
||||
* :class:`django.views.generic.edit.BaseUpdateView`
|
||||
* ``django.views.generic.edit.BaseUpdateView``
|
||||
* :class:`django.views.generic.edit.ModelFormMixin`
|
||||
* :class:`django.views.generic.edit.FormMixin`
|
||||
* :class:`django.views.generic.detail.SingleObjectMixin`
|
||||
@@ -170,9 +170,9 @@ DeleteView
|
||||
* :class:`django.views.generic.edit.DeleteView`
|
||||
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
|
||||
* :class:`django.views.generic.base.TemplateResponseMixin`
|
||||
* :class:`django.views.generic.edit.BaseDeleteView`
|
||||
* ``django.views.generic.edit.BaseDeleteView``
|
||||
* :class:`django.views.generic.edit.DeletionMixin`
|
||||
* :class:`django.views.generic.detail.BaseDetailView`
|
||||
* ``django.views.generic.detail.BaseDetailView``
|
||||
* :class:`django.views.generic.detail.SingleObjectMixin`
|
||||
* :class:`django.views.generic.base.View`
|
||||
|
||||
|
||||
@@ -100,7 +100,7 @@ MonthMixin
|
||||
:attr:`~BaseDateListView.allow_empty` and
|
||||
:attr:`~DateMixin.allow_future`.
|
||||
|
||||
.. method:: get_prev_month(date)
|
||||
.. method:: get_previous_month(date)
|
||||
|
||||
Returns a date object containing the first day of the month before the
|
||||
date provided. This function can also return ``None`` or raise an
|
||||
@@ -152,7 +152,7 @@ DayMixin
|
||||
:attr:`~BaseDateListView.allow_empty` and
|
||||
:attr:`~DateMixin.allow_future`.
|
||||
|
||||
.. method:: get_prev_day(date)
|
||||
.. method:: get_previous_day(date)
|
||||
|
||||
Returns a date object containing the previous valid day. This function
|
||||
can also return ``None`` or raise an :class:`~django.http.Http404`
|
||||
@@ -287,8 +287,9 @@ BaseDateListView
|
||||
available. If this is ``True`` and no objects are available, the view
|
||||
will display an empty page instead of raising a 404.
|
||||
|
||||
This is identical to :attr:`MultipleObjectMixin.allow_empty`, except
|
||||
for the default value, which is ``False``.
|
||||
This is identical to
|
||||
:attr:`django.views.generic.list.MultipleObjectMixin.allow_empty`,
|
||||
except for the default value, which is ``False``.
|
||||
|
||||
.. attribute:: date_list_period
|
||||
|
||||
|
||||
@@ -83,9 +83,8 @@ FormMixin
|
||||
|
||||
.. note::
|
||||
|
||||
Views mixing :class:`FormMixin` must provide an implementation of
|
||||
:meth:`~django.views.generic.FormMixin.form_valid` and
|
||||
:meth:`~django.views.generic.FormMixin.form_invalid`.
|
||||
Views mixing ``FormMixin`` must provide an implementation of
|
||||
:meth:`form_valid` and :meth:`form_invalid`.
|
||||
|
||||
|
||||
ModelFormMixin
|
||||
@@ -93,15 +92,16 @@ ModelFormMixin
|
||||
|
||||
.. class:: django.views.generic.edit.ModelFormMixin
|
||||
|
||||
A form mixin that works on ModelForms, rather than a standalone form.
|
||||
A form mixin that works on ``ModelForms``, rather than a standalone form.
|
||||
|
||||
Since this is a subclass of
|
||||
:class:`~django.views.generic.detail.SingleObjectMixin`, instances of this
|
||||
mixin have access to the :attr:`~SingleObjectMixin.model` and
|
||||
:attr:`~SingleObjectMixin.queryset` attributes, describing the type of
|
||||
object that the ModelForm is manipulating. The view also provides
|
||||
``self.object``, the instance being manipulated. If the instance is being
|
||||
created, ``self.object`` will be ``None``.
|
||||
mixin have access to the
|
||||
:attr:`~django.views.generic.detail.SingleObjectMixin.model` and
|
||||
:attr:`~django.views.generic.detail.SingleObjectMixin.queryset` attributes,
|
||||
describing the type of object that the ``ModelForm`` is manipulating. The
|
||||
view also provides ``self.object``, the instance being manipulated. If the
|
||||
instance is being created, ``self.object`` will be ``None``.
|
||||
|
||||
**Mixins**
|
||||
|
||||
@@ -110,6 +110,12 @@ ModelFormMixin
|
||||
|
||||
**Methods and Attributes**
|
||||
|
||||
.. attribute:: model
|
||||
|
||||
A model class. Can be explicitly provided, otherwise will be determined
|
||||
by examining ``self.object`` or
|
||||
:attr:`~django.views.generic.detail.SingleObjectMixin.queryset`.
|
||||
|
||||
.. attribute:: success_url
|
||||
|
||||
The URL to redirect to when the form is successfully processed.
|
||||
@@ -122,22 +128,25 @@ ModelFormMixin
|
||||
.. method:: get_form_class()
|
||||
|
||||
Retrieve the form class to instantiate. If
|
||||
:attr:`FormMixin.form_class` is provided, that class will be used.
|
||||
Otherwise, a ModelForm will be instantiated using the model associated
|
||||
with the :attr:`~SingleObjectMixin.queryset`, or with the
|
||||
:attr:`~SingleObjectMixin.model`, depending on which attribute is
|
||||
provided.
|
||||
:attr:`~django.views.generic.edit.FormMixin.form_class` is provided,
|
||||
that class will be used. Otherwise, a ``ModelForm`` will be
|
||||
instantiated using the model associated with the
|
||||
:attr:`~django.views.generic.detail.SingleObjectMixin.queryset`, or
|
||||
with the :attr:`~django.views.generic.detail.SingleObjectMixin.model`,
|
||||
depending on which attribute is provided.
|
||||
|
||||
.. method:: get_form_kwargs()
|
||||
|
||||
Add the current instance (``self.object``) to the standard
|
||||
:meth:`FormMixin.get_form_kwargs`.
|
||||
:meth:`~django.views.generic.edit.FormMixin.get_form_kwargs`.
|
||||
|
||||
.. method:: get_success_url()
|
||||
|
||||
Determine the URL to redirect to when the form is successfully
|
||||
validated. Returns :attr:`ModelFormMixin.success_url` if it is provided;
|
||||
otherwise, attempts to use the ``get_absolute_url()`` of the object.
|
||||
validated. Returns
|
||||
:attr:`django.views.generic.edit.ModelFormMixin.success_url` if it is
|
||||
provided; otherwise, attempts to use the ``get_absolute_url()`` of the
|
||||
object.
|
||||
|
||||
.. method:: form_valid(form)
|
||||
|
||||
|
||||
@@ -61,14 +61,13 @@ MultipleObjectMixin
|
||||
.. attribute:: queryset
|
||||
|
||||
A ``QuerySet`` that represents the objects. If provided, the value of
|
||||
:attr:`MultipleObjectMixin.queryset` supersedes the value provided for
|
||||
:attr:`MultipleObjectMixin.model`.
|
||||
``queryset`` supersedes the value provided for :attr:`model`.
|
||||
|
||||
.. attribute:: paginate_by
|
||||
|
||||
An integer specifying how many objects should be displayed per page. If
|
||||
this is given, the view will paginate objects with
|
||||
:attr:`MultipleObjectMixin.paginate_by` objects per page. The view will
|
||||
``paginate_by`` objects per page. The view will
|
||||
expect either a ``page`` query string parameter (via ``request.GET``)
|
||||
or a ``page`` variable specified in the URLconf.
|
||||
|
||||
@@ -77,10 +76,9 @@ MultipleObjectMixin
|
||||
.. versionadded:: 1.6
|
||||
|
||||
An integer specifying the number of "overflow" objects the last page
|
||||
can contain. This extends the :attr:`MultipleObjectMixin.paginate_by`
|
||||
limit on the last page by up to
|
||||
:attr:`MultipleObjectMixin.paginate_orphans`, in order to keep the last
|
||||
page from having a very small number of objects.
|
||||
can contain. This extends the :attr:`paginate_by` limit on the last
|
||||
page by up to ``paginate_orphans``, in order to keep the last page from
|
||||
having a very small number of objects.
|
||||
|
||||
.. attribute:: page_kwarg
|
||||
|
||||
@@ -97,7 +95,7 @@ MultipleObjectMixin
|
||||
:class:`django.core.paginator.Paginator` is used. If the custom paginator
|
||||
class doesn't have the same constructor interface as
|
||||
:class:`django.core.paginator.Paginator`, you will also need to
|
||||
provide an implementation for :meth:`MultipleObjectMixin.get_paginator`.
|
||||
provide an implementation for :meth:`get_paginator`.
|
||||
|
||||
.. attribute:: context_object_name
|
||||
|
||||
@@ -122,20 +120,20 @@ MultipleObjectMixin
|
||||
|
||||
Returns the number of items to paginate by, or ``None`` for no
|
||||
pagination. By default this simply returns the value of
|
||||
:attr:`MultipleObjectMixin.paginate_by`.
|
||||
:attr:`paginate_by`.
|
||||
|
||||
.. method:: get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True)
|
||||
|
||||
Returns an instance of the paginator to use for this view. By default,
|
||||
instantiates an instance of :attr:`paginator_class`.
|
||||
|
||||
.. method:: get_paginate_by()
|
||||
.. method:: get_paginate_orphans()
|
||||
|
||||
.. versionadded:: 1.6
|
||||
|
||||
An integer specifying the number of "overflow" objects the last page
|
||||
can contain. By default this simply returns the value of
|
||||
:attr:`MultipleObjectMixin.paginate_orphans`.
|
||||
:attr:`paginate_orphans`.
|
||||
|
||||
.. method:: get_allow_empty()
|
||||
|
||||
@@ -149,7 +147,7 @@ MultipleObjectMixin
|
||||
Return the context variable name that will be used to contain
|
||||
the list of data that this view is manipulating. If
|
||||
``object_list`` is a queryset of Django objects and
|
||||
:attr:`~MultipleObjectMixin.context_object_name` is not set,
|
||||
:attr:`context_object_name` is not set,
|
||||
the context name will be the ``object_name`` of the model that
|
||||
the queryset is composed from, with postfix ``'_list'``
|
||||
appended. For example, the model ``Article`` would have a
|
||||
|
||||
@@ -48,7 +48,7 @@ TemplateResponseMixin
|
||||
.. attribute:: template_name
|
||||
|
||||
The full name of a template to use as defined by a string. Not defining
|
||||
a template_name will raise a
|
||||
a ``template_name`` will raise a
|
||||
:class:`django.core.exceptions.ImproperlyConfigured` exception.
|
||||
|
||||
.. attribute:: response_class
|
||||
@@ -73,15 +73,13 @@ TemplateResponseMixin
|
||||
If any keyword arguments are provided, they will be passed to the
|
||||
constructor of the response class.
|
||||
|
||||
Calls :meth:`~TemplateResponseMixin.get_template_names()` to obtain the
|
||||
list of template names that will be searched looking for an existent
|
||||
template.
|
||||
Calls :meth:`get_template_names()` to obtain the list of template names
|
||||
that will be searched looking for an existent template.
|
||||
|
||||
.. method:: get_template_names()
|
||||
|
||||
Returns a list of template names to search for when rendering the
|
||||
template.
|
||||
|
||||
If :attr:`TemplateResponseMixin.template_name` is specified, the
|
||||
default implementation will return a list containing
|
||||
:attr:`TemplateResponseMixin.template_name` (if it is specified).
|
||||
If :attr:`template_name` is specified, the default implementation will
|
||||
return a list containing :attr:`template_name` (if it is specified).
|
||||
|
||||
@@ -21,8 +21,7 @@ SingleObjectMixin
|
||||
.. attribute:: queryset
|
||||
|
||||
A ``QuerySet`` that represents the objects. If provided, the value of
|
||||
:attr:`SingleObjectMixin.queryset` supersedes the value provided for
|
||||
:attr:`SingleObjectMixin.model`.
|
||||
``queryset`` supersedes the value provided for :attr:`model`.
|
||||
|
||||
.. attribute:: slug_field
|
||||
|
||||
@@ -47,38 +46,38 @@ SingleObjectMixin
|
||||
|
||||
Returns the single object that this view will display. If
|
||||
``queryset`` is provided, that queryset will be used as the
|
||||
source of objects; otherwise,
|
||||
:meth:`~SingleObjectMixin.get_queryset` will be used.
|
||||
``get_object()`` looks for a
|
||||
:attr:`SingleObjectMixin.pk_url_kwarg` argument in the arguments
|
||||
to the view; if this argument is found, this method performs a
|
||||
primary-key based lookup using that value. If this argument is not
|
||||
found, it looks for a :attr:`SingleObjectMixin.slug_url_kwarg`
|
||||
argument, and performs a slug lookup using the
|
||||
:attr:`SingleObjectMixin.slug_field`.
|
||||
source of objects; otherwise, :meth:`get_queryset` will be used.
|
||||
``get_object()`` looks for a :attr:`pk_url_kwarg` argument in the
|
||||
arguments to the view; if this argument is found, this method performs
|
||||
a primary-key based lookup using that value. If this argument is not
|
||||
found, it looks for a :attr:`slug_url_kwarg` argument, and performs a
|
||||
slug lookup using the :attr:`slug_field`.
|
||||
|
||||
.. method:: get_queryset()
|
||||
|
||||
Returns the queryset that will be used to retrieve the object that
|
||||
this view will display. By default,
|
||||
:meth:`~SingleObjectMixin.get_queryset` returns the value of the
|
||||
:attr:`~SingleObjectMixin.queryset` attribute if it is set, otherwise
|
||||
it constructs a :class:`QuerySet` by calling the `all()` method on the
|
||||
:attr:`~SingleObjectMixin.model` attribute's default manager.
|
||||
this view will display. By default, :meth:`get_queryset` returns the
|
||||
value of the :attr:`queryset` attribute if it is set, otherwise
|
||||
it constructs a :class:`~django.db.models.query.QuerySet` by calling
|
||||
the `all()` method on the :attr:`model` attribute's default manager.
|
||||
|
||||
.. method:: get_context_object_name(obj)
|
||||
|
||||
Return the context variable name that will be used to contain the
|
||||
data that this view is manipulating. If
|
||||
:attr:`~SingleObjectMixin.context_object_name` is not set, the context
|
||||
name will be constructed from the ``object_name`` of the model that
|
||||
the queryset is composed from. For example, the model ``Article``
|
||||
would have context object named ``'article'``.
|
||||
data that this view is manipulating. If :attr:`context_object_name` is
|
||||
not set, the context name will be constructed from the ``object_name``
|
||||
of the model that the queryset is composed from. For example, the model
|
||||
``Article`` would have context object named ``'article'``.
|
||||
|
||||
.. method:: get_context_data(**kwargs)
|
||||
|
||||
Returns context data for displaying the list of objects.
|
||||
|
||||
.. method:: get_slug_field()
|
||||
|
||||
Returns the name of a slug field to be used to look up by slug. By
|
||||
default this simply returns the value of :attr:`slug_field`.
|
||||
|
||||
**Context**
|
||||
|
||||
* ``object``: The object that this view is displaying. If
|
||||
|
||||
Reference in New Issue
Block a user