From a3894945b647c3e07acdd35af1104739a93938a2 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 5 Jan 2011 22:41:43 +0000 Subject: [PATCH] Fixed #15010 -- Added current_app parameter to close gap between TemplateResponse and render method. Thanks, acdha. git-svn-id: http://code.djangoproject.com/svn/django/trunk@15153 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- AUTHORS | 1 + django/shortcuts/__init__.py | 13 ++++++++++++- django/template/response.py | 7 +++++-- docs/ref/template-response.txt | 7 ++++++- docs/topics/http/shortcuts.txt | 9 +++++++-- tests/regressiontests/templates/response.py | 7 +++++++ tests/regressiontests/views/tests/shortcuts.py | 8 ++++++++ tests/regressiontests/views/urls.py | 3 ++- tests/regressiontests/views/views.py | 14 ++++++++++++++ 9 files changed, 62 insertions(+), 7 deletions(-) diff --git a/AUTHORS b/AUTHORS index d7601ca45a2bc..ffcc34d5dd23c 100644 --- a/AUTHORS +++ b/AUTHORS @@ -33,6 +33,7 @@ people who have submitted patches, reported bugs, added translations, helped answer newbie questions, and generally made Django that much better: Gisle Aas + Chris Adams ajs alang@bright-green.com A S Alam diff --git a/django/shortcuts/__init__.py b/django/shortcuts/__init__.py index b7d69b5b0c10b..9f97cae95541c 100644 --- a/django/shortcuts/__init__.py +++ b/django/shortcuts/__init__.py @@ -29,7 +29,18 @@ def render(request, *args, **kwargs): 'content_type': kwargs.pop('content_type', None), 'status': kwargs.pop('status', None), } - kwargs['context_instance'] = kwargs.get('context_instance', RequestContext(request)) + + if 'context_instance' in kwargs: + context_instance = kwargs.pop('context_instance') + if kwargs.get('current_app', None): + raise ValueError('If you provide a context_instance you must ' + 'set its current_app before calling render()') + else: + current_app = kwargs.pop('current_app', None) + context_instance = RequestContext(request, current_app=current_app) + + kwargs['context_instance'] = context_instance + return HttpResponse(loader.render_to_string(*args, **kwargs), **httpresponse_kwargs) diff --git a/django/template/response.py b/django/template/response.py index d89fee0aab791..629461aa5e948 100644 --- a/django/template/response.py +++ b/django/template/response.py @@ -90,11 +90,14 @@ def _set_content(self, value): class TemplateResponse(SimpleTemplateResponse): def __init__(self, request, template, context=None, mimetype=None, - status=None, content_type=None): + status=None, content_type=None, current_app=None): # self.request gets over-written by django.test.client.Client - and # unlike context_data and template_name the _request should not # be considered part of the public API. self._request = request + # As a convenience we'll allow callers to provide current_app without + # having to avoid needing to create the RequestContext directly + self._current_app = current_app super(TemplateResponse, self).__init__( template, context, mimetype, status, content_type) @@ -105,4 +108,4 @@ def resolve_context(self, context): if isinstance(context, Context): return context else: - return RequestContext(self._request, context) + return RequestContext(self._request, context, current_app=self._current_app) diff --git a/docs/ref/template-response.txt b/docs/ref/template-response.txt index 3b136b68b145d..d4fe2c4ef2c8d 100644 --- a/docs/ref/template-response.txt +++ b/docs/ref/template-response.txt @@ -129,7 +129,7 @@ TemplateResponse objects Methods ------- -.. method:: TemplateResponse.__init__(request, template, context=None, mimetype=None, status=None, content_type=None) +.. method:: TemplateResponse.__init__(request, template, context=None, mimetype=None, status=None, content_type=None, current_app=None) Instantiates an ``TemplateResponse`` object with the given template, context, MIME type and HTTP status. @@ -158,6 +158,11 @@ Methods ``content_type`` is used. If neither is given, :setting:`DEFAULT_CONTENT_TYPE` is used. + ``current_app`` + A hint indicating which application contains the current view. See the + :ref:`namespaced URL resolution strategy ` + for more information. + The rendering process ===================== diff --git a/docs/topics/http/shortcuts.txt b/docs/topics/http/shortcuts.txt index 1c1dc9ef0bb1c..9d72521c0f8ab 100644 --- a/docs/topics/http/shortcuts.txt +++ b/docs/topics/http/shortcuts.txt @@ -15,7 +15,7 @@ introduce controlled coupling for convenience's sake. ``render`` ========== -.. function:: render(request, template[, dictionary][, context_instance][, content_type][, status]) +.. function:: render(request, template[, dictionary][, context_instance][, content_type][, status][, current_app]) .. versionadded:: 1.3 @@ -23,7 +23,7 @@ introduce controlled coupling for convenience's sake. :class:`~django.http.HttpResponse` object with that rendered text. :func:`render()` is the same as a call to - :func:`render_to_response()` with a context_instance argument that + :func:`render_to_response()` with a `context_instance` argument that that forces the use of a :class:`RequestContext`. Required arguments @@ -55,6 +55,11 @@ Optional arguments ``status`` The status code for the response. Defaults to ``200``. +``current_app`` + A hint indicating which application contains the current view. See the + :ref:`namespaced URL resolution strategy ` + for more information. + Example ------- diff --git a/tests/regressiontests/templates/response.py b/tests/regressiontests/templates/response.py index 8bdf7f419659d..2f0d2c7822428 100644 --- a/tests/regressiontests/templates/response.py +++ b/tests/regressiontests/templates/response.py @@ -172,3 +172,10 @@ def test_args(self): 'application/json', 504) self.assertEqual(response['content-type'], 'application/json') self.assertEqual(response.status_code, 504) + + def test_custom_app(self): + response = self._response('{{ foo }}', current_app="foobar") + + rc = response.resolve_context(response.context_data) + + self.assertEqual(rc.current_app, 'foobar') diff --git a/tests/regressiontests/views/tests/shortcuts.py b/tests/regressiontests/views/tests/shortcuts.py index 3f260fee10d40..c5f664e80693d 100644 --- a/tests/regressiontests/views/tests/shortcuts.py +++ b/tests/regressiontests/views/tests/shortcuts.py @@ -38,6 +38,7 @@ def test_render(self): self.assertEquals(response.status_code, 200) self.assertEquals(response.content, 'FOO.BAR../path/to/static/media\n') self.assertEquals(response['Content-Type'], 'text/html; charset=utf-8') + self.assertEquals(response.context.current_app, None) def test_render_with_base_context(self): response = self.client.get('/views/shortcuts/render/base_context/') @@ -56,3 +57,10 @@ def test_render_with_status(self): self.assertEquals(response.status_code, 403) self.assertEquals(response.content, 'FOO.BAR../path/to/static/media\n') + def test_render_with_current_app(self): + response = self.client.get('/views/shortcuts/render/current_app/') + self.assertEquals(response.context.current_app, "foobar_app") + + def test_render_with_current_app_conflict(self): + self.assertRaises(ValueError, self.client.get, '/views/shortcuts/render/current_app_conflict/') + diff --git a/tests/regressiontests/views/urls.py b/tests/regressiontests/views/urls.py index 7cba5f647d855..a170efb1fc3d0 100644 --- a/tests/regressiontests/views/urls.py +++ b/tests/regressiontests/views/urls.py @@ -151,7 +151,8 @@ (r'^shortcuts/render/base_context/$', 'render_view_with_base_context'), (r'^shortcuts/render/content_type/$', 'render_view_with_content_type'), (r'^shortcuts/render/status/$', 'render_view_with_status'), - + (r'^shortcuts/render/current_app/$', 'render_view_with_current_app'), + (r'^shortcuts/render/current_app_conflict/$', 'render_view_with_current_app_conflict'), ) # simple generic views. diff --git a/tests/regressiontests/views/views.py b/tests/regressiontests/views/views.py index ec017bd7fd82e..e4e7c3d4e4edb 100644 --- a/tests/regressiontests/views/views.py +++ b/tests/regressiontests/views/views.py @@ -101,3 +101,17 @@ def render_view_with_status(request): 'foo': 'FOO', 'bar': 'BAR', }, status=403) + +def render_view_with_current_app(request): + return render(request, 'debug/render_test.html', { + 'foo': 'FOO', + 'bar': 'BAR', + }, current_app="foobar_app") + +def render_view_with_current_app_conflict(request): + # This should fail because we don't passing both a current_app and + # context_instance: + return render(request, 'debug/render_test.html', { + 'foo': 'FOO', + 'bar': 'BAR', + }, current_app="foobar_app", context_instance=RequestContext(request))