# Django 4.1.8.dev20230308103347 ドキュメント

# ビューを記述する

A view function, or view for short, is a Python function that takes a web request and returns a web response. This response can be the HTML contents of a web page, or a redirect, or a 404 error, or an XML document, or an image . . . or anything, really. The view itself contains whatever arbitrary logic is necessary to return that response. This code can live anywhere you want, as long as it's on your Python path. There's no other requirement--no "magic," so to speak. For the sake of putting the code somewhere, the convention is to put views in a file called `views.py`, placed in your project or application directory.

## シンプルなビュー

以下は、HTML ドキュメントとして、現在の日付と時刻を返すビューです:

    from django.http import HttpResponse
    import datetime

    def current_datetime(request):
        now = datetime.datetime.now()
        html = "<html><body>It is now %s.</body></html>" % now
        return HttpResponse(html)

1 行ずつコードを見ていきましょう:

- 最初に、Python の `datetime` ライブラリ とともに、クラス `HttpResponse` を `django.http` モジュールからインポートします。

- 次に、`current_datetime` という関数を定義します。これがビュー関数です。それぞれのビュー関数は、`HttpRequest` のオブジェクトを第 1 引数として受け取り、一般的には `request` と名付けられます。

  ビュー関数の名前は重要ではありません; Django が識別するために特別な方法で名前を付ける必要はありません。ここでは、`current_datetime` という名前はその機能を的確に表しているので、ビュー関数を `current_datetime` と呼ぶことにします。

- このビューは、生成されたレスポンスを含む `HttpResponse` のオブジェクトを返します。それぞれのビュー関数には、`HttpResponse` オブジェクトを返す義務があります。(例外もありますので、後で説明します。)

Django のタイムゾーン

Django は `TIME_ZONE` 設定を含んでおり、デフォルトは `America/Chicago` です。これはあなたの住む場所ではないかもしれませんので、あなたの設定ファイルを変更する必要があるかもしれません。

## URL をビューにマッピングする

要約すると、このビュー関数は現在の日付と時刻を含む HTML ページを返します。このビューを特定の URL で表示するには、URLconf を作成する必要があります。その方法は、URL ディスパッチャ を参照してください。

## エラーを返す

Django provides help for returning HTTP error codes. There are subclasses of `HttpResponse` for a number of common HTTP status codes other than 200 (which means "OK"). You can find the full list of available subclasses in the request/response documentation. Return an instance of one of those subclasses instead of a normal `HttpResponse` in order to signify an error. For example:

    from django.http import HttpResponse, HttpResponseNotFound

    def my_view(request):
        # ...
        if foo:
            return HttpResponseNotFound('<h1>Page not found</h1>')
        else:
            return HttpResponse('<h1>Page was found</h1>')

レスポンスコードの多くは使用頻度が低いため、発生しうる HTTP レスポンスコードすべてにそれぞれ特化したサブクラスが用意されているわけではありません。 しかし、`HttpResponse` のドキュメントに書かれているように、HTTP ステータスコードをコンストラクタに渡して、`HttpResponse` が任意のステータスコードを返すクラスを作成することもできます。例えば:

    from django.http import HttpResponse

    def my_view(request):
        # ...

        # Return a "created" (201) response code.
        return HttpResponse(status=201)

404 エラーは最も一般的な HTTP エラーなので、簡単に扱える方法があります。

### `Http404` 例外

class `django.http.``Http404`

エラーを返すときは (例えば `HttpResponseNotFound`)、エラーページを結果とする HTML を定義する責任があります:

    return HttpResponseNotFound('<h1>Page not found</h1>')

利便性に加えて、サイト全体を通じて一貫性のある 404 ページを表示できるようにするため、Django は `Http404` 例外を提供しています。raise `Http404` した場合、ビュー関数のどの場所でも、Django はこれを認識して、HTTP エラーコード 404 とともに標準的なエラーページをアプリケーションに返します。

使い方の例:

    from django.http import Http404
    from django.shortcuts import render
    from polls.models import Poll

    def detail(request, poll_id):
        try:
            p = Poll.objects.get(pk=poll_id)
        except Poll.DoesNotExist:
            raise Http404("Poll does not exist")
        return render(request, 'polls/detail.html', {'poll': p})

Django が 404 を返したときに独自の HTML を表示したいときは、404.html` という名前の HTML テンプレートを作成し、テンプレートツリーのトップレベルの場所に置いてください。`DEBUG` が `False` にセットされているとき、このテンプレートが使われます。

`DEBUG` が `True` の場合、`Http404` にメッセージを提供し、標準的な 404 デバッグテンプレートに表示させることができます。このメッセージ機能はデバッグ用に使用してください; 通常、プロダクトの404 テンプレートとしては不向きです。

## エラービューをカスタマイズする

The default error views in Django should suffice for most web applications, but can easily be overridden if you need any custom behavior. Specify the handlers as seen below in your URLconf (setting them anywhere else will have no effect).

`page_not_found()` ビューは `handler404` でオーバーライドされます:

    handler404 = 'mysite.views.my_custom_page_not_found_view'

`server_error()` ビューは `handler500` でオーバーライドされます:

    handler500 = 'mysite.views.my_custom_error_view'

`permission_denied()` ビューは `handler403` でオーバーライドされます:

    handler403 = 'mysite.views.my_custom_permission_denied_view'

`bad_request()` ビューは `handler400` でオーバーライドされます:

    handler400 = 'mysite.views.my_custom_bad_request_view'

参考

CSRF エラービューをオーバーライドするには、`CSRF_FAILURE_VIEW` 設定を使用してください。

### カスタムエラービューのテスト

カスタムエラーのハンドラーのレスポンスをテストするには、たとえば以下のように、テストビューの中で適切な例外を起こします。

    from django.core.exceptions import PermissionDenied
    from django.http import HttpResponse
    from django.test import SimpleTestCase, override_settings
    from django.urls import path

    def response_error_handler(request, exception=None):
        return HttpResponse('Error handler content', status=403)

    def permission_denied_view(request):
        raise PermissionDenied

    urlpatterns = [
        path('403/', permission_denied_view),
    ]

    handler403 = response_error_handler

    # ROOT_URLCONF must specify the module that contains handler403 = ...
    @override_settings(ROOT_URLCONF=__name__)
    class CustomErrorHandlerTests(SimpleTestCase):

        def test_handler_renders_template_response(self):
            response = self.client.get('/403/')
            # Make assertions on the response here. For example:
            self.assertContains(response, 'Error handler content', status_code=403)

## 非同期ビュー

As well as being synchronous functions, views can also be asynchronous ("async") functions, normally defined using Python's `async def` syntax. Django will automatically detect these and run them in an async context. However, you will need to use an async server based on ASGI to get their performance benefits.

Here's an example of an async view:

    import datetime
    from django.http import HttpResponse

    async def current_datetime(request):
        now = datetime.datetime.now()
        html = '<html><body>It is now %s.</body></html>' % now
        return HttpResponse(html)

You can read more about Django's async support, and how to best use async views, in 非同期サポート.