1
=== modified file 'lib/lp/services/memcache/doc/tales-cache.txt'
2
--- lib/lp/services/memcache/doc/tales-cache.txt	2010-06-09 16:10:42 +0000
3
+++ lib/lp/services/memcache/doc/tales-cache.txt	2010-06-22 12:30:52 +0000
4
@@ -79,6 +79,38 @@
5
79
    This bit cached up to 3 days.
79
    This bit cached up to 3 days.
6
80
80
7
81
81
8
82
The unit defaults to 'seconds' if not specified.
9
83
10
84
    >>> template = TestPageTemplate(dedent("""\
11
85
    ...     <body tal:omit-tag="">
12
86
    ...         <div tal:content="cache:public,30" tal:omit-tag="">
13
87
    ...             This bit cached up to 30 seconds.
14
88
    ...         </div>
15
89
    ...     </body>"""))
16
90
    >>> print template()
17
91
    This bit cached up to 30 seconds.
18
92
19
93
20
94
A path expression can be used to dynamically calculate the cache time.
21
95
22
96
    >>> template = TestPageTemplate(dedent("""\
23
97
    ...     <body tal:omit-tag="">
24
98
    ...         <div tal:content="cache:public,dynamic_time"
25
99
    ...             tal:omit-tag=""> This bit cached up to <span
26
100
    ...                 tal:content="dynamic_time"
27
101
    ...                 tal:omit-tag="">n</span> seconds.
28
102
    ...         </div>
29
103
    ...         <div tal:content="cache:public,dynamic_time hours"
30
104
    ...             tal:omit-tag=""> This bit cached up to <span
31
105
    ...                 tal:content="dynamic_time"
32
106
    ...                 tal:omit-tag="">n</span> hours.
33
107
    ...         </div>
34
108
    ...     </body>"""))
35
109
    >>> print template(dynamic_time=30)
36
110
    This bit cached up to 30 seconds.
37
111
    This bit cached up to 30 hours.
38
112
39
113
40
82
Visibility
114
Visibility
41
83
----------
115
----------
42
84
116
43
85
117
44
=== modified file 'lib/lp/services/memcache/tales.py'
45
--- lib/lp/services/memcache/tales.py	2010-06-09 16:10:42 +0000
46
+++ lib/lp/services/memcache/tales.py	2010-06-22 12:30:52 +0000
47
@@ -43,6 +43,11 @@
48
43
    </div>
43
    </div>
49
44
    """
44
    """
50
45
    implements(ITALESExpression)
45
    implements(ITALESExpression)
51
46
52
47
    static_max_age = None # cache expiry if fixed
53
48
    dynamic_max_age = None # callable if cache expiry is dynamic.
54
49
    dynamic_max_age_unit = None # Multiplier for dynamic cache expiry result.
55
50
56
46
    def __init__(self, name, expr, engine, traverser=simpleTraverse):
51
    def __init__(self, name, expr, engine, traverser=simpleTraverse):
57
47
        """expr is in the format "visibility, 42 units".
52
        """expr is in the format "visibility, 42 units".
58
48
53
59
@@ -101,28 +106,35 @@
60
101
106
61
102
        # Convert the max_age string to an integer number of seconds.
107
        # Convert the max_age string to an integer number of seconds.
62
103
        if max_age is None:
108
        if max_age is None:
64
104
            self.max_age = 0
109
            self.static_max_age = 0 # Never expire.
65
105
        else:
110
        else:
66
111
            # Extract the unit, if there is one. Unit defaults to seconds.
67
106
            try:
112
            try:
68
107
                value, unit = max_age.split(' ')
113
                value, unit = max_age.split(' ')
69
114
                if unit[-1] == 's':
70
115
                    unit = unit[:-1]
71
116
                if unit == 'second':
72
117
                    unit = 1
73
118
                elif unit == 'minute':
74
119
                    unit = 60
75
120
                elif unit == 'hour':
76
121
                    unit = 60 * 60
77
122
                elif unit == 'day':
78
123
                    unit = 24 * 60 * 60
79
124
                else:
80
125
                    raise SyntaxError(
81
126
                        "Unknown unit %s in cache: expression %s"
82
127
                        % (repr(unit), repr(expr)))
83
108
            except ValueError:
128
            except ValueError:
