Mercurial > genshi > mirror
annotate markup/template.py @ 29:ab8703fa68b8 trunk
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
that information.
* More docstrings.
| author | cmlenz |
|---|---|
| date | Wed, 28 Jun 2006 10:40:39 +0000 |
| parents | b4f78c05e5c9 |
| children | 2ab5fa60575d |
| rev | line source |
|---|---|
| 1 | 1 # -*- coding: utf-8 -*- |
| 2 # | |
| 3 # Copyright (C) 2006 Christopher Lenz | |
| 4 # All rights reserved. | |
| 5 # | |
| 6 # This software is licensed as described in the file COPYING, which | |
| 7 # you should have received as part of this distribution. The terms | |
| 27 | 8 # are also available at http://markup.cmlenz.net/wiki/License. |
| 1 | 9 # |
| 10 # This software consists of voluntary contributions made by many | |
| 11 # individuals. For the exact contribution history, see the revision | |
| 27 | 12 # history and logs, available at http://markup.cmlenz.net/log/. |
| 1 | 13 |
| 14 """Template engine that is compatible with Kid (http://kid.lesscode.org) to a | |
| 15 certain extent. | |
| 16 | |
| 17 Differences include: | |
| 18 * No generation of Python code for a template; the template is "interpreted" | |
| 19 * No support for <?python ?> processing instructions | |
| 20 * Expressions are evaluated in a more flexible manner, meaning you can use e.g. | |
| 21 attribute access notation to access items in a dictionary, etc | |
| 22 * Use of XInclude and match templates instead of Kid's py:extends/py:layout | |
| 23 directives | |
| 24 * Real (thread-safe) search path support | |
| 25 * No dependency on ElementTree (due to the lack of pos info) | |
| 26 * The original pos of parse events is kept throughout the processing | |
| 27 pipeline, so that errors can be tracked back to a specific line/column in | |
| 28 the template file | |
| 29 * py:match directives use (basic) XPath expressions to match against input | |
| 30 nodes, making match templates more powerful while keeping the syntax simple | |
| 31 | |
| 32 Todo items: | |
| 33 * Improved error reporting | |
| 34 * Support for using directives as elements and not just as attributes, reducing | |
| 35 the need for wrapper elements with py:strip="" | |
| 36 * Support for py:choose/py:when/py:otherwise (similar to XSLT) | |
| 37 * Support for list comprehensions and generator expressions in expressions | |
| 38 | |
| 39 Random thoughts: | |
| 40 * Is there any need to support py:extends and/or py:layout? | |
| 41 * Could we generate byte code from expressions? | |
| 42 """ | |
| 43 | |
| 44 import compiler | |
| 45 import os | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
46 import posixpath |
| 1 | 47 import re |
| 48 from StringIO import StringIO | |
| 49 | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
17
diff
changeset
|
50 from markup.core import Attributes, Namespace, Stream, StreamEventKind |
| 1 | 51 from markup.eval import Expression |
| 52 from markup.input import HTML, XMLParser, XML | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
53 from markup.path import Path |
| 1 | 54 |
| 55 __all__ = ['Context', 'BadDirectiveError', 'TemplateError', | |
| 56 'TemplateSyntaxError', 'TemplateNotFound', 'Template', | |
| 57 'TemplateLoader'] | |
| 58 | |
| 59 | |
| 60 class TemplateError(Exception): | |
| 61 """Base exception class for errors related to template processing.""" | |
| 62 | |
| 63 | |
| 64 class TemplateSyntaxError(TemplateError): | |
| 65 """Exception raised when an expression in a template causes a Python syntax | |
| 66 error.""" | |
| 67 | |
| 68 def __init__(self, message, filename='<string>', lineno=-1, offset=-1): | |
| 69 if isinstance(message, SyntaxError) and message.lineno is not None: | |
| 70 message = str(message).replace(' (line %d)' % message.lineno, '') | |
| 71 TemplateError.__init__(self, message) | |
| 72 self.filename = filename | |
| 73 self.lineno = lineno | |
| 74 self.offset = offset | |
| 75 | |
| 76 | |
| 77 class BadDirectiveError(TemplateSyntaxError): | |
| 78 """Exception raised when an unknown directive is encountered when parsing | |
| 79 a template. | |
| 80 | |
| 81 An unknown directive is any attribute using the namespace for directives, | |
| 82 with a local name that doesn't match any registered directive. | |
| 83 """ | |
| 84 | |
| 85 def __init__(self, name, filename='<string>', lineno=-1): | |
| 86 TemplateSyntaxError.__init__(self, 'Bad directive "%s"' % name.localname, | |
| 87 filename, lineno) | |
| 88 | |
| 89 | |
| 90 class TemplateNotFound(TemplateError): | |
| 91 """Exception raised when a specific template file could not be found.""" | |
| 92 | |
| 93 def __init__(self, name, search_path): | |
| 94 TemplateError.__init__(self, 'Template "%s" not found' % name) | |
| 95 self.search_path = search_path | |
| 96 | |
| 97 | |
| 98 class Context(object): | |
| 99 """A container for template input data. | |
| 100 | |
| 101 A context provides a stack of scopes. Template directives such as loops can | |
| 102 push a new scope on the stack with data that should only be available | |
| 103 inside the loop. When the loop terminates, that scope can get popped off | |
| 104 the stack again. | |
| 105 | |
| 106 >>> ctxt = Context(one='foo', other=1) | |
| 107 >>> ctxt.get('one') | |
| 108 'foo' | |
| 109 >>> ctxt.get('other') | |
| 110 1 | |
| 111 >>> ctxt.push(one='frost') | |
| 112 >>> ctxt.get('one') | |
| 113 'frost' | |
| 114 >>> ctxt.get('other') | |
| 115 1 | |
| 116 >>> ctxt.pop() | |
| 117 >>> ctxt.get('one') | |
| 118 'foo' | |
| 119 """ | |
| 120 | |
| 121 def __init__(self, **data): | |
| 122 self.stack = [data] | |
| 123 | |
| 124 def __getitem__(self, key): | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
125 """Get a variable's value, starting at the current context frame and |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
126 going upward. |
| 1 | 127 """ |
| 128 return self.get(key) | |
| 129 | |
| 130 def __repr__(self): | |
| 131 return repr(self.stack) | |
| 132 | |
| 133 def __setitem__(self, key, value): | |
| 134 """Set a variable in the current context.""" | |
| 135 self.stack[0][key] = value | |
| 136 | |
| 137 def get(self, key): | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
138 """Get a variable's value, starting at the current context frame and |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
139 going upward. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
140 """ |
| 1 | 141 for frame in self.stack: |
| 142 if key in frame: | |
| 143 return frame[key] | |
| 144 | |
| 145 def push(self, **data): | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
146 """Push a new context frame on the stack.""" |
| 1 | 147 self.stack.insert(0, data) |
| 148 | |
| 149 def pop(self): | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
150 """Pop the top-most context frame from the stack. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
151 |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
152 If the stack is empty, an `AssertionError` is raised. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
153 """ |
| 1 | 154 assert self.stack, 'Pop from empty context stack' |
| 155 self.stack.pop(0) | |
| 156 | |
| 157 | |
| 158 class Directive(object): | |
| 159 """Abstract base class for template directives. | |
| 160 | |
| 161 A directive is basically a callable that takes two parameters: `ctxt` is | |
| 162 the template data context, and `stream` is an iterable over the events that | |
| 163 the directive applies to. | |
| 164 | |
| 165 Directives can be "anonymous" or "registered". Registered directives can be | |
| 166 applied by the template author using an XML attribute with the | |
| 167 corresponding name in the template. Such directives should be subclasses of | |
| 168 this base class that can be instantiated with two parameters: `template` | |
| 169 is the `Template` instance, and `value` is the value of the directive | |
| 170 attribute. | |
| 171 | |
| 172 Anonymous directives are simply functions conforming to the protocol | |
| 173 described above, and can only be applied programmatically (for example by | |
| 174 template filters). | |
| 175 """ | |
| 176 __slots__ = ['expr'] | |
| 177 | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
178 def __init__(self, value): |
| 1 | 179 self.expr = value and Expression(value) or None |
| 180 | |
| 181 def __call__(self, stream, ctxt): | |
| 182 raise NotImplementedError | |
| 183 | |
| 184 def __repr__(self): | |
| 185 expr = '' | |
| 186 if self.expr is not None: | |
| 187 expr = ' "%s"' % self.expr.source | |
| 188 return '<%s%s>' % (self.__class__.__name__, expr) | |
| 189 | |
| 190 | |
| 191 class AttrsDirective(Directive): | |
| 192 """Implementation of the `py:attrs` template directive. | |
| 193 | |
| 194 The value of the `py:attrs` attribute should be a dictionary. The keys and | |
| 195 values of that dictionary will be added as attributes to the element: | |
| 196 | |
| 197 >>> ctxt = Context(foo={'class': 'collapse'}) | |
| 198 >>> tmpl = Template('''<ul xmlns:py="http://purl.org/kid/ns#"> | |
| 199 ... <li py:attrs="foo">Bar</li> | |
| 200 ... </ul>''') | |
| 201 >>> print tmpl.generate(ctxt) | |
| 202 <ul> | |
| 203 <li class="collapse">Bar</li> | |
| 204 </ul> | |
| 205 | |
| 206 If the value evaluates to `None` (or any other non-truth value), no | |
| 207 attributes are added: | |
| 208 | |
| 209 >>> ctxt = Context(foo=None) | |
| 210 >>> print tmpl.generate(ctxt) | |
| 211 <ul> | |
| 212 <li>Bar</li> | |
| 213 </ul> | |
| 214 """ | |
| 215 def __call__(self, stream, ctxt): | |
| 216 kind, (tag, attrib), pos = stream.next() | |
| 217 attrs = self.expr.evaluate(ctxt) | |
| 218 if attrs: | |
|
5
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
219 attrib = Attributes(attrib[:]) |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
220 if not isinstance(attrs, list): # assume it's a dict |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
221 attrs = attrs.items() |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
222 for name, value in attrs: |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
223 if value is None: |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
224 attrib.remove(name) |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
225 else: |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
226 attrib.set(name, unicode(value).strip()) |
|
dbb08edbc615
Improved `py:attrs` directive so that it removes existing attributes if they evaluate to `None` (AFAICT matching Kid behavior).
cmlenz
parents:
1
diff
changeset
|
227 yield kind, (tag, attrib), pos |
| 1 | 228 for event in stream: |
| 229 yield event | |
| 230 | |
| 231 | |
| 232 class ContentDirective(Directive): | |
| 233 """Implementation of the `py:content` template directive. | |
| 234 | |
| 235 This directive replaces the content of the element with the result of | |
| 236 evaluating the value of the `py:content` attribute: | |
| 237 | |
| 238 >>> ctxt = Context(bar='Bye') | |
| 239 >>> tmpl = Template('''<ul xmlns:py="http://purl.org/kid/ns#"> | |
| 240 ... <li py:content="bar">Hello</li> | |
| 241 ... </ul>''') | |
| 242 >>> print tmpl.generate(ctxt) | |
| 243 <ul> | |
| 244 <li>Bye</li> | |
| 245 </ul> | |
| 246 """ | |
| 247 def __call__(self, stream, ctxt): | |
| 248 kind, data, pos = stream.next() | |
| 249 if kind is Stream.START: | |
| 250 yield kind, data, pos # emit start tag | |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
251 yield Template.EXPR, self.expr, pos |
| 6 | 252 previous = stream.next() |
| 253 for event in stream: | |
| 254 previous = event | |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
255 if previous is not None: |
|
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
256 yield previous |
| 1 | 257 |
| 258 | |
| 259 class DefDirective(Directive): | |
| 260 """Implementation of the `py:def` template directive. | |
| 261 | |
| 262 This directive can be used to create "Named Template Functions", which | |
| 263 are template snippets that are not actually output during normal | |
| 264 processing, but rather can be expanded from expressions in other places | |
| 265 in the template. | |
| 266 | |
| 267 A named template function can be used just like a normal Python function | |
| 268 from template expressions: | |
| 269 | |
| 270 >>> ctxt = Context(bar='Bye') | |
| 271 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 272 ... <p py:def="echo(greeting, name='world')" class="message"> | |
| 273 ... ${greeting}, ${name}! | |
| 274 ... </p> | |
| 275 ... ${echo('hi', name='you')} | |
| 276 ... </div>''') | |
| 277 >>> print tmpl.generate(ctxt) | |
| 278 <div> | |
| 279 <p class="message"> | |
| 280 hi, you! | |
| 281 </p> | |
| 282 </div> | |
| 283 | |
| 284 >>> ctxt = Context(bar='Bye') | |
| 285 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 286 ... <p py:def="echo(greeting, name='world')" class="message"> | |
| 287 ... ${greeting}, ${name}! | |
| 288 ... </p> | |
| 289 ... <div py:replace="echo('hello')"></div> | |
| 290 ... </div>''') | |
| 291 >>> print tmpl.generate(ctxt) | |
| 292 <div> | |
| 293 <p class="message"> | |
| 294 hello, world! | |
| 295 </p> | |
| 296 </div> | |
| 297 """ | |
| 298 __slots__ = ['name', 'args', 'defaults', 'stream'] | |
| 299 | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
300 def __init__(self, args): |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
301 Directive.__init__(self, None) |
| 1 | 302 ast = compiler.parse(args, 'eval').node |
| 303 self.args = [] | |
| 304 self.defaults = {} | |
| 305 if isinstance(ast, compiler.ast.CallFunc): | |
| 306 self.name = ast.node.name | |
| 307 for arg in ast.args: | |
| 308 if isinstance(arg, compiler.ast.Keyword): | |
| 309 self.args.append(arg.name) | |
| 310 self.defaults[arg.name] = arg.expr.value | |
| 311 else: | |
| 312 self.args.append(arg.name) | |
| 313 else: | |
| 314 self.name = ast.name | |
| 315 self.stream = [] | |
| 316 | |
| 317 def __call__(self, stream, ctxt): | |
| 318 self.stream = list(stream) | |
| 319 ctxt[self.name] = lambda *args, **kwargs: self._exec(ctxt, *args, | |
| 320 **kwargs) | |
| 321 return [] | |
| 322 | |
| 323 def _exec(self, ctxt, *args, **kwargs): | |
| 324 scope = {} | |
| 325 args = list(args) # make mutable | |
| 326 for name in self.args: | |
| 327 if args: | |
| 328 scope[name] = args.pop(0) | |
| 329 else: | |
| 330 scope[name] = kwargs.pop(name, self.defaults.get(name)) | |
| 331 ctxt.push(**scope) | |
| 332 for event in self.stream: | |
| 333 yield event | |
| 334 ctxt.pop() | |
| 335 | |
| 336 | |
| 337 class ForDirective(Directive): | |
| 338 """Implementation of the `py:for` template directive. | |
| 339 | |
| 340 >>> ctxt = Context(items=[1, 2, 3]) | |
| 341 >>> tmpl = Template('''<ul xmlns:py="http://purl.org/kid/ns#"> | |
| 342 ... <li py:for="item in items">${item}</li> | |
| 343 ... </ul>''') | |
| 344 >>> print tmpl.generate(ctxt) | |
| 345 <ul> | |
| 346 <li>1</li><li>2</li><li>3</li> | |
| 347 </ul> | |
| 348 """ | |
| 349 __slots__ = ['targets'] | |
| 350 | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
351 def __init__(self, value): |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
352 targets, value = value.split(' in ', 1) |
| 1 | 353 self.targets = [str(name.strip()) for name in targets.split(',')] |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
354 Directive.__init__(self, value) |
| 1 | 355 |
| 356 def __call__(self, stream, ctxt): | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
357 iterable = self.expr.evaluate(ctxt) or [] |
| 1 | 358 if iterable is not None: |
| 359 stream = list(stream) | |
| 360 for item in iter(iterable): | |
| 361 if len(self.targets) == 1: | |
| 362 item = [item] | |
| 363 scope = {} | |
| 364 for idx, name in enumerate(self.targets): | |
| 365 scope[name] = item[idx] | |
| 366 ctxt.push(**scope) | |
| 367 for event in stream: | |
| 368 yield event | |
| 369 ctxt.pop() | |
| 370 | |
| 371 def __repr__(self): | |
| 372 return '<%s "%s in %s">' % (self.__class__.__name__, | |
| 373 ', '.join(self.targets), self.expr.source) | |
| 374 | |
| 375 | |
| 376 class IfDirective(Directive): | |
| 377 """Implementation of the `py:if` template directive. | |
| 378 | |
| 379 >>> ctxt = Context(foo=True, bar='Hello') | |
| 380 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 381 ... <b py:if="foo">${bar}</b> | |
| 382 ... </div>''') | |
| 383 >>> print tmpl.generate(ctxt) | |
| 384 <div> | |
| 385 <b>Hello</b> | |
| 386 </div> | |
| 387 """ | |
| 388 def __call__(self, stream, ctxt): | |
| 389 if self.expr.evaluate(ctxt): | |
| 390 return stream | |
| 391 return [] | |
| 392 | |
| 393 | |
| 394 class MatchDirective(Directive): | |
| 395 """Implementation of the `py:match` template directive. | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
396 |
| 1 | 397 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
398 ... <span py:match="greeting"> |
| 1 | 399 ... Hello ${select('@name')} |
| 400 ... </span> | |
| 401 ... <greeting name="Dude" /> | |
| 402 ... </div>''') | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
403 >>> print tmpl.generate() |
| 1 | 404 <div> |
| 405 <span> | |
| 406 Hello Dude | |
| 407 </span> | |
| 408 </div> | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
409 |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
410 A match template can produce the same kind of element that it matched |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
411 without entering an infinite recursion: |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
412 |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
413 >>> tmpl = Template('''<doc xmlns:py="http://purl.org/kid/ns#"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
414 ... <elem py:match="elem"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
415 ... <div class="elem">${select('*/text()')}</div> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
416 ... </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
417 ... <elem>Hey Joe</elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
418 ... </doc>''') |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
419 >>> print tmpl.generate() |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
420 <doc> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
421 <elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
422 <div class="elem">Hey Joe</div> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
423 </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
424 </doc> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
425 |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
426 Match directives are applied recursively, meaning that they are also |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
427 applied to any content they may have produced themselves: |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
428 |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
429 >>> tmpl = Template('''<doc xmlns:py="http://purl.org/kid/ns#"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
430 ... <elem py:match="elem"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
431 ... <div class="elem"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
432 ... ${select('*/*')} |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
433 ... </div> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
434 ... </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
435 ... <elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
436 ... <subelem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
437 ... <elem/> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
438 ... </subelem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
439 ... </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
440 ... </doc>''') |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
441 >>> print tmpl.generate() |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
442 <doc> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
443 <elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
444 <div class="elem"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
445 <subelem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
446 <elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
447 <div class="elem"> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
448 </div> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
449 </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
450 </subelem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
451 </div> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
452 </elem> |
|
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
453 </doc> |
| 1 | 454 """ |
| 455 __slots__ = ['path', 'stream'] | |
| 456 | |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
457 def __init__(self, value): |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
458 Directive.__init__(self, None) |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
459 self.path = Path(value) |
| 1 | 460 self.stream = [] |
| 461 | |
| 462 def __call__(self, stream, ctxt): | |
| 463 self.stream = list(stream) | |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
464 ctxt._match_templates.append((self.path.test(), self.path, self.stream)) |
| 1 | 465 return [] |
| 466 | |
| 467 def __repr__(self): | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
468 return '<%s "%s">' % (self.__class__.__name__, self.path.source) |
| 1 | 469 |
| 470 | |
| 471 class ReplaceDirective(Directive): | |
| 472 """Implementation of the `py:replace` template directive. | |
| 473 | |
| 474 >>> ctxt = Context(bar='Bye') | |
| 475 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 476 ... <span py:replace="bar">Hello</span> | |
| 477 ... </div>''') | |
| 478 >>> print tmpl.generate(ctxt) | |
| 479 <div> | |
| 480 Bye | |
| 481 </div> | |
| 482 | |
| 483 This directive is equivalent to `py:content` combined with `py:strip`, | |
| 484 providing a less verbose way to achieve the same effect: | |
| 485 | |
| 486 >>> ctxt = Context(bar='Bye') | |
| 487 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 488 ... <span py:content="bar" py:strip="">Hello</span> | |
| 489 ... </div>''') | |
| 490 >>> print tmpl.generate(ctxt) | |
| 491 <div> | |
| 492 Bye | |
| 493 </div> | |
| 494 """ | |
| 495 def __call__(self, stream, ctxt): | |
| 496 kind, data, pos = stream.next() | |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
497 yield Template.EXPR, self.expr, pos |
| 1 | 498 |
| 499 | |
| 500 class StripDirective(Directive): | |
| 501 """Implementation of the `py:strip` template directive. | |
| 502 | |
| 503 When the value of the `py:strip` attribute evaluates to `True`, the element | |
| 504 is stripped from the output | |
| 505 | |
| 506 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 507 ... <div py:strip="True"><b>foo</b></div> | |
| 508 ... </div>''') | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
509 >>> print tmpl.generate() |
| 1 | 510 <div> |
| 511 <b>foo</b> | |
| 512 </div> | |
| 513 | |
| 514 On the other hand, when the attribute evaluates to `False`, the element is | |
| 515 not stripped: | |
| 516 | |
| 517 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 518 ... <div py:strip="False"><b>foo</b></div> | |
| 519 ... </div>''') | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
520 >>> print tmpl.generate() |
| 1 | 521 <div> |
| 522 <div><b>foo</b></div> | |
| 523 </div> | |
| 524 | |
| 525 Leaving the attribute value empty is equivalent to a truth value: | |
| 526 | |
| 527 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 528 ... <div py:strip=""><b>foo</b></div> | |
| 529 ... </div>''') | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
530 >>> print tmpl.generate() |
| 1 | 531 <div> |
| 532 <b>foo</b> | |
| 533 </div> | |
| 534 | |
| 535 This directive is particulary interesting for named template functions or | |
| 536 match templates that do not generate a top-level element: | |
| 537 | |
| 538 >>> tmpl = Template('''<div xmlns:py="http://purl.org/kid/ns#"> | |
| 539 ... <div py:def="echo(what)" py:strip=""> | |
| 540 ... <b>${what}</b> | |
| 541 ... </div> | |
| 542 ... ${echo('foo')} | |
| 543 ... </div>''') | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
544 >>> print tmpl.generate() |
| 1 | 545 <div> |
| 546 <b>foo</b> | |
| 547 </div> | |
| 548 """ | |
| 549 def __call__(self, stream, ctxt): | |
| 550 if self.expr: | |
| 551 strip = self.expr.evaluate(ctxt) | |
| 552 else: | |
| 553 strip = True | |
| 554 if strip: | |
| 555 stream.next() # skip start tag | |
| 556 previous = stream.next() | |
| 557 for event in stream: | |
| 558 yield previous | |
| 559 previous = event | |
| 560 else: | |
| 561 for event in stream: | |
| 562 yield event | |
| 563 | |
| 564 | |
| 565 class Template(object): | |
| 566 """Can parse a template and transform it into the corresponding output | |
| 567 based on context data. | |
| 568 """ | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
17
diff
changeset
|
569 NAMESPACE = Namespace('http://purl.org/kid/ns#') |
| 1 | 570 |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
571 EXPR = StreamEventKind('EXPR') # an expression |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
572 SUB = StreamEventKind('SUB') # a "subprogram" |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
573 |
| 1 | 574 directives = [('def', DefDirective), |
| 575 ('match', MatchDirective), | |
| 576 ('for', ForDirective), | |
| 577 ('if', IfDirective), | |
| 578 ('replace', ReplaceDirective), | |
| 579 ('content', ContentDirective), | |
| 580 ('attrs', AttrsDirective), | |
| 581 ('strip', StripDirective)] | |
| 582 _dir_by_name = dict(directives) | |
| 583 _dir_order = [directive[1] for directive in directives] | |
| 584 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
585 def __init__(self, source, basedir=None, filename=None): |
| 1 | 586 """Initialize a template from either a string or a file-like object.""" |
| 587 if isinstance(source, basestring): | |
| 588 self.source = StringIO(source) | |
| 589 else: | |
| 590 self.source = source | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
591 self.basedir = basedir |
| 1 | 592 self.filename = filename or '<string>' |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
593 if basedir and filename: |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
594 self.filepath = os.path.join(basedir, filename) |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
595 else: |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
596 self.filepath = '<string>' |
| 1 | 597 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
598 self.filters = [] |
| 1 | 599 self.parse() |
| 600 | |
| 601 def __repr__(self): | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
602 return '<%s "%s">' % (self.__class__.__name__, self.filename) |
| 1 | 603 |
| 604 def parse(self): | |
| 605 """Parse the template. | |
| 606 | |
| 607 The parsing stage parses the XML template and constructs a list of | |
| 608 directives that will be executed in the render stage. The input is | |
| 609 split up into literal output (markup that does not depend on the | |
| 610 context data) and actual directives (commands or variable | |
| 611 substitution). | |
| 612 """ | |
| 613 stream = [] # list of events of the "compiled" template | |
| 614 dirmap = {} # temporary mapping of directives to elements | |
| 615 ns_prefix = {} | |
| 616 depth = 0 | |
| 617 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
618 for kind, data, pos in XMLParser(self.source, filename=self.filename): |
| 1 | 619 |
| 620 if kind is Stream.START_NS: | |
| 621 # Strip out the namespace declaration for template directives | |
| 622 prefix, uri = data | |
| 623 if uri == self.NAMESPACE: | |
| 624 ns_prefix[prefix] = uri | |
| 625 else: | |
| 626 stream.append((kind, data, pos)) | |
| 627 | |
| 628 elif kind is Stream.END_NS: | |
| 629 if data in ns_prefix: | |
| 630 del ns_prefix[data] | |
| 631 else: | |
| 632 stream.append((kind, data, pos)) | |
| 633 | |
| 634 elif kind is Stream.START: | |
| 635 # Record any directive attributes in start tags | |
| 636 tag, attrib = data | |
| 637 directives = [] | |
| 638 new_attrib = [] | |
| 639 for name, value in attrib: | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
17
diff
changeset
|
640 if name in self.NAMESPACE: |
| 1 | 641 cls = self._dir_by_name.get(name.localname) |
| 642 if cls is None: | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
643 raise BadDirectiveError(name, self.filename, pos[1]) |
| 1 | 644 else: |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
645 directives.append(cls(value)) |
| 1 | 646 else: |
| 647 value = list(self._interpolate(value, *pos)) | |
| 648 new_attrib.append((name, value)) | |
| 649 if directives: | |
| 650 directives.sort(lambda a, b: cmp(self._dir_order.index(a.__class__), | |
| 651 self._dir_order.index(b.__class__))) | |
| 652 dirmap[(depth, tag)] = (directives, len(stream)) | |
| 653 | |
| 654 stream.append((kind, (tag, Attributes(new_attrib)), pos)) | |
| 655 depth += 1 | |
| 656 | |
| 657 elif kind is Stream.END: | |
| 658 depth -= 1 | |
| 659 stream.append((kind, data, pos)) | |
| 660 | |
| 661 # If there have have directive attributes with the corresponding | |
| 662 # start tag, move the events inbetween into a "subprogram" | |
| 663 if (depth, data) in dirmap: | |
| 664 directives, start_offset = dirmap.pop((depth, data)) | |
| 665 substream = stream[start_offset:] | |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
666 stream[start_offset:] = [(Template.SUB, |
| 1 | 667 (directives, substream), pos)] |
| 668 | |
| 669 elif kind is Stream.TEXT: | |
| 670 for kind, data, pos in self._interpolate(data, *pos): | |
| 671 stream.append((kind, data, pos)) | |
| 672 | |
| 673 else: | |
| 674 stream.append((kind, data, pos)) | |
| 675 | |
| 676 self.stream = stream | |
| 677 | |
| 678 _FULL_EXPR_RE = re.compile(r'(?<!\$)\$\{(.+?)\}') | |
| 679 _SHORT_EXPR_RE = re.compile(r'(?<!\$)\$([a-zA-Z][a-zA-Z0-9_\.]*)') | |
| 680 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
681 def _interpolate(cls, text, filename=None, lineno=-1, offset=-1): |
| 1 | 682 """Parse the given string and extract expressions. |
| 683 | |
| 684 This method returns a list containing both literal text and `Expression` | |
| 685 objects. | |
|
14
c7d33e0c9839
The `<py:match>` directive now protects itself against simple infinite recursion (see MatchDirective), while still allowing recursion in general.
cmlenz
parents:
13
diff
changeset
|
686 |
| 1 | 687 @param text: the text to parse |
| 688 @param lineno: the line number at which the text was found (optional) | |
| 689 @param offset: the column number at which the text starts in the source | |
| 690 (optional) | |
| 691 """ | |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
692 patterns = [Template._FULL_EXPR_RE, Template._SHORT_EXPR_RE] |
| 1 | 693 def _interpolate(text): |
| 694 for idx, group in enumerate(patterns.pop(0).split(text)): | |
| 695 if idx % 2: | |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
696 yield Template.EXPR, Expression(group), (lineno, offset) |
| 1 | 697 elif group: |
| 698 if patterns: | |
| 699 for result in _interpolate(group): | |
| 700 yield result | |
| 701 else: | |
| 702 yield Stream.TEXT, group.replace('$$', '$'), \ | |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
703 (filename, lineno, offset) |
| 1 | 704 return _interpolate(text) |
| 705 _interpolate = classmethod(_interpolate) | |
| 706 | |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
707 def generate(self, ctxt=None): |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
708 """Apply the template to the given context data. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
709 |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
710 @param ctxt: a `Context` instance containing the data for the template |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
711 @return: a markup event stream representing the result of applying |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
712 the template to the context data. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
713 """ |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
714 if ctxt is None: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
715 ctxt = Context() |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
716 if not hasattr(ctxt, '_match_templates'): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
717 ctxt._match_templates = [] |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
718 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
719 stream = self._match(self._eval(self.stream, ctxt), ctxt) |
|
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
720 return Stream(self._flatten(stream, ctxt)) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
721 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
722 def _eval(self, stream, ctxt=None): |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
723 """Internal stream filter that evaluates any expressions in `START` and |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
724 `TEXT` events. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
725 """ |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
726 for kind, data, pos in stream: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
727 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
728 if kind is Stream.START: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
729 # Attributes may still contain expressions in start tags at |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
730 # this point, so do some evaluation |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
731 tag, attrib = data |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
732 new_attrib = [] |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
733 for name, substream in attrib: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
734 if isinstance(substream, basestring): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
735 value = substream |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
736 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
737 values = [] |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
738 for subkind, subdata, subpos in substream: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
739 if subkind is Template.EXPR: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
740 values.append(subdata.evaluate(ctxt)) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
741 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
742 values.append(subdata) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
743 value = filter(lambda x: x is not None, values) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
744 if not value: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
745 continue |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
746 new_attrib.append((name, u''.join(value))) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
747 yield kind, (tag, Attributes(new_attrib)), pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
748 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
749 elif kind is Template.EXPR: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
750 result = data.evaluate(ctxt) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
751 if result is None: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
752 continue |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
753 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
754 # First check for a string, otherwise the iterable test below |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
755 # succeeds, and the string will be chopped up into individual |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
756 # characters |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
757 if isinstance(result, basestring): |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
758 yield Stream.TEXT, unicode(result), pos |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
759 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
760 # Test if the expression evaluated to an iterable, in which |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
761 # case we yield the individual items |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
762 try: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
763 yield (Template.SUB, ([], iter(result)), pos) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
764 except TypeError: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
765 # Neither a string nor an iterable, so just pass it |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
766 # through |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
767 yield Stream.TEXT, unicode(result), pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
768 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
769 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
770 yield kind, data, pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
771 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
772 def _flatten(self, stream, ctxt=None): |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
773 """Internal stream filter that expands `SUB` events in the stream.""" |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
774 for filter_ in self.filters: |
|
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
775 stream = filter_(iter(stream), ctxt) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
776 try: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
777 for kind, data, pos in stream: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
778 if kind is Template.SUB: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
779 # This event is a list of directives and a list of |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
780 # nested events to which those directives should be |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
781 # applied |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
782 directives, substream = data |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
783 directives.reverse() |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
784 for directive in directives: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
785 substream = directive(iter(substream), ctxt) |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
786 substream = self._match(self._eval(substream, ctxt), ctxt) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
787 for event in self._flatten(substream, ctxt): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
788 yield event |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
789 continue |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
790 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
791 yield kind, data, pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
792 except SyntaxError, err: |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
793 raise TemplateSyntaxError(err, self.filename, pos[1], |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
794 pos[2] + (err.offset or 0)) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
795 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
796 def _match(self, stream, ctxt=None): |
|
29
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
797 """Internal stream filter that applies any defined match templates |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
798 to the stream. |
|
ab8703fa68b8
* Minor simplification of template directives: they no longer get passed the template instance and the position, as no directive was actually using
cmlenz
parents:
27
diff
changeset
|
799 """ |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
800 for kind, data, pos in stream: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
801 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
802 # We (currently) only care about start and end events for matching |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
803 # We might care about namespace events in the future, though |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
804 if kind not in (Stream.START, Stream.END): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
805 yield kind, data, pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
806 continue |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
807 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
808 for idx, (test, path, template) in enumerate(ctxt._match_templates): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
809 if (kind, data, pos) in template[::len(template)]: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
810 # This is the event this match template produced itself, so |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
811 # matching it again would result in an infinite loop |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
812 continue |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
813 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
814 result = test(kind, data, pos) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
815 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
816 if result: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
817 # Consume and store all events until an end event |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
818 # corresponding to this start event is encountered |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
819 content = [(kind, data, pos)] |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
820 depth = 1 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
821 while depth > 0: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
822 event = stream.next() |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
823 if event[0] is Stream.START: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
824 depth += 1 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
825 elif event[0] is Stream.END: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
826 depth -= 1 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
827 content.append(event) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
828 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
829 # enable the path to keep track of the stream state |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
830 test(*event) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
831 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
832 content = list(self._flatten(content, ctxt)) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
833 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
834 def _apply(stream, ctxt): |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
835 ctxt.push(select=lambda path: Stream(stream).select(path)) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
836 for event in template: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
837 yield event |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
838 ctxt.pop() |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
839 |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
840 yield (Template.SUB, |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
841 ([lambda stream, ctxt: _apply(content, ctxt)], |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
842 []), content[0][-1]) |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
843 break |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
844 else: |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
845 yield kind, data, pos |
|
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
846 |
| 1 | 847 |
| 848 class TemplateLoader(object): | |
| 849 """Responsible for loading templates from files on the specified search | |
| 850 path. | |
| 851 | |
| 852 >>> import tempfile | |
| 853 >>> fd, path = tempfile.mkstemp(suffix='.html', prefix='template') | |
| 854 >>> os.write(fd, '<p>$var</p>') | |
| 855 11 | |
| 856 >>> os.close(fd) | |
| 857 | |
| 858 The template loader accepts a list of directory paths that are then used | |
| 859 when searching for template files, in the given order: | |
| 860 | |
| 861 >>> loader = TemplateLoader([os.path.dirname(path)]) | |
| 862 | |
| 863 The `load()` method first checks the template cache whether the requested | |
| 864 template has already been loaded. If not, it attempts to locate the | |
| 865 template file, and returns the corresponding `Template` object: | |
| 866 | |
| 867 >>> template = loader.load(os.path.basename(path)) | |
| 868 >>> isinstance(template, Template) | |
| 869 True | |
| 870 | |
| 871 Template instances are cached: requesting a template with the same name | |
| 872 results in the same instance being returned: | |
| 873 | |
| 874 >>> loader.load(os.path.basename(path)) is template | |
| 875 True | |
| 876 """ | |
| 877 def __init__(self, search_path=None, auto_reload=False): | |
| 878 """Create the template laoder. | |
| 879 | |
| 880 @param search_path: a list of absolute path names that should be | |
| 881 searched for template files | |
| 882 @param auto_reload: whether to check the last modification time of | |
| 883 template files, and reload them if they have changed | |
| 884 """ | |
| 885 self.search_path = search_path | |
| 886 if self.search_path is None: | |
| 887 self.search_path = [] | |
| 888 self.auto_reload = auto_reload | |
| 889 self._cache = {} | |
| 890 self._mtime = {} | |
| 891 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
892 def load(self, filename, relative_to=None): |
| 1 | 893 """Load the template with the given name. |
| 894 | |
|
22
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
895 If the `filename` parameter is relative, this method searches the search |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
896 path trying to locate a template matching the given name. If the file |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
897 name is an absolute path, the search path is not bypassed. |
| 1 | 898 |
|
22
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
899 If requested template is not found, a `TemplateNotFound` exception is |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
900 raised. Otherwise, a `Template` object is returned that represents the |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
901 parsed template. |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
902 |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
903 Template instances are cached to avoid having to parse the same |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
904 template file more than once. Thus, subsequent calls of this method |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
905 with the same template file name will return the same `Template` |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
906 object (unless the `auto_reload` option is enabled and the file was |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
907 changed since the last parse.) |
| 1 | 908 |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
909 If the `relative_to` parameter is provided, the `filename` is |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
910 interpreted as being relative to that path. |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
911 |
| 1 | 912 @param filename: the relative path of the template file to load |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
913 @param relative_to: the filename of the template from which the new |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
914 template is being loaded, or `None` if the template is being loaded |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
915 directly |
| 1 | 916 """ |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
917 if relative_to: |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
918 filename = posixpath.join(posixpath.dirname(relative_to), filename) |
| 1 | 919 filename = os.path.normpath(filename) |
|
22
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
920 |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
921 # First check the cache to avoid reparsing the same file |
| 1 | 922 try: |
| 923 tmpl = self._cache[filename] | |
| 924 if not self.auto_reload or \ | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
925 os.path.getmtime(tmpl.filepath) == self._mtime[filename]: |
| 1 | 926 return tmpl |
| 927 except KeyError: | |
| 928 pass | |
|
22
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
929 |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
930 # Bypass the search path if the filename is absolute |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
931 search_path = self.search_path |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
932 if os.path.isabs(filename): |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
933 search_path = [os.path.dirname(filename)] |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
934 |
|
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
935 for dirname in search_path: |
| 1 | 936 filepath = os.path.join(dirname, filename) |
| 937 try: | |
| 938 fileobj = file(filepath, 'rt') | |
| 939 try: | |
|
22
2483fe549959
Fix for the template engine plugin: the search path is now ignored if the requested template path is absolute.
cmlenz
parents:
21
diff
changeset
|
940 from markup.filters import IncludeFilter |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
941 tmpl = Template(fileobj, basedir=dirname, filename=filename) |
|
17
74cc70129d04
Refactoring to address #6: all match templates are now processed by a single filter, which means that match templates added by included templates are properly applied. A side effect of this refactoring is that `Context` objects may not be reused across multiple template processing runs.
cmlenz
parents:
14
diff
changeset
|
942 tmpl.filters.append(IncludeFilter(self)) |
| 1 | 943 finally: |
| 944 fileobj.close() | |
| 945 self._cache[filename] = tmpl | |
| 946 self._mtime[filename] = os.path.getmtime(filepath) | |
| 947 return tmpl | |
| 948 except IOError: | |
| 949 continue | |
| 950 raise TemplateNotFound(filename, self.search_path) |