Fixed django#13573 -- Corrected problem with template caching when template directories are provided. Thanks to lamby for the report.

freakboy3742 · freakboy3742 · commit 8a6cb3d969b6 · 2010-05-21T08:54:15.000Z
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13295 bcc190cf-cafb-0310-a4f2-bffc1f526a37
diff --git a/django/template/loaders/cached.py b/django/template/loaders/cached.py
@@ -34,19 +34,22 @@ def find_template(self, name, dirs=None):
         raise TemplateDoesNotExist(name)
 
     def load_template(self, template_name, template_dirs=None):
-        if template_name not in self.template_cache:
+        # Use hash(..) to avoid saving potentially large template_dirs values
+        key = hash((template_name, template_dirs))
+
+        if key not in self.template_cache:
             template, origin = self.find_template(template_name, template_dirs)
             if not hasattr(template, 'render'):
                 try:
                     template = get_template_from_string(template, origin, template_name)
                 except TemplateDoesNotExist:
-                    # If compiling the template we found raises TemplateDoesNotExist, 
-                    # back off to returning the source and display name for the template 
-                    # we were asked to load. This allows for correct identification (later) 
+                    # If compiling the template we found raises TemplateDoesNotExist,
+                    # back off to returning the source and display name for the template
+                    # we were asked to load. This allows for correct identification (later)
                     # of the actual template that does not exist.
                     return template, origin
-            self.template_cache[template_name] = template
-        return self.template_cache[template_name], None
+            self.template_cache[key] = template
+        return self.template_cache[key], None
 
     def reset(self):
         "Empty the template cache."
diff --git a/tests/regressiontests/templates/loaders.py b/tests/regressiontests/templates/loaders.py
@@ -16,8 +16,9 @@
 import StringIO
 import os.path
 
-from django.template import TemplateDoesNotExist
+from django.template import TemplateDoesNotExist, Context
 from django.template.loaders.eggs import load_template_source as lts_egg
+from django.template import loader
 
 # Mock classes and objects for pkg_resources functions.
 class MockProvider(pkg_resources.NullProvider):
@@ -89,5 +90,27 @@ def test_not_installed(self):
         settings.INSTALLED_APPS = []
         self.assertRaises(TemplateDoesNotExist, lts_egg, "y.html")
 
+class CachedLoader(unittest.TestCase):
+    def setUp(self):
+        self.old_TEMPLATE_LOADERS = settings.TEMPLATE_LOADERS
+        settings.TEMPLATE_LOADERS = (
+            ('django.template.loaders.cached.Loader', (
+                    'django.template.loaders.filesystem.Loader',
+                )
+            ),
+        )
+    def tearDown(self):
+        settings.TEMPLATE_LOADERS = self.old_TEMPLATE_LOADERS
+
+    def test_templatedir_caching(self):
+        "Check that the template directories form part of the template cache key. Refs #13573"
+        # Retrive a template specifying a template directory to check
+        t1, name = loader.find_template('test.html', (os.path.join(os.path.dirname(__file__), 'templates', 'first'),))
+        # Now retrieve the same template name, but from a different directory
+        t2, name = loader.find_template('test.html', (os.path.join(os.path.dirname(__file__), 'templates', 'second'),))
+
+        # The two templates should not have the same content
+        self.assertNotEqual(t1.render(Context({})), t2.render(Context({})))
+
 if __name__ == "__main__":
     unittest.main()
diff --git a/tests/regressiontests/templates/templates/first/test.html b/tests/regressiontests/templates/templates/first/test.html
@@ -0,0 +1 @@
+First template
diff --git a/tests/regressiontests/templates/templates/second/test.html b/tests/regressiontests/templates/templates/second/test.html
@@ -0,0 +1 @@
+Second template
