成功メッセージ

CoddyのDjangoジャーニー「フォーム」セクションの一部。レッスン 15/20。

保存後、訪問者はイベントのページに移動しますが、保存が成功したことを示すものは何もありません。ビューはそのページに変数を渡せません。次のリクエストで、別のビューがページを描画するためです。

Django の messages フレームワークは、リダイレクトをまたいでメッセージを伝えます。ビューはリダイレクトする前にメッセージを追加します。Django はその訪問者のためにメッセージを保持し、次に描画されるページに渡します。コメントを保存するブログの例：

from django.contrib import messages

comment.save()
messages.success(request, "Thanks, your comment is posted.")
return redirect("blog:post", pk=post.pk)

すべてのテンプレートで messages 変数が使えるため、ベーステンプレートに記述すれば、すべてのページにメッセージを表示できます。

{% for message in messages %}
<p class="note">{{ message }}</p>
{% endfor %}

messages をループ処理すると、メッセージは既読として扱われるため、それぞれ一度だけ表示されます。

チャレンジ

簡単

各保存が成功したことを訪問者に伝えます。

events/views.pyで、リダイレクトの前に各保存の後で成功メッセージを追加します。new_eventではYour event was added.、edit_eventではYour changes were saved.、delete_eventではThe event was deleted.を追加します。
base.htmlで、{% block content %}の上に、各メッセージを<ul class="messages">内の<li>として表示し、メッセージがある場合にのみリストを表示します。

イベントを追加すると、ページ上部にYour event was added.と表示され、再読み込みすると消えます。

自分で試してみよう

from django.shortcuts import get_object_or_404, redirect, render

from .forms import EventForm
from .models import Event


def event_list(request):
    q = request.GET.get("q", "")
    events = Event.objects.all()
    if q:
        events = events.filter(title__icontains=q)
    return render(request, "events/event_list.html", {"events": events, "q": q})


def event_detail(request, pk):
    event = get_object_or_404(Event, pk=pk)
    return render(request, "events/event_detail.html", {"event": event})


def new_event(request):
    if request.method == "POST":
        form = EventForm(request.POST)
        if form.is_valid():
            event = form.save()
            return redirect("events:detail", pk=event.pk)
    else:
        form = EventForm()
    return render(request, "events/new_event.html", {"form": form})


def edit_event(request, pk):
    event = get_object_or_404(Event, pk=pk)
    if request.method == "POST":
        form = EventForm(request.POST, instance=event)
        if form.is_valid():
            form.save()
            return redirect("events:detail", pk=event.pk)
    else:
        form = EventForm(instance=event)
    return render(request, "events/edit_event.html", {"form": form, "event": event})


def delete_event(request, pk):
    event = get_object_or_404(Event, pk=pk)
    if request.method == "POST":
        event.delete()
        return redirect("events:list")
    return render(request, "events/delete_event.html", {"event": event})