Consistently return TemplateResponse for view/page rendering instead …

…of using the render() shortcut

wagtail/admin/views/account.py

@@ -4,7 +4,8 @@
 from django.contrib.auth import update_session_auth_hash
 from django.contrib.auth.forms import PasswordChangeForm
 from django.http import Http404
-from django.shortcuts import redirect, render
+from django.shortcuts import redirect
+from django.template.response import TemplateResponse
 from django.urls import reverse, reverse_lazy
 from django.utils.translation import ugettext as _
 from django.utils.translation import activate
@@ -47,7 +48,7 @@ def account(request):
         if item:
             items.append(item)
 
-    return render(request, 'wagtailadmin/account/account.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/account.html', {
         'items': items,
     })
 
@@ -73,7 +74,7 @@ def change_password(request):
     else:
         form = None
 
-    return render(request, 'wagtailadmin/account/change_password.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/change_password.html', {
         'form': form,
         'can_change_password': can_change_password,
     })
@@ -90,7 +91,7 @@ def change_email(request):
     else:
         form = EmailForm(instance=request.user)
 
-    return render(request, 'wagtailadmin/account/change_email.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/change_email.html', {
         'form': form,
     })
 
@@ -145,7 +146,7 @@ def notification_preferences(request):
     if not form.fields:
         return redirect('wagtailadmin_account')
 
-    return render(request, 'wagtailadmin/account/notification_preferences.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/notification_preferences.html', {
         'form': form,
     })
 
@@ -164,7 +165,7 @@ def language_preferences(request):
     else:
         form = PreferredLanguageForm(instance=UserProfile.get_for_user(request.user))
 
-    return render(request, 'wagtailadmin/account/language_preferences.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/language_preferences.html', {
         'form': form,
     })
 
@@ -180,7 +181,7 @@ def current_time_zone(request):
     else:
         form = CurrentTimeZoneForm(instance=UserProfile.get_for_user(request.user))
 
