Deprecated some arguments of django.shortcuts.render(_to_response).

dictionary and context_instance and superseded by context.

Refactored tests that relied context_instance with more modern idioms.

Author: aaugustin

django/contrib/auth/tests/test_context_processors.py

@@ -65,6 +65,10 @@ def test_permlookupdict_in(self):
     TEMPLATE_DIRS=(
         os.path.join(os.path.dirname(upath(__file__)), 'templates'),
     ),
+    TEMPLATE_CONTEXT_PROCESSORS=(
+        'django.contrib.auth.context_processors.auth',
+        'django.contrib.messages.context_processors.messages'
+    ),
     ROOT_URLCONF='django.contrib.auth.tests.urls',
     USE_TZ=False,                           # required for loading the fixture
     PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',),
@@ -80,9 +84,6 @@ class AuthContextProcessorTests(TestCase):
             'django.contrib.sessions.middleware.SessionMiddleware',
             'django.contrib.auth.middleware.AuthenticationMiddleware',
         ),
-        TEMPLATE_CONTEXT_PROCESSORS=(
-            'django.contrib.auth.context_processors.auth',
-        ),
     )
     def test_session_not_accessed(self):
         """
@@ -97,9 +98,6 @@ def test_session_not_accessed(self):
             'django.contrib.sessions.middleware.SessionMiddleware',
             'django.contrib.auth.middleware.AuthenticationMiddleware',
         ),
-        TEMPLATE_CONTEXT_PROCESSORS=(
-            'django.contrib.auth.context_processors.auth',
-        ),
     )
     def test_session_is_accessed(self):
         """

django/contrib/auth/tests/urls.py

@@ -1,13 +1,12 @@
 from django.conf.urls import url, include
 from django.contrib import admin
-from django.contrib.auth import context_processors
 from django.contrib.auth.forms import AuthenticationForm
 from django.contrib.auth.urls import urlpatterns
 from django.contrib.auth import views
 from django.contrib.auth.decorators import login_required
 from django.contrib.messages.api import info
 from django.http import HttpResponse, HttpRequest
-from django.shortcuts import render_to_response
+from django.shortcuts import render
 from django.template import Template, RequestContext
 from django.views.decorators.cache import never_cache
 
@@ -27,39 +26,35 @@ def remote_user_auth_view(request):
 
 
 def auth_processor_no_attr_access(request):
