Class-Based Views in Django

CBVs use classes instead of functions. The built-in CBVs implement common CRUD patterns.

ListView

# views.py
from django.views.generic import ListView
from .models import Task

class TaskListView(ListView):
    model = Task
    template_name = 'tasks/list.html'   # default: tasks/task_list.html
    context_object_name = 'tasks'        # variable name in the template
    paginate_by = 10                     # pagination

    def get_queryset(self):
        return Task.objects.filter(status='todo').order_by('-created_at')

# urls.py
path('', TaskListView.as_view(), name='task-list'),

DetailView

from django.views.generic import DetailView

class TaskDetailView(DetailView):
    model = Task
    template_name = 'tasks/detail.html'
    context_object_name = 'task'
    pk_url_kwarg = 'pk'   # URL parameter name

CreateView

from django.views.generic.edit import CreateView
from django.urls import reverse_lazy

class TaskCreateView(CreateView):
    model = Task
    fields = ['title', 'description', 'status', 'priority']
    template_name = 'tasks/form.html'
    success_url = reverse_lazy('task-list')

The template must contain {{ form }} and {% csrf_token %}.

UpdateView

from django.views.generic.edit import UpdateView

class TaskUpdateView(UpdateView):
    model = Task
    fields = ['title', 'description', 'status']
    template_name = 'tasks/form.html'
    success_url = reverse_lazy('task-list')

DeleteView

from django.views.generic.edit import DeleteView

class TaskDeleteView(DeleteView):
    model = Task
    template_name = 'tasks/confirm_delete.html'
    success_url = reverse_lazy('task-list')

URLs for All CBVs

urlpatterns = [
    path('', TaskListView.as_view(), name='task-list'),
    path('<int:pk>/', TaskDetailView.as_view(), name='task-detail'),
    path('create/', TaskCreateView.as_view(), name='task-create'),
    path('<int:pk>/edit/', TaskUpdateView.as_view(), name='task-edit'),
    path('<int:pk>/delete/', TaskDeleteView.as_view(), name='task-delete'),
]