Writing views

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.

A simple view

Here’s a view that returns the current date and time, as an HTML document:

  1. from django.http import HttpResponse
  2. import datetime
  5. def current_datetime(request):
  6.     now = datetime.datetime.now()
  7.     html = "<html><body>It is now %s.</body></html>" % now
  8.     return HttpResponse(html)

Let’s step through this code one line at a time:

  • First, we import the class HttpResponse from the django.http module, along with Python’s datetime library.

  • Next, we define a function called current_datetime. This is the view function. Each view function takes an HttpRequest object as its first parameter, which is typically named request.

    Note that the name of the view function doesn’t matter; it doesn’t have to be named in a certain way in order for Django to recognize it. We’re calling it current_datetime here, because that name clearly indicates what it does.

  • The view returns an HttpResponse object that contains the generated response. Each view function is responsible for returning an HttpResponse object. (There are exceptions, but we’ll get to those later.)

Django’s Time Zone

Django includes a TIME_ZONE setting that defaults to America/Chicago. This probably isn’t where you live, so you might want to change it in your settings file.

Mapping URLs to views

So, to recap, this view function returns an HTML page that includes the current date and time. To display this view at a particular URL, you’ll need to create a URLconf; see URL dispatcher for instructions.

Returning errors

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:

  1. from django.http import HttpResponse, HttpResponseNotFound
  4. def my_view(request):
  5.     # ...
  6.     if foo:
  7.         return HttpResponseNotFound("<h1>Page not found</h1>")
  8.     else:
  9.         return HttpResponse("<h1>Page was found</h1>")

There isn’t a specialized subclass for every possible HTTP response code, since many of them aren’t going to be that common. However, as documented in the HttpResponse documentation, you can also pass the HTTP status code into the constructor for HttpResponse to create a return class for any status code you like. For example:

  1. from django.http import HttpResponse
  4. def my_view(request):
  5.     # ...
  7.     # Return a "created" (201) response code.
  8.     return HttpResponse(status=201)

Because 404 errors are by far the most common HTTP error, there’s an easier way to handle those errors.

The Http404 exception

class django.http.Http404

When you return an error such as HttpResponseNotFound, you’re responsible for defining the HTML of the resulting error page:

  1. return HttpResponseNotFound("<h1>Page not found</h1>")

For convenience, and because it’s a good idea to have a consistent 404 error page across your site, Django provides an Http404 exception. If you raise Http404 at any point in a view function, Django will catch it and return the standard error page for your application, along with an HTTP error code 404.

Example usage:

  1. from django.http import Http404
  2. from django.shortcuts import render
  3. from polls.models import Poll
  6. def detail(request, poll_id):
  7.     try:
  8.         p = Poll.objects.get(pk=poll_id)
  9.     except Poll.DoesNotExist:
  10.         raise Http404("Poll does not exist")
  11.     return render(request, "polls/detail.html", {"poll": p})

In order to show customized HTML when Django returns a 404, you can create an HTML template named 404.html and place it in the top level of your template tree. This template will then be served when DEBUG is set to False.

When DEBUG is True, you can provide a message to Http404 and it will appear in the standard 404 debug template. Use these messages for debugging purposes; they generally aren’t suitable for use in a production 404 template.

Customizing error views

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).

The page_not_found() view is overridden by handler404:

  1. handler404 = "mysite.views.my_custom_page_not_found_view"

The server_error() view is overridden by handler500:

  1. handler500 = "mysite.views.my_custom_error_view"

The permission_denied() view is overridden by handler403:

  1. handler403 = "mysite.views.my_custom_permission_denied_view"

The bad_request() view is overridden by handler400:

  1. handler400 = "mysite.views.my_custom_bad_request_view"

See also

Use the CSRF_FAILURE_VIEW setting to override the CSRF error view.

Testing custom error views

To test the response of a custom error handler, raise the appropriate exception in a test view. For example:

  1. from django.core.exceptions import PermissionDenied
  2. from django.http import HttpResponse
  3. from django.test import SimpleTestCase, override_settings
  4. from django.urls import path
  7. def response_error_handler(request, exception=None):
  8.     return HttpResponse("Error handler content", status=403)
  11. def permission_denied_view(request):
  12.     raise PermissionDenied
  15. urlpatterns = [
  16.     path("403/", permission_denied_view),
  17. ]
  19. handler403 = response_error_handler
  22. # ROOT_URLCONF must specify the module that contains handler403 = ...
  23. @override_settings(ROOT_URLCONF=__name__)
  24. class CustomErrorHandlerTests(SimpleTestCase):
  25.     def test_handler_renders_template_response(self):
  26.         response = self.client.get("/403/")
  27.         # Make assertions on the response here. For example:
  28.         self.assertContains(response, "Error handler content", status_code=403)

Async views

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:

  1. import datetime
  2. from django.http import HttpResponse
  5. async def current_datetime(request):
  6.     now = datetime.datetime.now()
  7.     html = "<html><body>It is now %s.</body></html>" % now
  8.     return HttpResponse(html)

You can read more about Django’s async support, and how to best use async views, in Asynchronous support.