-    render_to_response('context_processors/auth_attrs_no_access.html',
-        context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
+    render(request, 'context_processors/auth_attrs_no_access.html')
     # *After* rendering, we check whether the session was accessed
-    return render_to_response('context_processors/auth_attrs_test_access.html',
-        {'session_accessed': request.session.accessed})
+    return render(request,
+                  'context_processors/auth_attrs_test_access.html',
+                  {'session_accessed': request.session.accessed})
 
 
 def auth_processor_attr_access(request):
-    render_to_response('context_processors/auth_attrs_access.html',
-        context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
-    return render_to_response('context_processors/auth_attrs_test_access.html',
-        {'session_accessed': request.session.accessed})
+    render(request, 'context_processors/auth_attrs_access.html')
+    return render(request,
+                  'context_processors/auth_attrs_test_access.html',
+                  {'session_accessed': request.session.accessed})
 
 
 def auth_processor_user(request):
-    return render_to_response('context_processors/auth_attrs_user.html',
-        context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
+    return render(request, 'context_processors/auth_attrs_user.html')
 
 
 def auth_processor_perms(request):
-    return render_to_response('context_processors/auth_attrs_perms.html',
-        context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
+    return render(request, 'context_processors/auth_attrs_perms.html')
 
 
 def auth_processor_perm_in_perms(request):
-    return render_to_response('context_processors/auth_attrs_perm_in_perms.html',
-        context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
+    return render(request, 'context_processors/auth_attrs_perm_in_perms.html')
 
 
 def auth_processor_messages(request):
     info(request, "Message 1")
-    return render_to_response('context_processors/auth_attrs_messages.html',
-         context_instance=RequestContext(request, {}, processors=[context_processors.auth]))
+    return render(request, 'context_processors/auth_attrs_messages.html')
 
 
 def userpage(request):

django/contrib/gis/admin/widgets.py

@@ -1,7 +1,7 @@
 import logging
 
 from django.forms.widgets import Textarea
-from django.template import loader, Context
+from django.template import loader
 from django.utils import six
 from django.utils import translation
 
@@ -10,7 +10,7 @@
 
 # Creating a template context that contains Django settings
 # values needed by admin map templates.
-geo_context = Context({'LANGUAGE_BIDI': translation.get_language_bidi()})
+geo_context = {'LANGUAGE_BIDI': translation.get_language_bidi()}
 logger = logging.getLogger('django.contrib.gis')
 
 
@@ -81,8 +81,8 @@ def render(self, name, value, attrs=None):
             # geometry.
             self.params['wkt'] = wkt
 
-        return loader.render_to_string(self.template, self.params,
-                                       context_instance=geo_context)
+        self.params.update(geo_context)
+        return loader.render_to_string(self.template, self.params)
 
     def map_options(self):
         "Builds the map options hash for the OpenLayers template."

django/shortcuts.py

@@ -3,8 +3,6 @@
 of MVC. In other words, these functions/classes introduce controlled coupling
 for convenience's sake.
 """
-import warnings
-
 from django.template import loader, RequestContext
 from django.template.context import _current_app_undefined
 from django.template.engine import (
@@ -16,44 +14,57 @@
 from django.db.models.query import QuerySet
 from django.core import urlresolvers
 from django.utils import six
-from django.utils.deprecation import RemovedInDjango20Warning
 
 
-def render_to_response(template_name, dictionary=_dictionary_undefined,
+def render_to_response(template_name, context=None,
                        context_instance=_context_instance_undefined,
-                       content_type=None, dirs=_dirs_undefined):
+                       content_type=None, status=None, dirs=_dirs_undefined,
+                       dictionary=_dictionary_undefined):
     """
     Returns a HttpResponse whose content is filled with the result of calling
     django.template.loader.render_to_string() with the passed arguments.
     """
-    # TODO: refactor to avoid the deprecated code path.
-    with warnings.catch_warnings():
-        warnings.filterwarnings("ignore", category=RemovedInDjango20Warning)
-        content = loader.render_to_string(template_name, dictionary, context_instance, dirs)
+    if (context_instance is _context_instance_undefined
+            and dirs is _dirs_undefined
+            and dictionary is _dictionary_undefined):
+        # No deprecated arguments were passed - use the new code path
+        content = loader.get_template(template_name).render(context)
+
+    else:
+        # Some deprecated arguments were passed - use the legacy code path
+        content = loader.render_to_string(
+            template_name, context, context_instance, dirs, dictionary)
 
-    return HttpResponse(content, content_type)
+    return HttpResponse(content, content_type, status)
 
 
-def render(request, template_name, dictionary=_dictionary_undefined,
+def render(request, template_name, context=None,
            context_instance=_context_instance_undefined,
            content_type=None, status=None, current_app=_current_app_undefined,
-           dirs=_dirs_undefined):
+           dirs=_dirs_undefined, dictionary=_dictionary_undefined):
     """
     Returns a HttpResponse whose content is filled with the result of calling
     django.template.loader.render_to_string() with the passed arguments.
     Uses a RequestContext by default.
     """
-    if context_instance is not _context_instance_undefined:
-        if current_app is not _current_app_undefined:
-            raise ValueError('If you provide a context_instance you must '
-                             'set its current_app before calling render()')
+    if (context_instance is _context_instance_undefined
+            and current_app is _current_app_undefined
+            and dirs is _dirs_undefined
+            and dictionary is _dictionary_undefined):
+        # No deprecated arguments were passed - use the new code path
+        content = loader.get_template(template_name).render(context, request)
+
     else:
-        context_instance = RequestContext(request, current_app=current_app)
+        # Some deprecated arguments were passed - use the legacy code path
+        if context_instance is not _context_instance_undefined:
+            if current_app is not _current_app_undefined:
+                raise ValueError('If you provide a context_instance you must '
+                                 'set its current_app before calling render()')
+        else:
+            context_instance = RequestContext(request, current_app=current_app)
 
-    # TODO: refactor to avoid the deprecated code path.
-    with warnings.catch_warnings():
-        warnings.filterwarnings("ignore", category=RemovedInDjango20Warning)
-        content = loader.render_to_string(template_name, dictionary, context_instance, dirs)
+        content = loader.render_to_string(
+            template_name, context, context_instance, dirs, dictionary)
 
     return HttpResponse(content, content_type, status)
 

docs/internals/deprecation.txt

@@ -93,6 +93,8 @@ details on these changes.
 * The ``dictionary`` and ``context_instance`` parameters for the following
   functions will be removed:
 
+  * ``django.shortcuts.render()``
+  * ``django.shortcuts.render_to_response()``
   * ``django.template.loader.render_to_string()``
 
 * The ``dirs`` parameter for the following functions will be removed:

docs/ref/contrib/admin/admindocs.txt

@@ -95,6 +95,8 @@ you can document in your view function docstrings include:
 
 For example::
 
+    from django.shortcuts import render
+
     from myapp.models import MyModel
 
     def my_view(request, slug):
@@ -103,8 +105,6 @@ For example::
 
         **Context**
 
-        ``RequestContext``
-
         ``mymodel``
             An instance of :model:`myapp.MyModel`.
 
@@ -113,10 +113,8 @@ For example::
         :template:`myapp/my_template.html`
 
         """
-        return render_to_response('myapp/my_template.html', {
-            'mymodel': MyModel.objects.get(slug=slug)
-        }, context_instance=RequestContext(request))
-
+        context = {'mymodel': MyModel.objects.get(slug=slug)}
+        return render(request, 'myapp/my_template.html', context)
 
 Template tags and filters reference
 ===================================

docs/releases/1.8.txt

@@ -1210,6 +1210,8 @@ now optional.
 The following functions will no longer accept the ``dictionary`` and
 ``context_instance`` parameters in Django 2.0:
 
+* ``django.shortcuts.render()``
+* ``django.shortcuts.render_to_response()``
 * ``django.template.loader.render_to_string()``
 
 Use the ``context`` parameter instead. When ``dictionary`` is passed as a

docs/topics/http/shortcuts.txt

@@ -15,7 +15,7 @@ introduce controlled coupling for convenience's sake.
 ``render``
 ==========
 
-.. function:: render(request, template_name[, dictionary][, context_instance][, content_type][, status][, current_app][, dirs])
+.. function:: render(request, template_name[, context][, context_instance][, content_type][, status][, current_app][, dirs])
 
    Combines a given template with a given context dictionary and returns an
    :class:`~django.http.HttpResponse` object with that rendered text.
@@ -41,15 +41,24 @@ Required arguments
 Optional arguments
 ------------------
 
-``dictionary``
+``context``
     A dictionary of values to add to the template context. By default, this
     is an empty dictionary. If a value in the dictionary is callable, the
     view will call it just before rendering the template.
 
+    .. versionchanged:: 1.8
+
+       The ``context`` argument used to be called ``dictionary``. That name
+       is deprecated in Django 1.8 and will be removed in Django 2.0.
+
 ``context_instance``
     The context instance to render the template with. By default, the template
     will be rendered with a ``RequestContext`` instance (filled with values from
-    ``request`` and ``dictionary``).
+    ``request`` and ``context``).
+
+    .. deprecated:: 1.8
+
+       The ``context_instance`` argument is deprecated. Simply use ``context``.
 
 ``content_type``
     The MIME type to use for the resulting document. Defaults to the value of
@@ -67,7 +76,7 @@ Optional arguments
 
    The ``dirs`` parameter was added.
 
-.. versionchanged:: 1.8
+.. deprecated:: 1.8
 
    The ``dirs`` parameter was deprecated.
 
@@ -99,7 +108,7 @@ This example is equivalent to::
 ``render_to_response``
 ======================
 
-.. function:: render_to_response(template_name[, dictionary][, context_instance][, content_type][, dirs])
+.. function:: render_to_response(template_name[, context][, context_instance][, content_type][, status][, dirs])
 
    Renders a given template with a given context dictionary and returns an
    :class:`~django.http.HttpResponse` object with that rendered text.
@@ -116,32 +125,48 @@ Required arguments
 Optional arguments
 ------------------
 
-``dictionary``
+``context``
     A dictionary of values to add to the template context. By default, this
     is an empty dictionary. If a value in the dictionary is callable, the
     view will call it just before rendering the template.
 
+    .. versionchanged:: 1.8
+
+       The ``context`` argument used to be called ``dictionary``. That name
+       is deprecated in Django 1.8 and will be removed in Django 2.0.
+
 ``context_instance``
     The context instance to render the template with. By default, the template
     will be rendered with a :class:`~django.template.Context` instance (filled
-    with values from ``dictionary``). If you need to use :ref:`context
+    with values from ``context``). If you need to use :ref:`context
     processors <subclassing-context-requestcontext>`, render the template with
     a :class:`~django.template.RequestContext` instance instead. Your code
     might look something like this::
 
         return render_to_response('my_template.html',
-                                  my_data_dictionary,
+                                  my_context,
                                   context_instance=RequestContext(request))
 
+    .. deprecated:: 1.8
+
+       The ``context_instance`` argument is deprecated. Simply use ``context``.
+
 ``content_type``
     The MIME type to use for the resulting document. Defaults to the value of
     the :setting:`DEFAULT_CONTENT_TYPE` setting.
 
+``status``
+    The status code for the response. Defaults to ``200``.
+
+.. versionchanged:: 1.8
+
+   The ``status`` parameter was added.
+
 .. versionchanged:: 1.7
 
    The ``dirs`` parameter was added.
 
-.. versionchanged:: 1.8
+.. deprecated:: 1.8
 
    The ``dirs`` parameter was deprecated.
 

tests/context_processors/tests.py

@@ -4,7 +4,10 @@
 from django.test import TestCase, override_settings
 
 
-@override_settings(ROOT_URLCONF='context_processors.urls')
+@override_settings(
+    ROOT_URLCONF='context_processors.urls',
+    TEMPLATE_CONTEXT_PROCESSORS=('django.template.context_processors.request',),
+)
 class RequestContextProcessorTests(TestCase):
     """
     Tests for the ``django.template.context_processors.request`` processor.
@@ -35,7 +38,12 @@ def test_request_attributes(self):
         self.assertContains(response, url)
 
 
-@override_settings(ROOT_URLCONF='context_processors.urls', DEBUG=True, INTERNAL_IPS=('127.0.0.1',))
+@override_settings(
+    DEBUG=True,
+    INTERNAL_IPS=('127.0.0.1',),
+    ROOT_URLCONF='context_processors.urls',
+    TEMPLATE_CONTEXT_PROCESSORS=('django.template.context_processors.debug',),
+)
 class DebugContextProcessorTests(TestCase):
     """
     Tests for the ``django.template.context_processors.debug`` processor.