はじめての Django アプリ作成、その 4

このチュートリアルは チュートリアルその 3 の続きです。ここでは、引続き Web 投票アプリケーションの開発を例にして、簡単なフォー ム処理とコードの縮小化を中心に解説します。

簡単なフォームを書く

それでは、前回のチュートリアルで作成した投票詳細テンプレート (「polls/detail.html」) を更新して、HTML の <form> 要素を入れましょう。

polls/templates/polls/detail.html
<h1>{{ question.question_text }}</h1>

{% if error_message %}<p><strong>{{ error_message }}</strong></p>{% endif %}

<form action="{% url 'polls:vote' question.id %}" method="post">
{% csrf_token %}
{% for choice in question.choice_set.all %}
    <input type="radio" name="choice" id="choice{{ forloop.counter }}" value="{{ choice.id }}" />
    <label for="choice{{ forloop.counter }}">{{ choice.choice_text }}</label><br />
{% endfor %}
<input type="submit" value="Vote" />
</form>

簡単に説明:

  • 上のテンプレートは、各質問の選択肢のラジオボタンが表示されます。各ラジオボタンの value は、関連する質問の選択肢のIDです。各ラジオボタンの name"choice" です。投票者がラジオボタンの1つを選択し、フォームを送信する場合には、POSTデータ choice=# を送信します。#の場所には選択肢のIDが入ります。これは、HTMLフォームの基本的な概念です。
  • フォームの action{% url 'polls:vote' question.id %} に設定し、 さらに、 method="post" を設定します。method="post" を使用する (method="get" ではなく) ことは非常に重要です。なぜなら、フォームの送信はサーバ側のデータの更新につながるからです。サーバ側のデータを更新するフォームを作成する場合は、 method="post" を使いましょう。これは、 Django 固有のものではなく、いわば Web 開発の王道です。
  • forloop.counter は、ttag:for タグのループが何度実行されたかを表す値です。
  • POST フォーム(データを改ざんされる恐れのある) を作成しているので、クロス サイトリクエストフォージェリを心配する必要があります。ありがたいことに、 Django がこれに対応するとても使いやすい仕組みを提供してくれているので、あまり心配する必要はありません。手短に言うと、全ての自サイトへの POST フォームに、 {% csrf_token %} テンプレートタグを使います。

送信されたデータを処理するための Django のビューを作成しましょう。 チュートリアルその 3 で、以下のような投票アプリケーションの URLconf を作成したことを思い出しましょう:

polls/urls.py
url(r'^(?P<question_id>[0-9]+)/vote/$', views.vote, name='vote'),

すでに、 vote() 関数のダミー実装を作成しました。今度は、本物を実装しましょう。以下を polls/views.py に追加してください:

polls/views.py
from django.shortcuts import get_object_or_404, render
from django.http import HttpResponseRedirect, HttpResponse
from django.urls import reverse

from .models import Choice, Question
# ...
def vote(request, question_id):
    question = get_object_or_404(Question, pk=question_id)
    try:
        selected_choice = question.choice_set.get(pk=request.POST['choice'])
    except (KeyError, Choice.DoesNotExist):
        # Redisplay the question voting form.
        return render(request, 'polls/detail.html', {
            'question': question,
            'error_message': "You didn't select a choice.",
        })
    else:
        selected_choice.votes += 1
        selected_choice.save()
        # Always return an HttpResponseRedirect after successfully dealing
        # with POST data. This prevents data from being posted twice if a
        # user hits the Back button.
        return HttpResponseRedirect(reverse('polls:results', args=(question.id,)))

