Home > Articles

This chapter is from the book

This chapter is from the book

5.6 Shortening the Development Process with Django View Shortcuts

We now have a two-function view in /organizer/views.py, which currently reads as shown in Example 5.16.

Example 5.16: Project Code

organizer/views.py in 294dabd8cc

 1  from django.http.response import (
 2      Http404, HttpResponse)
 3  from django.template import Context, loader
 4
 5  from .models import Tag
 6
 7
 8  def homepage(request):
 9      tag_list = Tag.objects.all()
10      template = loader.get_template(
11          'organizer/tag_list.html')
12      context = Context({'tag_list': tag_list})
13      output = template.render(context)
14      return HttpResponse(output)
15
16
17  def tag_detail(request, slug):
18      try:
19          tag = Tag.objects.get(slug--iexact=slug)
20      except Tag.DoesNotExist:
21          raise Http404
22      template = loader.get_template(
23          'organizer/tag_detail.html')
24      context = Context({'tag': tag})
25      return HttpResponse(template.render(context))

That is a lot of code for two simple webpages. We also have a lot of duplicate code in each function, which is not in keeping with the DRY philosophy. Luckily for developers, Django provides shortcut functions to ease the development process and to significantly shorten code such as the preceding.

5.6.1 Shortening Code with get_object_or_404()

Our first shortcut, get_object_or_404(), is a complete replacement for the try...except block that currently exists in our tag_detail() function.

Let’s start by importing it into our /organizer/views.py file, as in Example 5.17.

Example 5.17: Project Code

organizer/views.py in 5705e49877

2   from django.shortcuts import get_object_or_404

We can then delete the following lines, as in Example 5.18.

Example 5.18: Project Code

organizer/views.py in 294dabd8cc

18      try:
19          tag = Tag.objects.get(slug--iexact=slug)
20      except Tag.DoesNotExist:
21          raise Http404

We replace the content in Example 5.18 with the code in Example 5.19.

Example 5.19: Project Code

organizer/views.py in 5705e49877

18      tag = get_object_or_404(
19          Tag, slug--iexact=slug)

The get_object_or_404() shortcut expects to have the model class and the desired query passed as arguments and will return the object if it finds one. If not, it raises Http404, just as we had programmed before. Because we are passing in the Tag object and using exactly the same query, the behavior of our shortened code is exactly the same as that of our original code.

Our tag_detail() thus reads as in Example 5.20.

Example 5.20: Project Code

organizer/views.py in 5705e49877

17   def tag_detail(request, slug):
18       tag = get_object_or_404(
19           Tag, slug--iexact=slug)
20       template = loader.get_template(
21           'organizer/tag_detail.html')
22       context = Context({'tag': tag})
23       return HttpResponse(template.render(context))

5.6.2 Shortening Code with render_to_response()

Most views must do the following:

  1. Load a template file as a Template object.
  2. Create a Context from a dictionary.
  3. Render the Template with the Context.
  4. Instantiate an HttpResponse object with the rendered result.

Django supplies not one but two shortcuts to perform this process for us. The first is the render_to_response() shortcut. The shortcut replaces the behavior that we currently have in our views, performing all four tasks listed above. Let’s start by importing it, adding it to the end of our pre-existing shortcut import, as shown in Example 5.21.

Example 5.21: Project Code

organizer/views.py in 5ff3dee4fa

1   from django.shortcuts import (
2       get_object_or_404, render_to_response)

We can now use render_to_response() to shorten our code. In our homepage() view, for instance, we can remove the code shown in Example 5.22.

Example 5.22: Project Code

organizer/views.py in 5705e49877

 7  def homepage(request):
 8      tag_list = Tag.objects.all()
 9      template = loader.get_template(
10          'organizer/tag_list.html')
11      context = Context({'tag_list': tag_list})
12      output = template.render(context)

The code in Example 5.22 is easily replaced with the code in Example 5.23.

Example 5.23: Project Code

