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:

Method Flowchart

  1. setup()
  2. dispatch()
  3. http_method_not_allowed()
  4. get_template_names()
  5. get_slug_field()
  6. get_queryset()
  7. get_object()
  8. get_context_object_name()
  9. get_context_data()
  10. get()
  11. render_to_response()

Example myapp/views.py:

  1. from django.utils import timezone
  2. from django.views.generic.detail import DetailView
  4. from articles.models import Article
  6. class ArticleDetailView(DetailView):
  8.     model = Article
  10.     def get_context_data(self, **kwargs):
  11.         context = super().get_context_data(**kwargs)
  12.         context['now'] = timezone.now()
  13.         return context

Example myapp/urls.py:

  1. from django.urls import path
  3. from article.views import ArticleDetailView
  5. urlpatterns = [
  6.     path('<slug:slug>/', ArticleDetailView.as_view(), name='article-detail'),
  7. ]

Example myapp/article_detail.html:

  1. <h1>{{ object.headline }}</h1>
  2. <p>{{ object.content }}</p>
  3. <p>Reporter: {{ object.reporter }}</p>
  4. <p>Published: {{ object.pub_date|date }}</p>
  5. <p>Date: {{ now|date }}</p>

class django.views.generic.detail.BaseDetailView

A base view for displaying a single object. It is not intended to be used directly, but rather as a parent class of the django.views.generic.detail.DetailView or other views representing details of a single object.

Ancestors (MRO)

This view inherits methods and attributes from the following views:

Methods

  • get(request, \args, **kwargs*)

    Adds object to the context.

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:

Method Flowchart

  1. setup()
  2. dispatch()
  3. http_method_not_allowed()
  4. get_template_names()
  5. get_queryset()
  6. get_context_object_name()
  7. get_context_data()
  8. get()
  9. render_to_response()

Example views.py:

  1. from django.utils import timezone
  2. from django.views.generic.list import ListView
  4. from articles.models import Article
  6. class ArticleListView(ListView):
  8.     model = Article
  9.     paginate_by = 100  # if pagination is desired
  11.     def get_context_data(self, **kwargs):
  12.         context = super().get_context_data(**kwargs)
  13.         context['now'] = timezone.now()
  14.         return context

Example myapp/urls.py:

  1. from django.urls import path
  3. from article.views import ArticleListView
  5. urlpatterns = [
  6.     path('', ArticleListView.as_view(), name='article-list'),
  7. ]

Example myapp/article_list.html:

  1. <h1>Articles</h1>
  2. <ul>
  3. {% for article in object_list %}
  4.     <li>{{ article.pub_date|date }} - {{ article.headline }}</li>
  5. {% empty %}
  6.     <li>No articles yet.</li>
  7. {% endfor %}
  8. </ul>

If you’re using pagination, you can adapt the example template from the pagination docs. Change instances of contacts in that example template to page_obj.

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 django.views.generic.list.ListView or other views representing lists of objects.

Ancestors (MRO)

This view inherits methods and attributes from the following views:

Methods

  • get(request, \args, **kwargs*)

    Adds object_list to the context. If allow_empty is True then display an empty list. If allow_empty is False then raise a 404 error.