このコードには、これまでのチュートリアルで扱っていなかったことがいくつか入っています:

  • request.POST は送信したキーの名前でデータにアクセスできる辞書のようなオブジェクトです。この場合、 request.POST['choice'] は、選択された選択肢の ID を文字列として返します。 request.POST の値は常に文字列です。

    Django では、GET データにアクセスするために同様に request.GET を提供しています。ただし、このコードでは、POST を経由した呼び出しでないとデータを更新させないようにするために、request.POST を明示的に使っています。

  • POST データに choice がなければ、 request.POST['choice']KeyError を送出します。上のコードでは KeyError をチェックし、 choice がない場合にはエラーメッセージ付きの質問フォームを再表示します。

  • choice のカウントをインクリメントした後、このコードは、 通常の HttpResponse ではなく HttpResponseRedirect を返します。 HttpResponseRedirect はひとつの引数をとります: リダイレクト先のURL (このような場合にURLを構築する方法については、以下のポイントを参照してください)

    上記の Python コメントが指摘するように、POST データが成功した後に HttpResponseRedirect を常に返す必要があります。これは Django 固有のものではありません。それは良い Web 開発のプラクティスです。

  • この例では、 HttpResponseRedirect コンストラクタの中で reverse() 関数を使用しています。この関数を使うと、ビュー関数中での URL のハードコードを防げます。関数には、制御を渡したいビューの名前と、そのビューに与える URL パターンの位置引数を与えます。この例では、 チュートリアルその 3 で設定した URLconf を使っているので、 reverse() を呼ぶと、次のような文字列が返ってきます。

    '/polls/3/results/'
    

    この 3question.id の値です。 リダイレクト先の URL は 'results' ビューを呼び出し、最終的なページを表示します。

チュートリアルその 3 で触れたように、 requestHttpRequest オブジェクトです。 HttpRequest オブジェクトの詳細は リクエスト・レスポンスオブジェクトのドキュメント を参照してください。

誰かが質問の投票すると、 vote() ビューは質問の結果ページにリダイレクトします。このビューを書きましょう:

polls/views.py
from django.shortcuts import get_object_or_404, render


def results(request, question_id):
    question = get_object_or_404(Question, pk=question_id)
    return render(request, 'polls/results.html', {'question': question})

チュートリアルその 3detail() とほぼ同じです。テンプレートの名前のみ違います。この冗長さは後で修正することにします。

それでは polls/results.html テンプレートを作成します:

polls/templates/polls/results.html
<h1>{{ question.question_text }}</h1>

<ul>
{% for choice in question.choice_set.all %}
    <li>{{ choice.choice_text }} -- {{ choice.votes }} vote{{ choice.votes|pluralize }}</li>
{% endfor %}
</ul>

<a href="{% url 'polls:detail' question.id %}">Vote again?</a>

ブラウザで /polls/1/ を表示して投票してみましょう。票を入れるたびに、結果のページが更新されていることがわかるはずです。選択肢を選ばずにフォームを送信すると、エラーメッセージを表示されるはずです。

注釈

これまで作ってきた vote() ビューのコードは、小さな問題を抱えています。最初にデータベースから selected_choice オブジェクトを取得し、そこで votes の新しい値を計算し、データベースにそれを戻して保存します。もしウェブサイトのユーザー 2 人が まったく同時に 投票しようとすると、誤りが発生します。votes の元の値が 42 だったとしましょう。その時、両方のユーザーに対して新しい値として 43 が計算され保存されます、しかし 44 が本来想定される値です。

この問題は、「競合状態」と呼ばれています。この問題に興味がある人は、Avoiding race conditions using F() を読むと、この問題の解決方法がわかります。

汎用ビューを使う: コードが少ないのはいいことだ

detail() ( チュートリアルその 3 ) と results() ビューはとても簡単で、先程も述べたように冗長です。投票の一覧を表示する index() ビュー (チュートリアルその 3) も同様です。

これらのビューは基本的な Web開発の一般的なケースを表します。すなわち、 URL を介して渡されたパラメータに従ってデータベースからデータを取り出し、テンプレートをロードして、レンダリングしたテンプレートを返します。これはきわめてよくあることなので、 Django では、汎用ビュー 「generic view」 というショートカットを提供しています。

汎用ビューとは、よくあるパターンを抽象化して、 Python コードすら書かずにアプリケーションを書き上げられる状態にしたものです。

これまで作成してきた poll アプリを汎用ビューシステムに変換して、 コードをばっさり捨てられるようにしましょう。変換にはほんの数ステップしかか かりません。そのステップとは:

  1. URLconf を変換する。
  2. 古い不要なビューを削除する。
  3. 新しいビューに Djangoの汎用ビューを設定する。

詳しく見てゆきましょう。

なぜコードを入れ換えるの?