organizer/views.py in 5ff3dee4fa

 7   def homepage(request):
 8       return render_to_response(
 9           'organizer/tag_list.html',
10           {'tag_list': Tag.objects.all()})

Observe how we pass in the same path to the template and a simple dictionary with the (identical) values to populate the template. The shortcut does the rest for us: the behaviors in the preceding two code examples are exactly the same.

The process to shorten tag_detail() is exactly the same. We start by removing the code in Example 5.24.

Example 5.24: Project Code

organizer/views.py in 5705e49877

20      template = loader.get_template(
21          'organizer/tag_detail.html')
22      context = Context({'tag': tag})
23      return HttpResponse(template.render(context))

Then, in Example 5.25, we write a call to render_to_response(), passing in the same values seen in the previous code: the same template path and the same dictionary passed to our Context instantiation.

Example 5.25: Project Code

organizer/views.py in 5ff3dee4fa

16     return render_to_response(
17         'organizer/tag_detail.html',
18         {'tag': tag})

Our entire file has been reduced to the code shown in Example 5.26.

Example 5.26: Project Code

organizer/views.py in 5ff3dee4fa

 1   from django.shortcuts import (
 2       get_object_or_404, render_to_response)
 3
 4   from .models import Tag
 5
 6
 7   def homepage(request):
 8       return render_to_response(
 9           'organizer/tag_list.html',
10           {'tag_list': Tag.objects.all()})
11
12
13   def tag_detail(request, slug):
14       tag = get_object_or_404(
15           Tag, slug--iexact=slug)
16       return render_to_response(
17           'organizer/tag_detail.html',
18           {'tag': tag})

The code in Example 5.26 was the original way to shorten code and, while still frequently seen on the Internet and in older projects, is no longer the best way to shorten a simple view. Instead, you’ll want to use render().

5.6.3 Shortening Code with render()

Before introducing the render_to_response() shortcut, our /organizer/views.py read as shown in Example 5.27.

Example 5.27: Project Code

organizer/views.py in 4d36d603db

 1  from django.http.response import HttpResponse
 2  from django.shortcuts import get_object_or_404
 3  from django.template import Context, loader
 4
 5  from .models import Tag
 6
 7
 8  def homepage(request):
 9      tag_list = Tag.objects.all()
10      template = loader.get_template(
11          'organizer/tag_list.html')
12      context = Context({'tag_list': tag_list})
13      output = template.render(context)
14      return HttpResponse(output)
15
16
17  def tag_detail(request, slug):
18      tag = get_object_or_404(
19          Tag, slug--iexact=slug)
20      template = loader.get_template(
21          'organizer/tag_detail.html')
22      context = Context({'tag': tag})
23      return HttpResponse(template.render(context))

Example 5.27 is sufficient for the simple views we are currently building but will prove to be inadequate in the long run. Specifically, we are not using Django context processors.

At the moment, our views are rendering Template instances with Context instances and passing the result to an HttpResponse object. The problem with this approach is that sometimes Django needs to make changes to the values within the Context objects. To enable Django to make changes to data that render a Template, we must use a RequestContext instead of a Context object. When a Template renders with a RequestContext, Django uses the HttpRequest object to add data to the RequestContext, providing information not available to Context. To do so, Django calls the context processors, which are simply functions that are listed in the TEMPLATES options of /suorganizer/settings.py (Example 5.28).

Example 5.28: Project Code

suorganizer/settings.py in 4d36d603db

58  TEMPLATES = [{
 .      ...
64      'OPTIONS': {
65          'context_processors': [
66              'django.template.context_processors.debug',
67              'django.template.context_processors.request',
68              'django.contrib.auth.context_processors.auth',
69              'django.contrib.messages.context_processors.messages',
70          ],
71      },
72  }]

At the moment, enabling context processors is of no use to us, but in Chapter 9, we build views and templates that rely on Django context processors. However, it behooves us to examine them now, as they provide insight into our new shortcut.

