Django Cheatsheet 03 — Class-Based Views

from django.views.generic import ListView

class PostListView(ListView):
    model = Post
    template_name = "blog/list.html"
    context_object_name = "posts"
    paginate_by = 20
    
    def get_queryset(self):
        qs = super().get_queryset()
        return qs.filter(published=True).select_related("author")
    
    def get_context_data(self, **kwargs):
        ctx = super().get_context_data(**kwargs)
        ctx["tags"] = Tag.objects.all()
        return ctx

from django.views.generic import DetailView

class PostDetailView(DetailView):
    model = Post
    template_name = "blog/detail.html"
    slug_field = "slug"
    slug_url_kwarg = "slug"

from django.views.generic.edit import CreateView, UpdateView, DeleteView
from django.urls import reverse_lazy

class PostCreateView(CreateView):
    model = Post
    fields = ["title", "body"]
    success_url = reverse_lazy("blog:list")
    
    def form_valid(self, form):
        form.instance.author = self.request.user
        return super().form_valid(form)

class PostUpdateView(UpdateView):
    model = Post
    fields = ["title", "body"]
    template_name = "blog/post_form.html"   # same as create by default

class PostDeleteView(DeleteView):
    model = Post
    success_url = reverse_lazy("blog:list")

from django.views.generic import TemplateView, RedirectView

class AboutView(TemplateView):
    template_name = "about.html"

class HomeRedirect(RedirectView):
    url = "/posts/"
    permanent = False

from django.views.generic.edit import FormView
from .forms import ContactForm

class ContactView(FormView):
    template_name = "contact.html"
    form_class = ContactForm
    success_url = "/thanks/"
    
    def form_valid(self, form):
        form.send_email()
        return super().form_valid(form)

from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin, UserPassesTestMixin

class MyView(LoginRequiredMixin, ListView):
    login_url = "/login/"
    redirect_field_name = "next"

class AdminView(PermissionRequiredMixin, ListView):
    permission_required = ["blog.delete_post"]

class OwnerView(UserPassesTestMixin, UpdateView):
    def test_func(self):
        return self.get_object().author == self.request.user

class AjaxOnlyMixin:
    def dispatch(self, request, *args, **kwargs):
        if not request.headers.get("x-requested-with") == "XMLHttpRequest":
            return HttpResponseBadRequest()
        return super().dispatch(request, *args, **kwargs)

class MyView(AjaxOnlyMixin, ListView):
    ...

class TitleMixin:
    title = "Site"
    
    def get_context_data(self, **kwargs):
        ctx = super().get_context_data(**kwargs)
        ctx["title"] = self.title
        return ctx

path("posts/", PostListView.as_view(), name="list"),
path("posts/<slug:slug>/", PostDetailView.as_view(), name="detail"),
path("posts/new/", PostCreateView.as_view(), name="create"),
path("posts/<int:pk>/edit/", PostUpdateView.as_view(), name="edit"),
path("posts/<int:pk>/delete/", PostDeleteView.as_view(), name="delete"),

path("posts/", PostListView.as_view(paginate_by=10, template_name="custom.html"))

from django.views import View

class MyView(View):
    def get(self, request):
        return HttpResponse("GET")
    
    def post(self, request):
        return HttpResponse("POST")

def dispatch(self, request, *args, **kwargs):
    if request.user.is_blocked:
        return HttpResponseForbidden()
    return super().dispatch(request, *args, **kwargs)

def get_object(self, queryset=None):
    obj = super().get_object(queryset)
    if obj.author != self.request.user:
        raise Http404
    return obj

def form_invalid(self, form):
    messages.error(self.request, "Fix the errors below")
    return super().form_invalid(form)