Projet : Effacer les tâches terminées

Fait partie de la section API JSON du Journey Django de Coddy. Leçon 16 sur 19.

Les tâches terminées s’accumulent ; le suivi a donc besoin d’un moyen de les effacer d’un seul coup. Cette action ne concerne pas la ressource d’une tâche en particulier : elle a donc sa propre URL et, puisqu’elle modifie les données, elle n’accepte que les requêtes POST : les navigateurs, les aperçus de liens et les moteurs de recherche envoient des requêtes GET sans demander à personne ; une requête GET ne doit donc jamais supprimer de données.

Un détail est nouveau. La méthode delete() d’un QuerySet renvoie une paire : le nombre de lignes supprimées et un dictionnaire indiquant le nombre de suppressions par modèle :

>>> Book.objects.filter(year__lt=1900).delete()
(2, {'books.Book': 2})

Pour le reste, vous avez déjà créé les éléments nécessaires : une vue, sa route, deux décorateurs et une réponse JSON.

Défi

Difficile

Ajoutez POST /api/tasks/clear-done/, avec une route nommée clear_done :

Elle supprime toutes les tâches terminées et renvoie {"deleted": 1}, le nombre de tâches supprimées.
Toute autre méthode renvoie le code 405.
Elle fonctionne sans jeton CSRF.

Cliquez sur Run, puis dans l’onglet Shell : from django.test import Client; print(Client().post("/api/tasks/clear-done/").json())

Essayez vous-même

import json

from django.http import HttpResponse, JsonResponse
from django.shortcuts import get_object_or_404, render
from django.utils.decorators import method_decorator
from django.views import View
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_GET, require_http_methods

from .models import Task


def task_to_dict(task):
    return {
        "id": task.id,
        "title": task.title,
        "done": task.done,
        "priority": task.priority,
    }


def home(request):
    return render(request, "tasks/home.html")


def task_page(request):
    return render(request, "tasks/list.html", {"tasks": Task.objects.all()})


def task_row(request, pk):
    task = get_object_or_404(Task, pk=pk)
    return render(request, "tasks/list.html#task-row", {"task": task})


@require_GET
def stats(request):
    total = Task.objects.count()
    done = Task.objects.filter(done=True).count()
    data = {
        "total": total,
        "done": done,
        "open": total - done,
    }
    return JsonResponse(data)


@csrf_exempt
@require_http_methods(["GET", "POST"])
def task_list(request):
    if request.method == "POST":
        try:
            data = json.loads(request.body)
        except json.JSONDecodeError:
            return JsonResponse({"error": "The body is not valid JSON."}, status=400)
        errors = {}
        title = data.get("title", "").strip()
        if not title:
            errors["title"] = "This field is required."
        priority = data.get("priority", "normal")
        if priority not in Task.Priority.values:
            errors["priority"] = "Choose low, normal or high."
        if errors:
            return JsonResponse({"errors": errors}, status=400)
        task = Task.objects.create(
            title=title,
            priority=priority,
        )
        return JsonResponse(task_to_dict(task), status=201)
    tasks = Task.objects.all()
    done = request.GET.get("done")
    if done == "true":
        tasks = tasks.filter(done=True)
    elif done == "false":
        tasks = tasks.filter(done=False)
    priority = request.GET.get("priority")
    if priority:
        tasks = tasks.filter(priority=priority)
    return JsonResponse([task_to_dict(task) for task in tasks], safe=False)


def not_found():
    return JsonResponse({"error": "Task not found"}, status=404)


@method_decorator(csrf_exempt, name="dispatch")
class TaskDetail(View):
    def get(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        return JsonResponse(task_to_dict(task))

    def patch(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        data = json.loads(request.body)
        if "title" in data:
            task.title = data["title"]
        if "done" in data:
            task.done = data["done"]
        task.save()
        return JsonResponse(task_to_dict(task))

    def delete(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        task.delete()
        return HttpResponse(status=204)