To make the change to using context processors, we need only change each use of Context to RequestContext. The only difference is that RequestContext needs the HttpRequest object, as it intends to pass it to all the context processors. We therefore pass request to RequestContext before the dictionary of values. Our code now reads as shown in Example 5.29.

Example 5.29: Project Code

organizer/views.py in c392ab707a

 1  from django.http.response import HttpResponse
 2  from django.shortcuts import get_object_or_404
 3  from django.template import RequestContext, loader
 4
 5  from .models import Tag
 6
 7
 8  def homepage(request):
 9      tag_list = Tag.objects.all()
10      template = loader.get_template(
11          'organizer/tag_list.html')
12      context = RequestContext(
13          request,
14          {'tag_list': tag_list})
15      output = template.render(context)
16      return HttpResponse(output)
17
18
19  def tag_detail(request, slug):
20      tag = get_object_or_404(
21          Tag, slug--iexact=slug)
22      template = loader.get_template(
23          'organizer/tag_detail.html')
24      context = RequestContext(
25          request,
26          {'tag': tag})
27      return HttpResponse(template.render(context))

Understanding and using RequestContext or Context has a direct effect on our choice of shortcuts. Prior to Django 1.3, developers would force the render_to_response() shortcut to use the RequestContext object by coding as shown in Example 5.30.

Example 5.30: Python Code

return render_to_response(
    'path/to/template.html',
    data_dictionary,
    context_instance=RequestContext(request))

Many examples online and older projects continue to use this method. However, starting in Django 1.3 (released March 2011), developers should instead use the render() shortcut, which is identical to render_to_response() except that it uses a RequestContext object instead of a Context object and therefore takes the HttpRequest object as a third argument. Specifically, render() does the following:

  1. Loads a template file as a Template object
  2. Creates a RequestContext from a dictionary (with HttpRequest)
  3. Calls all the context processors in the project, adding or modifying data to the RequestContext
  4. Renders the Template with the RequestContext
  5. Instantiates an HttpResponse object with the rendered result

The render() shortcut thus replaces the project code from Example 5.30, taking three arguments: request, the path to the template file, and the dictionary used to build the RequestContext object. We can follow the same replacement steps used for render_to_response() in the case of render(). Example 5.31 shows the resulting /organizer/views.py.

Example 5.31: Project Code

organizer/views.py in d2ecb7f70d

 1  from django.shortcuts import (
 2      get_object_or_404, render)
 3
 4  from .models import Tag
 5
 6
 7  def homepage(request):
 8      return render(
 9          request,
10          'organizer/tag_list.html',
11          {'tag_list': Tag.objects.all()})
12
13
14  def tag_detail(request, slug):
15      tag = get_object_or_404(
16          Tag, slug--iexact=slug)
17      return render(
18          request,
19          'organizer/tag_detail.html',
20          {'tag': tag})

Using RequestContext is slower than using Context, and therefore render() is slower than render_to_response() (when without the context argument). Nonetheless, most developers now use render() out of the box, choosing to prioritize ease of programming over performance. Using Context or render_to_response(), particularly in young projects with few users, could be considered a pre-optimization, limiting functionality in favor of performance. In addition, context processors are not typically the bottleneck on a website. By the same token, if a context processor is ever needed on a view using Context or render_to_response(), more work will be required to get the context processor working, particularly if the developer is unclear as to where the problem lies. It is therefore not a bad idea to start with RequestContext and render() and replace them if necessary (and if possible!). We reinforce this notion in Chapter 19 when we opt to use variables created by context processors on every webpage.

In keeping with this logic and with current trends, the rest of the book relies on render() as the de facto view shortcut.

As we move forward, please keep in mind that while similar, render_to_response() and render() have very different uses, and many of the examples online should be using render() instead of render_to_response(), making this latter shortcut a common pitfall for beginners when building forms (Chapter 9) or when using the contributed library.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020