一般に Django アプリケーションを書く場合は、まず自分の問題を解決するために汎用ビューが適しているか考えた上で、最初から汎用ビューを使い、途中まで書き上げたコードをリファクタすることはありません。ただ、このチュートリアルでは中核となるコンセプトに焦点を合わせるために、わざと「大変な」ビューの作成に集中してもらったのです。

電卓を使う前に、算数の基本を知っておかねばならないのと同じです。

URLconf の修正

まず、 URLconf の polls/urls.py を開き、次のように変更します:

polls/urls.py
from django.conf.urls import url

from . import views

app_name = 'polls'
urlpatterns = [
    url(r'^$', views.IndexView.as_view(), name='index'),
    url(r'^(?P<pk>[0-9]+)/$', views.DetailView.as_view(), name='detail'),
    url(r'^(?P<pk>[0-9]+)/results/$', views.ResultsView.as_view(), name='results'),
    url(r'^(?P<question_id>[0-9]+)/vote/$', views.vote, name='vote'),
]

2 つ目と 3 つ目の正規表現でのマッチパターンの名前が <question_id> から <pk> に変更されたことに注意してください。

views の修正

次に、古い indexdetail 、と results のビューを削除し、代わりに Django の汎用ビューを使用します。これを行うには、 polls/views.py ファイルを開き、次のように変更します:

polls/views.py
from django.shortcuts import get_object_or_404, render
from django.http import HttpResponseRedirect
from django.urls import reverse
from django.views import generic

from .models import Choice, Question


class IndexView(generic.ListView):
    template_name = 'polls/index.html'
    context_object_name = 'latest_question_list'

    def get_queryset(self):
        """Return the last five published questions."""
        return Question.objects.order_by('-pub_date')[:5]


class DetailView(generic.DetailView):
    model = Question
    template_name = 'polls/detail.html'


class ResultsView(generic.DetailView):
    model = Question
    template_name = 'polls/results.html'


def vote(request, question_id):
    ... # same as above, no changes needed.

ここでは、ListViewDetailView を使用しています。これらのビューはそれぞれ、「オブジェクトのリストを表示する」および「あるタイプのオブジェクトの詳細ページを表示する」という二つの概念を抽象化しています。

  • 各汎用ビューは自分がどのモデルに対して動作するのか知っておく必要があります。これは、 model 属性を使用して提供されます。
  • DetailView 汎用ビューには、 "pk" という名前で URL からプライマリキーをキャプチャして渡すことになっていので、 汎用ビュー向けに question_idpk に変更しています。

デフォルトでは、 DetailView 汎用ビューは <app name>/<model name>_detail.html という名前のテンプレートを使います。この場合、テンプレートの名前は "polls/question_detail.html" です。 template_name 属性は Django に自動生成されたデフォルトのテンプレート名ではなく、指定した名前を使うように伝えるために使われます。 results リストビューにも template_name を指定します。これは、 結果ビューと詳細ビューがお互い実は DetailView であるにも関わらず、レンダリングされたとき違った外観を持っているためです。

同様に、 ListView 汎用ビューは <app name>/<model name>_list.html というデフォルトのテンプレートを使うので、 template_name を使って ListView に既存の "polls/index.html" テンプレートを使用するように伝えます。

このチュートリアルの前の部分では、 questionlatest_question_list といった変数の入ったコンテキストをテンプレートに渡していました。 DetailView には、 question という変数が自動的に渡されます。なぜなら、 Django モデル (Question) を使用していて、 Django はコンテキスト変数にふさわしい名前を決めることができるからです。一方で、 ListView では、自動的に生成されるコンテキスト変数は question_list になります。これを上書きするには、 context_object_name 属性を与え、 latest_question_list を代わりに使用すると指定します。この代替アプローチとして、新しいデフォルトのコンテキスト変数を一致するようにテンプレートを変えることもできます。しかし、ただ Django に使用したい変数名を伝えるほうが簡単でしょう。

サーバを実行して、新しく汎用ビューベースにした投票アプリケーションを使ってみましょう。

汎用ビューの詳細は、汎用ビューのドキュメント を参照してください。

フォームや汎用ビューを使いこなせるようになったら、 チュートリアルその5 に進んで、投票アプリのテストについて学びましょう。

Back to Top