Changeset 7754

Timestamp:

06/25/08 23:54:10 (3 months ago)

Author:

adrian

Message:

Fixed #6201 -- Improved the {% cache %} template tag to allow the timeout to be a template variable. Inspired by the patch by zz and edrik

Files:

• django/trunk/django/templatetags/cache.py (modified) (3 diffs)
• django/trunk/docs/cache.txt (modified) (1 diff)
• django/trunk/tests/regressiontests/templates/tests.py (modified) (1 diff)

django/trunk/django/templatetags/cache.py

@@ -1 @@
-
+, Variable, VariableDoesNotExist
-from django.template import resolve_variable
-from django.core.cache import cache
@@ -7 +7 @@
-
-class CacheNode(Node):
-
+_var
-        self.nodelist = nodelist
- = expire_time
+_var = Variable(expire_time_var)
-        self.fragment_name = fragment_name
-        self.vary_on = vary_on
-
-    def render(self, context):
+        try:
+            expire_time = self.expire_time_var.resolve(context)
+        except VariableDoesNotExist:
+            raise TemplateSyntaxError('"cache" tag got an unknkown variable: %r' % self.expire_time_var.var)
+        try:
+            expire_time = int(expire_time)
+        except (ValueError, TypeError):
+            raise TemplateSyntaxError('"cache" tag got a non-integer timeout value: %r' % expire_time)
-        # Build a unicode key for this fragment and all vary-on's.
-
-
+
-        value = cache.get(cache_key)
-        if value is None:
-            value = self.nodelist.render(context)
-self.
+
-        return value
-
@@ -49 +56 @@
-    if len(tokens) < 3:
-        raise TemplateSyntaxError(u"'%r' tag requires at least 2 arguments." % tokens[0])
-
-
-
-
-
+
-
-register.tag('cache', do_cache)

django/trunk/docs/cache.txt

@@ -337 +337 @@
-Simply pass as many arguments to ``{% cache %}`` as you need.
-
+The cache timeout can be a template variable, as long as the template variable
+resolves to an integer value. For example, if the template variable
+``my_timeout`` is set to the value ``600``, then the following two examples are
+equivalent::
+
+    {% cache 600 sidebar %} ... {% endcache %}
+    {% cache my_timeout sidebar %} ... {% endcache %}
+
+This feature is useful in avoiding repetition in templates. You can set the
+timeout in a variable, in one place, and just reuse that value.
+
-The low-level cache API
-=======================

django/trunk/tests/regressiontests/templates/tests.py

@@ -864 +864 @@
-            ### NOW TAG ########################################################
-            # Simple case
- 
+
-
-            # Check parsing of escaped and special characters
- 
- 
- 
+
+
+
-
-            ### URL TAG ########################################################
-            # Successes
-
-
-
-
-
-
+
+
+
+
+
-
-            # Failures
- 
- 
- 
+
+
+
-
-            ### CACHE TAG ######################################################
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-            # Raise exception if we don't have at least 2 args, first one integer.
-
-
-
+
+
+
+
+
-
-            ### AUTOESCAPE TAG ##############################################