mirror of
https://github.com/django/django.git
synced 2024-11-18 07:26:04 +00:00
148 lines
5.0 KiB
Plaintext
148 lines
5.0 KiB
Plaintext
=====================
|
|
Generic display views
|
|
=====================
|
|
|
|
The two following generic class-based views are designed to display data. On
|
|
many projects they are typically the most commonly used views.
|
|
|
|
DetailView
|
|
----------
|
|
|
|
.. class:: django.views.generic.detail.DetailView
|
|
|
|
While this view is executing, ``self.object`` will contain the object that
|
|
the view is operating upon.
|
|
|
|
**Ancestors (MRO)**
|
|
|
|
This view inherits methods and attributes from the following views:
|
|
|
|
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
|
|
* :class:`django.views.generic.base.TemplateResponseMixin`
|
|
* ``django.views.generic.detail.BaseDetailView``
|
|
* :class:`django.views.generic.detail.SingleObjectMixin`
|
|
* :class:`django.views.generic.base.View`
|
|
|
|
**Method Flowchart**
|
|
|
|
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**::
|
|
|
|
from django.views.generic.detail import DetailView
|
|
from django.utils import timezone
|
|
|
|
from articles.models import Article
|
|
|
|
class ArticleDetailView(DetailView):
|
|
|
|
model = Article
|
|
|
|
def get_context_data(self, **kwargs):
|
|
context = super(ArticleDetailView, self).get_context_data(**kwargs)
|
|
context['now'] = timezone.now()
|
|
return context
|
|
|
|
**Example urls.py**::
|
|
|
|
from django.conf.urls import patterns, url
|
|
|
|
from article.views import ArticleDetailView
|
|
|
|
urlpatterns = patterns('',
|
|
url(r'^(?P<slug>[-_\w]+)/$', ArticleDetailView.as_view(), name='article-detail'),
|
|
)
|
|
|
|
ListView
|
|
--------
|
|
|
|
.. class:: django.views.generic.list.ListView
|
|
|
|
A page representing a list of objects.
|
|
|
|
While this view is executing, ``self.object_list`` will contain the list of
|
|
objects (usually, but not necessarily a queryset) that the view is
|
|
operating upon.
|
|
|
|
**Ancestors (MRO)**
|
|
|
|
This view inherits methods and attributes from the following views:
|
|
|
|
* :class:`django.views.generic.list.ListView`
|
|
* :class:`django.views.generic.list.MultipleObjectTemplateResponseMixin`
|
|
* :class:`django.views.generic.base.TemplateResponseMixin`
|
|
* :class:`django.views.generic.list.BaseListView`
|
|
* :class:`django.views.generic.list.MultipleObjectMixin`
|
|
* :class:`django.views.generic.base.View`
|
|
|
|
**Method Flowchart**
|
|
|
|
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**::
|
|
|
|
from django.views.generic.list import ListView
|
|
from django.utils import timezone
|
|
|
|
from articles.models import Article
|
|
|
|
class ArticleListView(ListView):
|
|
|
|
model = Article
|
|
|
|
def get_context_data(self, **kwargs):
|
|
context = super(ArticleListView, self).get_context_data(**kwargs)
|
|
context['now'] = timezone.now()
|
|
return context
|
|
|
|
**Example urls.py**::
|
|
|
|
from django.conf.urls import patterns, url
|
|
|
|
from article.views import ArticleListView
|
|
|
|
urlpatterns = patterns('',
|
|
url(r'^$', ArticleListView.as_view(), name='article-list'),
|
|
)
|
|
|
|
.. class:: django.views.generic.list.BaseListView
|
|
|
|
A base view for displaying a list of objects. It is not intended to be used
|
|
directly, but rather as a parent class of the
|
|
:class:`django.views.generic.list.ListView` or other views representing
|
|
lists of objects.
|
|
|
|
**Ancestors (MRO)**
|
|
|
|
This view inherits methods and attributes from the following views:
|
|
|
|
* :class:`django.views.generic.list.MultipleObjectMixin`
|
|
* :class:`django.views.generic.base.View`
|
|
|
|
**Methods**
|
|
|
|
.. method:: get(request, *args, **kwargs)
|
|
|
|
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
|
|
False then raise a 404 error.
|