-    return render(request, 'wagtailadmin/account/current_time_zone.html', {
+    return TemplateResponse(request, 'wagtailadmin/account/current_time_zone.html', {
         'form': form,
     })
 
@@ -196,7 +197,7 @@ def change_avatar(request):
     else:
         form = AvatarPreferencesForm(instance=UserProfile.get_for_user(request.user))
 
-    return render(request, 'wagtailadmin/account/change_avatar.html', {'form': form})
+    return TemplateResponse(request, 'wagtailadmin/account/change_avatar.html', {'form': form})
 
 
 class LoginView(auth_views.LoginView):

wagtail/admin/views/chooser.py

@@ -1,6 +1,7 @@
 from django.core.paginator import Paginator
 from django.http import Http404
-from django.shortcuts import get_object_or_404, render
+from django.shortcuts import get_object_or_404
+from django.template.response import TemplateResponse
 
 from wagtail.admin.forms.choosers import EmailLinkChooserForm, ExternalLinkChooserForm
 from wagtail.admin.forms.search import SearchForm
@@ -175,7 +176,7 @@ def search(request, parent_page_id=None):
     for page in pages:
         page.can_choose = True
 
-    return render(
+    return TemplateResponse(
         request, 'wagtailadmin/chooser/_search_results.html',
         shared_context(request, {
             'searchform': search_form,

wagtail/admin/views/home.py

@@ -4,8 +4,8 @@
 from django.db import connection
 from django.db.models import Max
 from django.http import Http404
-from django.shortcuts import render
 from django.template.loader import render_to_string
+from django.template.response import TemplateResponse
 
 from wagtail.admin.site_summary import SiteSummaryPanel
 from wagtail.admin.utils import get_site_for_user
@@ -103,7 +103,7 @@ def home(request):
 
     site_details = get_site_for_user(request.user)
 
-    return render(request, "wagtailadmin/home.html", {
+    return TemplateResponse(request, "wagtailadmin/home.html", {
         'root_page': site_details['root_page'],
         'root_site': site_details['root_site'],
         'site_name': site_details['site_name'],

wagtail/admin/views/pages.py

@@ -7,8 +7,9 @@
 from django.db.models import Count
 from django.http import Http404, HttpResponse, JsonResponse
 from django.http.request import QueryDict
-from django.shortcuts import get_object_or_404, redirect, render
+from django.shortcuts import get_object_or_404, redirect
 from django.template.loader import render_to_string
+from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.http import is_safe_url, urlquote
@@ -120,7 +121,7 @@ def index(request, parent_page_id=None):
         paginator = Paginator(pages, per_page=50)
         pages = paginator.get_page(request.GET.get('p'))
 
-    return render(request, 'wagtailadmin/pages/index.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/index.html', {
         'parent_page': parent_page.specific,
         'ordering': ordering,
         'pagination_query_params': "ordering=%s" % ordering,
@@ -148,7 +149,7 @@ def add_subpage(request, parent_page_id):
         verbose_name, app_label, model_name = page_types[0]
         return redirect('wagtailadmin_pages:add', app_label, model_name, parent_page.id)
 
-    return render(request, 'wagtailadmin/pages/add_subpage.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/add_subpage.html', {
         'parent_page': parent_page,
         'page_types': page_types,
         'next': get_valid_next_url_from_request(request),
@@ -172,7 +173,7 @@ def content_type_use(request, content_type_app_name, content_type_model_name):
     paginator = Paginator(pages, per_page=10)
     pages = paginator.get_page(request.GET.get('p'))
 
-    return render(request, 'wagtailadmin/pages/content_type_use.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/content_type_use.html', {
         'pages': pages,
         'app_name': content_type_app_name,
         'content_type': content_type,
@@ -686,7 +687,7 @@ def delete(request, page_id):
                 return redirect(next_url)
             return redirect('wagtailadmin_explore', parent_id)
 
-    return render(request, 'wagtailadmin/pages/confirm_delete.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/confirm_delete.html', {
         'page': page,
         'uses': uses,
         'descendant_count': page.get_descendant_count(),
@@ -742,7 +743,7 @@ def post(self, request, *args, **kwargs):
         return JsonResponse({'is_valid': form.is_valid()})
 
     def error_response(self, page):
-        return render(self.request, 'wagtailadmin/pages/preview_error.html',
+        return TemplateResponse(self.request, 'wagtailadmin/pages/preview_error.html',
                       {'page': page})
 
     def get(self, request, *args, **kwargs):
@@ -826,7 +827,7 @@ def unpublish(request, page_id):
             return redirect(next_url)
         return redirect('wagtailadmin_explore', page.get_parent().id)
 
-    return render(request, 'wagtailadmin/pages/confirm_unpublish.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/confirm_unpublish.html', {
         'page': page,
         'next': next_url,
         'live_descendant_count': page.get_descendants().live().count(),
@@ -863,7 +864,7 @@ def move_choose_destination(request, page_to_move_id, viewed_page_id=None):
     paginator = Paginator(child_pages, per_page=50)
     child_pages = paginator.get_page(request.GET.get('p'))
 
-    return render(request, 'wagtailadmin/pages/move_choose_destination.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/move_choose_destination.html', {
         'page_to_move': page_to_move,
         'viewed_page': viewed_page,
         'child_pages': child_pages,
@@ -904,7 +905,7 @@ def move_confirm(request, page_to_move_id, destination_id):
 
         return redirect('wagtailadmin_explore', destination.id)
 
-    return render(request, 'wagtailadmin/pages/confirm_move.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/confirm_move.html', {
         'page_to_move': page_to_move,
         'destination': destination,
     })
@@ -1018,7 +1019,7 @@ def copy(request, page_id):
                 return redirect(next_url)
             return redirect('wagtailadmin_explore', parent_page.id)
 
-    return render(request, 'wagtailadmin/pages/copy.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/copy.html', {
         'page': page,
         'form': form,
         'next': next_url,
@@ -1089,7 +1090,7 @@ def search(request):
     pages = paginator.get_page(request.GET.get('p'))
 
     if request.is_ajax():
-        return render(request, "wagtailadmin/pages/search_results.html", {
+        return TemplateResponse(request, "wagtailadmin/pages/search_results.html", {
             'pages': pages,
             'all_pages': all_pages,
             'query_string': q,
@@ -1099,7 +1100,7 @@ def search(request):
             'pagination_query_params': pagination_query_params.urlencode(),
         })
     else:
-        return render(request, "wagtailadmin/pages/search.html", {
+        return TemplateResponse(request, "wagtailadmin/pages/search.html", {
             'search_form': form,
             'pages': pages,
             'all_pages': all_pages,
@@ -1237,7 +1238,7 @@ def revisions_index(request, page_id):
     paginator = Paginator(revisions, per_page=20)
     revisions = paginator.get_page(request.GET.get('p'))
 
-    return render(request, 'wagtailadmin/pages/revisions/index.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/revisions/index.html', {
         'page': page,
         'ordering': ordering,
         'pagination_query_params': "ordering=%s" % ordering,
@@ -1274,7 +1275,7 @@ def revisions_revert(request, page_id, revision_id):
         }
     ))
 
-    return render(request, 'wagtailadmin/pages/edit.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/edit.html', {
         'page': page,
         'revision': revision,
         'is_revision': True,
@@ -1339,7 +1340,7 @@ def revisions_compare(request, page_id, revision_id_a, revision_id_b):
     comparison = [comp(revision_a, revision_b) for comp in comparison]
     comparison = [comp for comp in comparison if comp.has_changed()]
 
-    return render(request, 'wagtailadmin/pages/revisions/compare.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/revisions/compare.html', {
         'page': page,
         'revision_a_heading': revision_a_heading,
         'revision_a': revision_a,
@@ -1374,7 +1375,7 @@ def revisions_unschedule(request, page_id, revision_id):
             return redirect(next_url)
         return redirect('wagtailadmin_pages:revisions_index', page.id)
 
-    return render(request, 'wagtailadmin/pages/revisions/confirm_unschedule.html', {
+    return TemplateResponse(request, 'wagtailadmin/pages/revisions/confirm_unschedule.html', {
         'page': page,
         'revision': revision,
         'next': next_url,

wagtail/contrib/forms/models.py

@@ -3,7 +3,7 @@
 
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
-from django.shortcuts import render
+from django.template.response import TemplateResponse
 from django.utils.text import slugify
 from django.utils.translation import ugettext_lazy as _
 from unidecode import unidecode
@@ -210,7 +210,7 @@ def render_landing_page(self, request, form_submission=None, *args, **kwargs):
         """
         context = self.get_context(request)
         context['form_submission'] = form_submission
-        return render(
+        return TemplateResponse(
             request,
             self.get_landing_page_template(request),
             context
@@ -238,7 +238,7 @@ def serve(self, request, *args, **kwargs):
 
         context = self.get_context(request)
         context['form'] = form
-        return render(
+        return TemplateResponse(
             request,
             self.get_template(request),
             context

wagtail/contrib/redirects/views.py

@@ -1,6 +1,7 @@
 from django.core.paginator import Paginator
 from django.db.models import Q
-from django.shortcuts import get_object_or_404, redirect, render
+from django.shortcuts import get_object_or_404, redirect
+from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.translation import ugettext as _
 from django.views.decorators.vary import vary_on_headers
@@ -42,13 +43,13 @@ def index(request):
 
     # Render template
     if request.is_ajax():
-        return render(request, "wagtailredirects/results.html", {
+        return TemplateResponse(request, "wagtailredirects/results.html", {
             'ordering': ordering,
             'redirects': redirects,
             'query_string': query_string,
         })
     else:
-        return render(request, "wagtailredirects/index.html", {
+        return TemplateResponse(request, "wagtailredirects/index.html", {
             'ordering': ordering,
             'redirects': redirects,
             'query_string': query_string,
@@ -81,7 +82,7 @@ def edit(request, redirect_id):
     else:
         form = RedirectForm(instance=theredirect)
 
-    return render(request, "wagtailredirects/edit.html", {
+    return TemplateResponse(request, "wagtailredirects/edit.html", {
         'redirect': theredirect,
         'form': form,
         'user_can_delete': permission_policy.user_has_permission(request.user, 'delete'),
@@ -104,7 +105,7 @@ def delete(request, redirect_id):
         messages.success(request, _("Redirect '{0}' deleted.").format(theredirect.title))
         return redirect('wagtailredirects:index')
 
-    return render(request, "wagtailredirects/confirm_delete.html", {
+    return TemplateResponse(request, "wagtailredirects/confirm_delete.html", {
         'redirect': theredirect,
         'uses': uses,
     })
@@ -126,6 +127,6 @@ def add(request):
     else:
         form = RedirectForm()
 
-    return render(request, "wagtailredirects/add.html", {
+    return TemplateResponse(request, "wagtailredirects/add.html", {
         'form': form,
     })

wagtail/contrib/search_promotions/views.py

@@ -1,5 +1,6 @@
 from django.core.paginator import Paginator
-from django.shortcuts import get_object_or_404, redirect, render
+from django.shortcuts import get_object_or_404, redirect
+from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.translation import ugettext as _
 from django.views.decorators.vary import vary_on_headers
@@ -34,13 +35,13 @@ def index(request):
     queries = paginator.get_page(request.GET.get('p'))
 
     if request.is_ajax():
-        return render(request, "wagtailsearchpromotions/results.html", {
+        return TemplateResponse(request, "wagtailsearchpromotions/results.html", {
             'is_searching': is_searching,
             'queries': queries,
             'query_string': query_string,
         })
     else:
-        return render(request, 'wagtailsearchpromotions/index.html', {
+        return TemplateResponse(request, 'wagtailsearchpromotions/index.html', {
             'is_searching': is_searching,
             'queries': queries,
             'query_string': query_string,
@@ -99,7 +100,7 @@ def add(request):
         query_form = search_forms.QueryForm()
         searchpicks_formset = forms.SearchPromotionsFormSet()
 
-    return render(request, 'wagtailsearchpromotions/add.html', {
+    return TemplateResponse(request, 'wagtailsearchpromotions/add.html', {
         'query_form': query_form,
         'searchpicks_formset': searchpicks_formset,
         'form_media': query_form.media + searchpicks_formset.media,
@@ -137,7 +138,7 @@ def edit(request, query_id):
         query_form = search_forms.QueryForm(initial=dict(query_string=query.query_string))
         searchpicks_formset = forms.SearchPromotionsFormSet(instance=query)
 
-    return render(request, 'wagtailsearchpromotions/edit.html', {
+    return TemplateResponse(request, 'wagtailsearchpromotions/edit.html', {
         'query_form': query_form,
         'searchpicks_formset': searchpicks_formset,
         'query': query,
@@ -156,7 +157,7 @@ def delete(request, query_id):
         messages.success(request, _("Editor's picks deleted."))
         return redirect('wagtailsearchpromotions:index')
 
-    return render(request, 'wagtailsearchpromotions/confirm_delete.html', {
+    return TemplateResponse(request, 'wagtailsearchpromotions/confirm_delete.html', {
         'query': query,
         'uses': uses,
     })