101
109
                raise SyntaxError(
129
                value = max_age
102
110
                    "Unparsable age %s in cache: expression"
130
                unit = 1
103
111
                    % repr(self.max_age))
131
104
112
            value = float(value)
132
            try:
105
113
            if unit[-1] == 's':
133
                self.static_max_age = float(value) * unit
106
114
                unit = unit[:-1]
134
            except (ValueError, TypeError):
107
115
            if unit == 'second':
135
                self.dynamic_max_age = PathExpr(
108
116
                pass
136
                    name, value, engine, traverser)
109
117
            elif unit == 'minute':
137
                self.dynamic_max_age_unit = unit
93
118
                value *= 60
94
119
            elif unit == 'hour':
95
120
                value *= 60 * 60
96
121
            elif unit == 'day':
97
122
                value *= 24 * 60 * 60
98
123
            else:
99
124
                raise AssertionError("Unknown unit %s" % unit)
100
125
            self.max_age = int(value)
110
126
138
111
127
    # For use with str.translate to sanitize keys. No control characters
139
    # For use with str.translate to sanitize keys. No control characters
112
128
    # allowed, and we skip ':' too since it is a magic separator.
140
    # allowed, and we skip ':' too since it is a magic separator.
113
@@ -210,6 +222,11 @@
114
210
222
115
211
        return key
223
        return key
116
212
224
117
225
    def getMaxAge(self, econtext):
118
226
        if self.dynamic_max_age is not None:
119
227
            return self.dynamic_max_age(econtext) * self.dynamic_max_age_unit
120
228
        return self.static_max_age
121
229
122
213
    def __call__(self, econtext):
230
    def __call__(self, econtext):
123
214
        # If we have an 'anonymous' visibility chunk and are logged in,
231
        # If we have an 'anonymous' visibility chunk and are logged in,
124
215
        # we don't cache. Return the 'default' magic token to interpret
232
        # we don't cache. Return the 'default' magic token to interpret
125
@@ -225,7 +242,7 @@
126
225
242
127
226
        if cached_chunk is None:
243
        if cached_chunk is None:
128
227
            logging.debug("Memcache miss for %s", key)
244
            logging.debug("Memcache miss for %s", key)
130
228
            return MemcacheMiss(key, self)
245
            return MemcacheMiss(key, self.getMaxAge(econtext), self)
131
229
        else:
246
        else:
132
230
            logging.debug("Memcache hit for %s", key)
247
            logging.debug("Memcache hit for %s", key)
133
231
            return MemcacheHit(cached_chunk)
248
            return MemcacheHit(cached_chunk)
134
@@ -244,8 +261,9 @@
135
244
    tag contents and invokes this callback, which will store the
261
    tag contents and invokes this callback, which will store the
136
245
    result in memcache against the key calculated by the MemcacheExpr.
262
    result in memcache against the key calculated by the MemcacheExpr.
137
246
    """
263
    """
139
247
    def __init__(self, key, memcache_expr):
264
    def __init__(self, key, max_age, memcache_expr):
140
248
        self._key = key
265
        self._key = key
141
266
        self._max_age = max_age
142
249
        self._memcache_expr = memcache_expr
267
        self._memcache_expr = memcache_expr
143
250
268
144
251
    def __call__(self, value):
269
    def __call__(self, value):
145
@@ -255,7 +273,7 @@
146
255
            value = "<!-- Cache hit: %s -->%s<!-- End cache hit: %s -->" % (
273
            value = "<!-- Cache hit: %s -->%s<!-- End cache hit: %s -->" % (
147
256
                self._memcache_expr, value, self._memcache_expr)
274
                self._memcache_expr, value, self._memcache_expr)
148
257
        if getUtility(IMemcacheClient).set(
275
        if getUtility(IMemcacheClient).set(
150
258
            self._key, value, self._memcache_expr.max_age):
276
            self._key, value, self._max_age):
151
259
            logging.debug("Memcache set succeeded for %s", self._key)
277
            logging.debug("Memcache set succeeded for %s", self._key)
152
260
        else:
278
        else:
153
261
            logging.warn("Memcache set failed for %s", self._key)
279
            logging.warn("Memcache set failed for %s", self._key)
Reviewer	Review Type	Date Requested	Status
Graham Binns (community)	code	2010-06-22	Approve on 2010-06-22
Review via email: mp+28170@code.launchpad.net