项目:清除已完成任务
本课属于 Coddy Django 学习旅程的“JSON API”单元。第 16 课,共 19 课。
已完成的任务会越积越多,所以跟踪器需要一种一次性清除它们的方法。清除操作会同时处理多个任务,而不是单个任务,因此它需要自己的 URL。由于它会更改数据,所以只接受 POST:浏览器、链接预览和搜索引擎会在不询问任何人的情况下发送 GET,因此 GET 绝不能删除数据。
这里有一点是新的。QuerySet 的 delete() 会返回一对值:已删除的行数,以及一个按模型统计数量的字典:
>>> Book.objects.filter(year__lt=1900).delete()
(2, {'books.Book': 2})其余部分你以前都构建过:一个视图、它的路由、两个装饰器和一个 JSON 响应。
挑战
困难添加一个用于清除所有已完成任务的端点。
- 在
tasks/views.py中,添加一个视图clear_done。它会删除所有已完成的任务,并返回{"deleted": 1},其中的数字表示删除的任务数。任何非POST请求都会得到405,而且无需 CSRF 令牌也能使用。 - 在
tasks/urls.py中,添加名为clear_done的路由"api/tasks/clear-done/"。
在 Shell 选项卡中运行下面这行代码:它会输出 {'deleted': 1},因为 Call the bank 是唯一已完成的任务。
from django.test import Client; print(Client().post("/api/tasks/clear-done/").json())亲手试试
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)
JSON API中的所有课
自己练习: Django 在线编辑器