DetailView for single objects in Django

Introduction

A DetailView shows information about one specific item from your database. It helps you display details clearly without extra coding.

When you want to show details of a single blog post.

When displaying a user profile page.

When showing product details in an online store.

When you need to display information about one event or appointment.

Syntax

Django

from django.views.generic.detail import DetailView

class MyModelDetailView(DetailView):
    model = MyModel
    template_name = 'myapp/mymodel_detail.html'
    context_object_name = 'object'

# URL pattern example:
# path('mymodel/<int:pk>/', MyModelDetailView.as_view(), name='mymodel-detail')

model tells Django which database table to use.

template_name is the HTML file that shows the details.

Examples

This shows details for one Book object using a custom template and context name.

Django

class BookDetailView(DetailView):
    model = Book
    template_name = 'books/book_detail.html'
    context_object_name = 'book'

If you don't set template_name or context_object_name, Django uses defaults based on the model name.

Django

class UserProfileView(DetailView):
    model = User
    # Uses default template: user_detail.html
    # Uses default context name: 'user'

Sample Program

This example shows a Product model and a DetailView that displays one product's name and description. The URL uses the product's ID to find it.

Django

from django.db import models
from django.urls import path
from django.views.generic.detail import DetailView

# Model definition
class Product(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField()

    def __str__(self):
        return self.name

# DetailView for Product
class ProductDetailView(DetailView):
    model = Product
    template_name = 'product_detail.html'
    context_object_name = 'product'

# URL pattern
urlpatterns = [
    path('product/<int:pk>/', ProductDetailView.as_view(), name='product-detail'),
]

# Example product_detail.html template content:
# <h1>{{ product.name }}</h1>
# <p>{{ product.description }}</p>

Important Notes

The URL must include a primary key (pk) or slug to find the right object.

If the object is not found, Django shows a 404 error page automatically.

You can customize the template to show any fields you want from the object.

Summary

DetailView shows one object's details with little code.

Set the model and template to control what and how it shows.

Use URL patterns with pk or slug to select the object.

Practice

1. What is the primary purpose of Django's DetailView?

easy

A. To list multiple objects in a table format

B. To display details of a single object from the database

C. To create a new object via a form

D. To delete an object from the database

Solution

1. Step 1: Understand DetailView's role

   DetailView is designed to show details of one object, not multiple or form actions.

2. Step 2: Compare with other views

   ListView shows multiple objects, CreateView handles creation, DeleteView handles deletion.

3. Final Answer:

   To display details of a single object from the database -> Option B

4. Quick Check:

   DetailView = single object display [OK]

Hint: DetailView always shows one object's details [OK]

Common Mistakes:

• Confusing DetailView with ListView
• Thinking DetailView handles forms
• Assuming DetailView deletes objects

2. Which of the following is the correct way to specify the model in a Django DetailView?

easy

A. models = MyModel

B. Model = MyModel

C. model = MyModel

D. model_name = MyModel

Solution

1. Step 1: Check attribute naming conventions

   Django's DetailView expects the attribute model in lowercase to specify the model class.

2. Step 2: Validate other options

   Capitalized Model, plural models, or model_name are not recognized by DetailView.

3. Final Answer:

   model = MyModel -> Option C

4. Quick Check:

   Use lowercase 'model' attribute [OK]

Hint: Use lowercase 'model' to set the model in DetailView [OK]

Common Mistakes:

• Capitalizing 'Model' attribute
• Using plural 'models' instead of 'model'
• Trying 'model_name' instead of 'model'

3. Given this URL pattern:
path('product/<int:pk>/', ProductDetailView.as_view(), name='product-detail')
and this view:

class ProductDetailView(DetailView):
    model = Product
    template_name = 'product_detail.html'

What will ProductDetailView display when visiting /product/5/?

medium

A. Details of the Product object with primary key 5

B. A list of all Product objects

C. An error because template_name is missing

D. Details of the Product object with slug '5'

Solution

1. Step 1: Understand URL pattern and pk usage

   The URL uses <int:pk> which passes primary key 5 to the view.

2. Step 2: DetailView uses pk to fetch object

   DetailView fetches the Product object with pk=5 and renders 'product_detail.html'.

3. Final Answer:

   Details of the Product object with primary key 5 -> Option A

4. Quick Check:

   pk in URL = object detail shown [OK]

Hint: pk in URL selects object DetailView shows [OK]

Common Mistakes:

• Confusing pk with slug
• Expecting a list instead of single object
• Thinking template_name is required to avoid error

4. What is wrong with this DetailView code?

class ArticleDetailView(DetailView):
    model = Article
    template = 'article_detail.html'

medium

A. The attribute should be 'template_name', not 'template'

B. The model attribute must be a string, not a class

C. DetailView requires a get_queryset method

D. The class must inherit from ListView, not DetailView

Solution

1. Step 1: Check attribute for template file

   The correct attribute to specify the template is template_name, not template.

2. Step 2: Validate other options

   Model should be a class, get_queryset is optional, and DetailView is correct for single object display.

3. Final Answer:

   The attribute should be 'template_name', not 'template' -> Option A

4. Quick Check:

   Use 'template_name' to set template [OK]

Hint: Use 'template_name' attribute for templates [OK]

Common Mistakes:

• Using 'template' instead of 'template_name'
• Thinking model must be string
• Adding unnecessary get_queryset method

5. You want to create a DetailView for a BlogPost model that uses a slug in the URL instead of pk. Which is the correct way to configure the view and URL pattern?

hard

A. In the view, set model = BlogPost and slug_field = 'slug'; in URL use path('blog/<slug:slug>/', ...)

B. In the view, set model = BlogPost and slug_field = 'slug'; in URL use path('blog/<int:slug>/', ...)

C. In the view, set model = BlogPost and pk_url_kwarg = 'slug'; in URL use path('blog/<slug:slug>/', ...)

D. In the view, set model = BlogPost and slug_url_kwarg = 'slug'; in URL use path('blog/<slug:slug>/', ...)

Solution

1. Step 1: Understand slug configuration in DetailView

   DetailView uses pk by default. To use slug, set slug_url_kwarg = 'slug' if your URL kwarg is 'slug'. The slug_field defaults to 'slug' and usually does not need to be set unless your model field is named differently.

2. Step 2: Validate options

   In the view, set model = BlogPost and slug_url_kwarg = 'slug'; in URL use path('blog/<slug:slug>/', ...) correctly sets slug_url_kwarg to match the URL kwarg and uses the default slug_field. In the view, set model = BlogPost and slug_field = 'slug'; in URL use path('blog/<slug:slug>/', ...) incorrectly sets slug_field which is the model field name, not the URL kwarg. In the view, set model = BlogPost and pk_url_kwarg = 'slug'; in URL use path('blog/<slug:slug>/', ...) misuses pk_url_kwarg. In the view, set model = BlogPost and slug_field = 'slug'; in URL use path('blog/<int:slug>/', ...) uses wrong URL converter.

3. Final Answer:

   In the view, set model = BlogPost and slug_url_kwarg = 'slug'; in URL use path('blog/<slug:slug>/', ...) -> Option D

4. Quick Check:

   slug_url_kwarg matches URL kwarg [OK]

Hint: Set slug_url_kwarg='slug' to match URL kwarg [OK]

Common Mistakes:

• Confusing slug_field with slug_url_kwarg
• Using int converter for slug in URL
• Setting pk_url_kwarg instead of slug_url_kwarg