Generic display views

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:

• django.views.generic.detail.SingleObjectTemplateResponseMixin
• django.views.generic.detail.BaseDetailView
• django.views.generic.base.View

Method Flowchart

2. dispatch()
4. get_template_names()
6. get_queryset()
8. get_context_object_name()
10. get()

Example myapp/views.py:

Example myapp/urls.py:

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

Example myapp/article_detail.html:

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.

This view inherits methods and attributes from the following views:

• django.views.generic.base.View

Methods

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

  Adds 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:

• django.views.generic.list.MultipleObjectTemplateResponseMixin
• django.views.generic.list.BaseListView
• django.views.generic.base.View

Method Flowchart

2. dispatch()
4. get_template_names()
6. get_context_object_name()
8. get()

from django.utils import timezone
from articles.models import Article
class ArticleListView(ListView):
    model = Article
    paginate_by = 100  # if pagination is desired
        context = super().get_context_data(**kwargs)
        context['now'] = timezone.now()
        return context

Example myapp/urls.py:

Example myapp/article_list.html:

<h1>Articles</h1>
<ul>
{% for article in object_list %}
    <li>{{ article.pub_date|date }} - {{ article.headline }}</li>
{% empty %}
    <li>No articles yet.</li>
{% endfor %}
</ul>

If you’re using pagination, you can adapt the example template from the pagination docs.

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

Ancestors (MRO)

This view inherits methods and attributes from the following views:

• django.views.generic.list.MultipleObjectMixin

Methods

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

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