Mercurial > genshi > mirror
annotate markup/template.py @ 92:01d36818bb3d trunk
More performance improvements... this time for whitespace normalization and template loops.
| author | cmlenz |
|---|---|
| date | Thu, 20 Jul 2006 23:06:36 +0000 |
| parents | c835e81c50af |
| children | 08d77c7725e2 |
| rev | line source |
|---|---|
| 1 | 1 # -*- coding: utf-8 -*- |
| 2 # | |
|
66
59eb24184e9c
Switch copyright to Edgewall and URLs to markup.edgewall.org.
cmlenz
parents:
65
diff
changeset
|
3 # Copyright (C) 2006 Edgewall Software |
| 1 | 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 | |
|
66
59eb24184e9c
Switch copyright to Edgewall and URLs to markup.edgewall.org.
cmlenz
parents:
65
diff
changeset
|
8 # are also available at http://markup.edgewall.org/wiki/License. |
| 1 | 9 # |
| 10 # This software consists of voluntary contributions made by many | |
| 11 # individuals. For the exact contribution history, see the revision | |
|
66
59eb24184e9c
Switch copyright to Edgewall and URLs to markup.edgewall.org.
cmlenz
parents:
65
diff
changeset
|
12 # history and logs, available at http://markup.edgewall.org/log/. |
| 1 | 13 |
| 82 | 14 """Implementation of the template engine.""" |
| 1 | 15 |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
16 try: |
|
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
17 from collections import deque |
|
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
18 except ImportError: |
|
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
19 class deque(list): |
|
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
20 def appendleft(self, x): self.insert(0, x) |
|
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
21 def popleft(self): return self.pop(0) |
| 1 | 22 import compiler |
| 23 import os | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
24 import posixpath |
| 1 | 25 import re |
| 26 from StringIO import StringIO | |
| 27 | |
|
18
5420cfe42d36
Actually make use of the `markup.core.Namespace` class, and add a couple of doctests.
cmlenz
parents:
17
diff
changeset
|
28 from markup.core import Attributes, Namespace, Stream, StreamEventKind |
|
89
80386d62814f
Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents:
87
diff
changeset
|
29 from markup.core import START, END, START_NS, END_NS, TEXT, COMMENT |
| 1 | 30 from markup.eval import Expression |
| 69 | 31 from markup.input import XMLParser |
|
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
|
32 from markup.path import Path |
| 1 | 33 |
| 34 __all__ = ['Context', 'BadDirectiveError', 'TemplateError', | |
| 35 'TemplateSyntaxError', 'TemplateNotFound', 'Template', | |
| 36 'TemplateLoader'] | |
| 37 | |
| 38 | |
| 39 class TemplateError(Exception): | |
| 40 """Base exception class for errors related to template processing.""" | |
| 41 | |
| 42 | |
| 43 class TemplateSyntaxError(TemplateError): | |
| 44 """Exception raised when an expression in a template causes a Python syntax | |
| 45 error.""" | |
| 46 | |
| 47 def __init__(self, message, filename='<string>', lineno=-1, offset=-1): | |
| 48 if isinstance(message, SyntaxError) and message.lineno is not None: | |
| 49 message = str(message).replace(' (line %d)' % message.lineno, '') | |
| 80 | 50 message = '%s (%s, line %d)' % (message, filename, lineno) |
| 1 | 51 TemplateError.__init__(self, message) |
| 52 self.filename = filename | |
| 53 self.lineno = lineno | |
| 54 self.offset = offset | |
| 55 | |
| 56 | |
| 57 class BadDirectiveError(TemplateSyntaxError): | |
| 58 """Exception raised when an unknown directive is encountered when parsing | |
| 59 a template. | |
| 60 | |
| 61 An unknown directive is any attribute using the namespace for directives, | |
| 62 with a local name that doesn't match any registered directive. | |
| 63 """ | |
| 64 | |
| 65 def __init__(self, name, filename='<string>', lineno=-1): | |
| 80 | 66 msg = 'bad directive "%s" (%s, line %d)' % (name.localname, filename, |
| 67 lineno) | |
| 68 TemplateSyntaxError.__init__(self, msg, filename, lineno) | |
| 1 | 69 |
| 70 | |
| 71 class TemplateNotFound(TemplateError): | |
| 72 """Exception raised when a specific template file could not be found.""" | |
| 73 | |
| 74 def __init__(self, name, search_path): | |
| 75 TemplateError.__init__(self, 'Template "%s" not found' % name) | |
| 76 self.search_path = search_path | |
| 77 | |
| 78 | |
| 79 class Context(object): | |
| 80 """A container for template input data. | |
| 81 | |
| 82 A context provides a stack of scopes. Template directives such as loops can | |
| 83 push a new scope on the stack with data that should only be available | |
| 84 inside the loop. When the loop terminates, that scope can get popped off | |
| 85 the stack again. | |
| 86 | |
| 87 >>> ctxt = Context(one='foo', other=1) | |
| 88 >>> ctxt.get('one') | |
| 89 'foo' | |
| 90 >>> ctxt.get('other') | |
| 91 1 | |
| 92 >>> ctxt.push(one='frost') | |
| 93 >>> ctxt.get('one') | |
| 94 'frost' | |
| 95 >>> ctxt.get('other') | |
| 96 1 | |
| 97 >>> ctxt.pop() | |
| 98 >>> ctxt.get('one') | |
| 99 'foo' | |
| 100 """ | |
| 101 | |
| 102 def __init__(self, **data): | |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
103 self.frames = deque([data]) |
| 1 | 104 |
| 105 def __repr__(self): | |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
106 return repr(self.frames) |
| 1 | 107 |
| 108 def __setitem__(self, key, value): | |
| 109 """Set a variable in the current context.""" | |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
110 self.frames[0][key] = value |
| 1 | 111 |
| 112 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
|
113 """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
|
114 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
|
115 """ |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
116 for frame in self.frames: |
| 1 | 117 if key in frame: |
| 118 return frame[key] | |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
119 __getitem__ = get |
| 1 | 120 |
| 121 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
|
122 """Push a new context frame on the stack.""" |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
123 self.frames.appendleft(data) |
| 1 | 124 |
| 125 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
|
126 """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
|
127 |
|
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
|
128 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
|
129 """ |
|
71
db7c76d337aa
Add back line that was accidentially left commented out in [75].
cmlenz
parents:
70
diff
changeset
|
130 assert self.frames, 'Pop from empty context stack' |
|
70
dd73921530e8
Use `collections.deque` for the template context stack on Python 2.4, which improves performance if there are many context frame pop/push operations.
cmlenz
parents:
69
diff
changeset
|
131 self.frames.popleft() |
| 1 | 132 |
| 133 | |
| 134 class Directive(object): | |
| 135 """Abstract base class for template directives. | |
| 136 | |
| 54 | 137 A directive is basically a callable that takes three positional arguments: |
| 138 `ctxt` is the template data context, `stream` is an iterable over the | |
| 139 events that the directive applies to, and `directives` is is a list of | |
| 140 other directives on the same stream that need to be applied. | |
| 1 | 141 |
| 142 Directives can be "anonymous" or "registered". Registered directives can be | |
| 143 applied by the template author using an XML attribute with the | |
| 144 corresponding name in the template. Such directives should be subclasses of | |
| 31 | 145 this base class that can be instantiated with the value of the directive |
| 146 attribute as parameter. | |
| 1 | 147 |
| 148 Anonymous directives are simply functions conforming to the protocol | |
| 149 described above, and can only be applied programmatically (for example by | |
| 150 template filters). | |
| 151 """ | |
| 152 __slots__ = ['expr'] | |
| 153 | |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
154 def __init__(self, value, filename=None, lineno=-1, offset=-1): |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
155 try: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
156 self.expr = value and Expression(value, filename, lineno) or None |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
157 except SyntaxError, err: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
158 raise TemplateSyntaxError(err, filename, lineno, |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
159 offset + (err.offset or 0)) |
| 1 | 160 |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
161 def __call__(self, stream, ctxt, directives): |
| 1 | 162 raise NotImplementedError |
| 163 | |
| 164 def __repr__(self): | |
| 165 expr = '' | |
| 166 if self.expr is not None: | |
| 167 expr = ' "%s"' % self.expr.source | |
| 168 return '<%s%s>' % (self.__class__.__name__, expr) | |
| 169 | |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
170 |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
171 def _apply_directives(stream, ctxt, directives): |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
172 if directives: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
173 stream = directives[0](iter(stream), ctxt, directives[1:]) |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
174 return stream |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
175 |
| 1 | 176 |
| 177 class AttrsDirective(Directive): | |
| 178 """Implementation of the `py:attrs` template directive. | |
| 179 | |
| 180 The value of the `py:attrs` attribute should be a dictionary. The keys and | |
| 181 values of that dictionary will be added as attributes to the element: | |
| 182 | |
| 183 >>> ctxt = Context(foo={'class': 'collapse'}) | |
| 61 | 184 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/"> |
| 1 | 185 ... <li py:attrs="foo">Bar</li> |
| 186 ... </ul>''') | |
| 187 >>> print tmpl.generate(ctxt) | |
| 188 <ul> | |
| 189 <li class="collapse">Bar</li> | |
| 190 </ul> | |
| 191 | |
| 192 If the value evaluates to `None` (or any other non-truth value), no | |
| 193 attributes are added: | |
| 194 | |
| 195 >>> ctxt = Context(foo=None) | |
| 196 >>> print tmpl.generate(ctxt) | |
| 197 <ul> | |
| 198 <li>Bar</li> | |
| 199 </ul> | |
| 200 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
201 __slots__ = [] |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
202 |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
203 def __call__(self, stream, ctxt, directives): |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
204 def _generate(): |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
205 kind, (tag, attrib), pos = stream.next() |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
206 attrs = self.expr.evaluate(ctxt) |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
207 if attrs: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
208 attrib = Attributes(attrib[:]) |
|
77
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
209 if isinstance(attrs, Stream): |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
210 try: |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
211 attrs = iter(attrs).next() |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
212 except StopIteration: |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
213 attrs = [] |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
214 elif not isinstance(attrs, list): # assume it's a dict |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
215 attrs = attrs.items() |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
216 for name, value in attrs: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
217 if value is None: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
218 attrib.remove(name) |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
219 else: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
220 attrib.set(name, unicode(value).strip()) |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
221 yield kind, (tag, attrib), pos |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
222 for event in stream: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
223 yield event |
|
77
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
224 |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
225 return _apply_directives(_generate(), ctxt, directives) |
| 1 | 226 |
| 227 | |
| 228 class ContentDirective(Directive): | |
| 229 """Implementation of the `py:content` template directive. | |
| 230 | |
| 231 This directive replaces the content of the element with the result of | |
| 232 evaluating the value of the `py:content` attribute: | |
| 233 | |
| 234 >>> ctxt = Context(bar='Bye') | |
| 61 | 235 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/"> |
| 1 | 236 ... <li py:content="bar">Hello</li> |
| 237 ... </ul>''') | |
| 238 >>> print tmpl.generate(ctxt) | |
| 239 <ul> | |
| 240 <li>Bye</li> | |
| 241 </ul> | |
| 242 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
243 __slots__ = [] |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
244 |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
245 def __call__(self, stream, ctxt, directives): |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
246 def _generate(): |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
247 kind, data, pos = stream.next() |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
248 if kind is Stream.START: |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
249 yield kind, data, pos # emit start tag |
| 69 | 250 yield EXPR, self.expr, pos |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
251 previous = stream.next() |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
252 for event in stream: |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
253 previous = event |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
254 if previous is not None: |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
255 yield previous |
|
87
1b874f032bde
Fix some problems in expression evaluation by transforming the AST and compiling that to bytecode, instead of generating bytecode directly. Invalidates #13.
cmlenz
parents:
82
diff
changeset
|
256 |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
257 return _apply_directives(_generate(), ctxt, directives) |
| 1 | 258 |
| 259 | |
| 260 class DefDirective(Directive): | |
| 261 """Implementation of the `py:def` template directive. | |
| 262 | |
| 263 This directive can be used to create "Named Template Functions", which | |
| 264 are template snippets that are not actually output during normal | |
| 265 processing, but rather can be expanded from expressions in other places | |
| 266 in the template. | |
| 267 | |
| 268 A named template function can be used just like a normal Python function | |
| 269 from template expressions: | |
| 270 | |
| 271 >>> ctxt = Context(bar='Bye') | |
| 61 | 272 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 273 ... <p py:def="echo(greeting, name='world')" class="message"> |
| 274 ... ${greeting}, ${name}! | |
| 275 ... </p> | |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
276 ... ${echo('Hi', name='you')} |
| 1 | 277 ... </div>''') |
| 278 >>> print tmpl.generate(ctxt) | |
| 279 <div> | |
| 280 <p class="message"> | |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
281 Hi, you! |
| 1 | 282 </p> |
| 283 </div> | |
| 284 | |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
285 If a function does not require parameters, the parenthesis can be omitted |
|
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
286 both when defining and when calling it: |
|
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
287 |
| 1 | 288 >>> ctxt = Context(bar='Bye') |
| 61 | 289 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
290 ... <p py:def="helloworld" class="message"> |
|
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
291 ... Hello, world! |
| 1 | 292 ... </p> |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
293 ... ${helloworld} |
| 1 | 294 ... </div>''') |
| 295 >>> print tmpl.generate(ctxt) | |
| 296 <div> | |
| 297 <p class="message"> | |
|
90
c835e81c50af
When an expression evaluates to a callable, it is called implicitly.
cmlenz
parents:
89
diff
changeset
|
298 Hello, world! |
| 1 | 299 </p> |
| 300 </div> | |
| 301 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
302 __slots__ = ['name', 'args', 'defaults', 'stream', 'directives'] |
| 1 | 303 |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
304 ATTRIBUTE = 'function' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
305 |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
306 def __init__(self, args, filename=None, lineno=-1, offset=-1): |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
307 Directive.__init__(self, None, filename, lineno, offset) |
| 1 | 308 ast = compiler.parse(args, 'eval').node |
| 309 self.args = [] | |
| 310 self.defaults = {} | |
| 311 if isinstance(ast, compiler.ast.CallFunc): | |
| 312 self.name = ast.node.name | |
| 313 for arg in ast.args: | |
| 314 if isinstance(arg, compiler.ast.Keyword): | |
| 315 self.args.append(arg.name) | |
| 316 self.defaults[arg.name] = arg.expr.value | |
| 317 else: | |
| 318 self.args.append(arg.name) | |
| 319 else: | |
| 320 self.name = ast.name | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
321 self.stream, self.directives = [], [] |
| 1 | 322 |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
323 def __call__(self, stream, ctxt, directives): |
| 1 | 324 self.stream = list(stream) |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
325 self.directives = directives |
| 1 | 326 ctxt[self.name] = lambda *args, **kwargs: self._exec(ctxt, *args, |
| 327 **kwargs) | |
| 328 return [] | |
| 329 | |
| 330 def _exec(self, ctxt, *args, **kwargs): | |
| 331 scope = {} | |
| 332 args = list(args) # make mutable | |
| 333 for name in self.args: | |
| 334 if args: | |
| 335 scope[name] = args.pop(0) | |
| 336 else: | |
| 337 scope[name] = kwargs.pop(name, self.defaults.get(name)) | |
| 338 ctxt.push(**scope) | |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
339 for event in _apply_directives(self.stream, ctxt, self.directives): |
| 1 | 340 yield event |
| 341 ctxt.pop() | |
| 342 | |
| 343 | |
| 344 class ForDirective(Directive): | |
| 31 | 345 """Implementation of the `py:for` template directive for repeating an |
| 346 element based on an iterable in the context data. | |
| 1 | 347 |
| 348 >>> ctxt = Context(items=[1, 2, 3]) | |
| 61 | 349 >>> tmpl = Template('''<ul xmlns:py="http://markup.edgewall.org/"> |
| 1 | 350 ... <li py:for="item in items">${item}</li> |
| 351 ... </ul>''') | |
| 352 >>> print tmpl.generate(ctxt) | |
| 353 <ul> | |
| 354 <li>1</li><li>2</li><li>3</li> | |
| 355 </ul> | |
| 356 """ | |
| 357 __slots__ = ['targets'] | |
| 358 | |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
359 ATTRIBUTE = 'each' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
360 |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
361 def __init__(self, value, filename=None, lineno=-1, offset=-1): |
|
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
|
362 targets, value = value.split(' in ', 1) |
| 1 | 363 self.targets = [str(name.strip()) for name in targets.split(',')] |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
364 Directive.__init__(self, value, filename, lineno, offset) |
| 1 | 365 |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
366 def __call__(self, stream, ctxt, directives): |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
367 iterable = self.expr.evaluate(ctxt) |
| 1 | 368 if iterable is not None: |
| 369 stream = list(stream) | |
|
92
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
370 scope = {} |
|
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
371 targets = self.targets |
| 1 | 372 for item in iter(iterable): |
|
92
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
373 if len(targets) == 1: |
|
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
374 scope[targets[0]] = item |
|
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
375 else: |
|
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
376 for idx, name in enumerate(targets): |
|
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
377 scope[name] = item[idx] |
| 1 | 378 ctxt.push(**scope) |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
379 for event in _apply_directives(stream, ctxt, directives): |
| 1 | 380 yield event |
| 381 ctxt.pop() | |
| 382 | |
| 383 def __repr__(self): | |
| 384 return '<%s "%s in %s">' % (self.__class__.__name__, | |
| 385 ', '.join(self.targets), self.expr.source) | |
| 386 | |
| 387 | |
| 388 class IfDirective(Directive): | |
| 31 | 389 """Implementation of the `py:if` template directive for conditionally |
| 390 excluding elements from being output. | |
| 1 | 391 |
| 392 >>> ctxt = Context(foo=True, bar='Hello') | |
| 61 | 393 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 394 ... <b py:if="foo">${bar}</b> |
| 395 ... </div>''') | |
| 396 >>> print tmpl.generate(ctxt) | |
| 397 <div> | |
| 398 <b>Hello</b> | |
| 399 </div> | |
| 400 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
401 __slots__ = [] |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
402 |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
403 ATTRIBUTE = 'test' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
404 |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
405 def __call__(self, stream, ctxt, directives): |
| 1 | 406 if self.expr.evaluate(ctxt): |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
407 return _apply_directives(stream, ctxt, directives) |
| 1 | 408 return [] |
| 409 | |
| 410 | |
| 411 class MatchDirective(Directive): | |
| 412 """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
|
413 |
| 61 | 414 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
|
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
|
415 ... <span py:match="greeting"> |
| 1 | 416 ... Hello ${select('@name')} |
| 417 ... </span> | |
| 418 ... <greeting name="Dude" /> | |
| 419 ... </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
|
420 >>> print tmpl.generate() |
| 1 | 421 <div> |
| 422 <span> | |
| 423 Hello Dude | |
| 424 </span> | |
| 425 </div> | |
| 426 """ | |
| 427 __slots__ = ['path', 'stream'] | |
| 428 | |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
429 ATTRIBUTE = 'path' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
430 |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
431 def __init__(self, value, filename=None, lineno=-1, offset=-1): |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
432 Directive.__init__(self, None, filename, lineno, offset) |
|
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
|
433 self.path = Path(value) |
| 1 | 434 self.stream = [] |
| 435 | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
436 def __call__(self, stream, ctxt, directives): |
| 1 | 437 self.stream = list(stream) |
|
38
ee669cb9cccc
Fix for #2 (incorrect context node in path expressions). Still some paths that produce incorrect results, but the common case seems to work now.
cmlenz
parents:
37
diff
changeset
|
438 ctxt._match_templates.append((self.path.test(ignore_context=True), |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
439 self.path, self.stream, directives)) |
| 1 | 440 return [] |
| 441 | |
| 442 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
|
443 return '<%s "%s">' % (self.__class__.__name__, self.path.source) |
| 1 | 444 |
| 445 | |
| 446 class ReplaceDirective(Directive): | |
| 447 """Implementation of the `py:replace` template directive. | |
| 448 | |
| 31 | 449 This directive replaces the element with the result of evaluating the |
| 450 value of the `py:replace` attribute: | |
| 451 | |
| 1 | 452 >>> ctxt = Context(bar='Bye') |
| 61 | 453 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 454 ... <span py:replace="bar">Hello</span> |
| 455 ... </div>''') | |
| 456 >>> print tmpl.generate(ctxt) | |
| 457 <div> | |
| 458 Bye | |
| 459 </div> | |
| 460 | |
| 461 This directive is equivalent to `py:content` combined with `py:strip`, | |
| 462 providing a less verbose way to achieve the same effect: | |
| 463 | |
| 464 >>> ctxt = Context(bar='Bye') | |
| 61 | 465 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 466 ... <span py:content="bar" py:strip="">Hello</span> |
| 467 ... </div>''') | |
| 468 >>> print tmpl.generate(ctxt) | |
| 469 <div> | |
| 470 Bye | |
| 471 </div> | |
| 472 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
473 __slots__ = [] |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
474 |
| 54 | 475 def __call__(self, stream, ctxt, directives): |
| 1 | 476 kind, data, pos = stream.next() |
| 69 | 477 yield EXPR, self.expr, pos |
| 1 | 478 |
| 479 | |
| 480 class StripDirective(Directive): | |
| 481 """Implementation of the `py:strip` template directive. | |
| 482 | |
| 483 When the value of the `py:strip` attribute evaluates to `True`, the element | |
| 484 is stripped from the output | |
| 485 | |
| 61 | 486 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 487 ... <div py:strip="True"><b>foo</b></div> |
| 488 ... </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
|
489 >>> print tmpl.generate() |
| 1 | 490 <div> |
| 491 <b>foo</b> | |
| 492 </div> | |
| 493 | |
|
37
37557b8fb925
Moved some of the tests for the strip directive to a new unittest test case to not clutter up the documentation.
cmlenz
parents:
36
diff
changeset
|
494 Leaving the attribute value empty is equivalent to a truth value. |
| 1 | 495 |
| 496 This directive is particulary interesting for named template functions or | |
| 497 match templates that do not generate a top-level element: | |
| 498 | |
| 61 | 499 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/"> |
| 1 | 500 ... <div py:def="echo(what)" py:strip=""> |
| 501 ... <b>${what}</b> | |
| 502 ... </div> | |
| 503 ... ${echo('foo')} | |
| 504 ... </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
|
505 >>> print tmpl.generate() |
| 1 | 506 <div> |
| 507 <b>foo</b> | |
| 508 </div> | |
| 509 """ | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
510 __slots__ = [] |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
511 |
| 54 | 512 def __call__(self, stream, ctxt, directives): |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
513 def _generate(): |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
514 if self.expr: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
515 strip = self.expr.evaluate(ctxt) |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
516 else: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
517 strip = True |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
518 if strip: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
519 stream.next() # skip start tag |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
520 previous = stream.next() |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
521 for event in stream: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
522 yield previous |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
523 previous = event |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
524 else: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
525 for event in stream: |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
526 yield event |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
527 |
|
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
528 return _apply_directives(_generate(), ctxt, directives) |
| 1 | 529 |
| 530 | |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
531 class ChooseDirective(Directive): |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
532 """Implementation of the `py:choose` directive for conditionally selecting |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
533 one of several body elements to display. |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
534 |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
535 If the `py:choose` expression is empty the expressions of nested `py:when` |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
536 directives are tested for truth. The first true `py:when` body is output. |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
537 If no `py:when` directive is matched then the fallback directive |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
538 `py:otherwise` will be used. |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
539 |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
540 >>> ctxt = Context() |
| 61 | 541 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/" |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
542 ... py:choose=""> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
543 ... <span py:when="0 == 1">0</span> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
544 ... <span py:when="1 == 1">1</span> |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
545 ... <span py:otherwise="">2</span> |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
546 ... </div>''') |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
547 >>> print tmpl.generate(ctxt) |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
548 <div> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
549 <span>1</span> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
550 </div> |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
551 |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
552 If the `py:choose` directive contains an expression, the nested `py:when` |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
553 directives are tested for equality to the `py:choose` expression: |
|
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
554 |
| 61 | 555 >>> tmpl = Template('''<div xmlns:py="http://markup.edgewall.org/" |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
556 ... py:choose="2"> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
557 ... <span py:when="1">1</span> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
558 ... <span py:when="2">2</span> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
559 ... </div>''') |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
560 >>> print tmpl.generate(ctxt) |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
561 <div> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
562 <span>2</span> |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
563 </div> |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
564 |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
565 Behavior is undefined if a `py:choose` block contains content outside a |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
566 `py:when` or `py:otherwise` block. Behavior is also undefined if a |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
567 `py:otherwise` occurs before `py:when` blocks. |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
568 """ |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
569 __slots__ = ['matched', 'value'] |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
570 |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
571 ATTRIBUTE = 'test' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
572 |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
573 def __call__(self, stream, ctxt, directives): |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
574 if self.expr: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
575 self.value = self.expr.evaluate(ctxt) |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
576 self.matched = False |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
577 ctxt.push(_choose=self) |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
578 for event in _apply_directives(stream, ctxt, directives): |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
579 yield event |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
580 ctxt.pop() |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
581 |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
582 |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
583 class WhenDirective(Directive): |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
584 """Implementation of the `py:when` directive for nesting in a parent with |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
585 the `py:choose` directive. |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
586 |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
587 See the documentation of `py:choose` for usage. |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
588 """ |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
589 |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
590 ATTRIBUTE = 'test' |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
591 |
| 54 | 592 def __call__(self, stream, ctxt, directives): |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
593 choose = ctxt['_choose'] |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
594 if choose.matched: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
595 return [] |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
596 value = self.expr.evaluate(ctxt) |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
597 try: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
598 if value == choose.value: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
599 choose.matched = True |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
600 return _apply_directives(stream, ctxt, directives) |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
601 except AttributeError: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
602 if value: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
603 choose.matched = True |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
604 return _apply_directives(stream, ctxt, directives) |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
605 return [] |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
606 |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
607 |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
608 class OtherwiseDirective(Directive): |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
609 """Implementation of the `py:otherwise` directive for nesting in a parent |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
610 with the `py:choose` directive. |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
611 |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
612 See the documentation of `py:choose` for usage. |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
613 """ |
| 54 | 614 def __call__(self, stream, ctxt, directives): |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
615 choose = ctxt['_choose'] |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
616 if choose.matched: |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
617 return [] |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
618 choose.matched = True |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
619 return _apply_directives(stream, ctxt, directives) |
|
44
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
620 |
|
436e30c8420b
implement `py:choose/when/otherwise` directives for conditionally selecting one of several blocks
mgood
parents:
38
diff
changeset
|
621 |
| 1 | 622 class Template(object): |
| 623 """Can parse a template and transform it into the corresponding output | |
| 624 based on context data. | |
| 625 """ | |
| 61 | 626 NAMESPACE = Namespace('http://markup.edgewall.org/') |
| 1 | 627 |
|
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
|
628 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
|
629 SUB = StreamEventKind('SUB') # a "subprogram" |
|
10
f77f7a91aa46
Moved the template-specific stream event kinds into the template module.
cmlenz
parents:
6
diff
changeset
|
630 |
| 1 | 631 directives = [('def', DefDirective), |
| 632 ('match', MatchDirective), | |
| 633 ('for', ForDirective), | |
| 634 ('if', IfDirective), | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
635 ('when', WhenDirective), |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
636 ('otherwise', OtherwiseDirective), |
|
53
512eb72dbb19
* Add helper function to let directives apply any remaining directives, and use that helper consistently in every directive.
cmlenz
parents:
51
diff
changeset
|
637 ('choose', ChooseDirective), |
| 1 | 638 ('replace', ReplaceDirective), |
| 639 ('content', ContentDirective), | |
| 640 ('attrs', AttrsDirective), | |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
641 ('strip', StripDirective)] |
| 1 | 642 _dir_by_name = dict(directives) |
| 643 _dir_order = [directive[1] for directive in directives] | |
| 644 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
645 def __init__(self, source, basedir=None, filename=None): |
| 1 | 646 """Initialize a template from either a string or a file-like object.""" |
| 647 if isinstance(source, basestring): | |
| 648 self.source = StringIO(source) | |
| 649 else: | |
| 650 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
|
651 self.basedir = basedir |
| 1 | 652 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
|
653 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
|
654 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
|
655 else: |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
656 self.filepath = '<string>' |
| 1 | 657 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
658 self.filters = [] |
| 1 | 659 self.parse() |
| 660 | |
| 661 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
|
662 return '<%s "%s">' % (self.__class__.__name__, self.filename) |
| 1 | 663 |
| 664 def parse(self): | |
| 665 """Parse the template. | |
| 666 | |
| 667 The parsing stage parses the XML template and constructs a list of | |
| 668 directives that will be executed in the render stage. The input is | |
| 669 split up into literal output (markup that does not depend on the | |
| 670 context data) and actual directives (commands or variable | |
| 671 substitution). | |
| 672 """ | |
| 673 stream = [] # list of events of the "compiled" template | |
| 674 dirmap = {} # temporary mapping of directives to elements | |
| 675 ns_prefix = {} | |
| 676 depth = 0 | |
| 677 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
678 for kind, data, pos in XMLParser(self.source, filename=self.filename): |
| 1 | 679 |
| 69 | 680 if kind is START_NS: |
| 1 | 681 # Strip out the namespace declaration for template directives |
| 682 prefix, uri = data | |
| 683 if uri == self.NAMESPACE: | |
| 684 ns_prefix[prefix] = uri | |
| 685 else: | |
| 686 stream.append((kind, data, pos)) | |
| 687 | |
| 69 | 688 elif kind is END_NS: |
| 1 | 689 if data in ns_prefix: |
| 690 del ns_prefix[data] | |
| 691 else: | |
| 692 stream.append((kind, data, pos)) | |
| 693 | |
| 69 | 694 elif kind is START: |
| 1 | 695 # Record any directive attributes in start tags |
| 696 tag, attrib = data | |
| 697 directives = [] | |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
698 strip = False |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
699 |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
700 if tag in self.NAMESPACE: |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
701 cls = self._dir_by_name.get(tag.localname) |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
702 if cls is None: |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
703 raise BadDirectiveError(tag, pos[0], pos[1]) |
|
66
59eb24184e9c
Switch copyright to Edgewall and URLs to markup.edgewall.org.
cmlenz
parents:
65
diff
changeset
|
704 value = attrib.get(getattr(cls, 'ATTRIBUTE', None), '') |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
705 directives.append(cls(value, *pos)) |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
706 strip = True |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
707 |
| 1 | 708 new_attrib = [] |
| 709 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
|
710 if name in self.NAMESPACE: |
| 1 | 711 cls = self._dir_by_name.get(name.localname) |
| 712 if cls is None: | |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
713 raise BadDirectiveError(name, pos[0], pos[1]) |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
714 directives.append(cls(value, *pos)) |
| 1 | 715 else: |
|
75
3722696d0343
Empty attributes in templates were being stripped out. Thanks to Jonas for the patch.
cmlenz
parents:
74
diff
changeset
|
716 if value: |
|
3722696d0343
Empty attributes in templates were being stripped out. Thanks to Jonas for the patch.
cmlenz
parents:
74
diff
changeset
|
717 value = list(self._interpolate(value, *pos)) |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
718 if len(value) == 1 and value[0][0] is TEXT: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
719 value = value[0][1] |
|
75
3722696d0343
Empty attributes in templates were being stripped out. Thanks to Jonas for the patch.
cmlenz
parents:
74
diff
changeset
|
720 else: |
|
3722696d0343
Empty attributes in templates were being stripped out. Thanks to Jonas for the patch.
cmlenz
parents:
74
diff
changeset
|
721 value = [(TEXT, u'', pos)] |
| 1 | 722 new_attrib.append((name, value)) |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
723 |
| 1 | 724 if directives: |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
725 directives.sort(lambda a, b: cmp(self._dir_order.index(a.__class__), |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
726 self._dir_order.index(b.__class__))) |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
727 dirmap[(depth, tag)] = (directives, len(stream), strip) |
| 1 | 728 |
| 729 stream.append((kind, (tag, Attributes(new_attrib)), pos)) | |
| 730 depth += 1 | |
| 731 | |
| 69 | 732 elif kind is END: |
| 1 | 733 depth -= 1 |
| 734 stream.append((kind, data, pos)) | |
| 735 | |
| 736 # If there have have directive attributes with the corresponding | |
| 737 # start tag, move the events inbetween into a "subprogram" | |
| 738 if (depth, data) in dirmap: | |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
739 directives, start_offset, strip = dirmap.pop((depth, data)) |
| 1 | 740 substream = stream[start_offset:] |
|
65
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
741 if strip: |
|
b3fdf93057ab
Support the use of directives as elements to reduce the need for using `py:strip`.
cmlenz
parents:
61
diff
changeset
|
742 substream = substream[1:-1] |
| 69 | 743 stream[start_offset:] = [(SUB, (directives, substream), |
| 744 pos)] | |
| 1 | 745 |
| 69 | 746 elif kind is TEXT: |
| 1 | 747 for kind, data, pos in self._interpolate(data, *pos): |
| 748 stream.append((kind, data, pos)) | |
| 749 | |
|
89
80386d62814f
Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents:
87
diff
changeset
|
750 elif kind is COMMENT: |
|
80386d62814f
Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents:
87
diff
changeset
|
751 if not data.lstrip().startswith('!'): |
|
80386d62814f
Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents:
87
diff
changeset
|
752 stream.append((kind, data, pos)) |
|
80386d62814f
Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents:
87
diff
changeset
|
753 |
| 1 | 754 else: |
| 755 stream.append((kind, data, pos)) | |
| 756 | |
| 757 self.stream = stream | |
| 758 | |
| 759 _FULL_EXPR_RE = re.compile(r'(?<!\$)\$\{(.+?)\}') | |
| 760 _SHORT_EXPR_RE = re.compile(r'(?<!\$)\$([a-zA-Z][a-zA-Z0-9_\.]*)') | |
| 761 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
762 def _interpolate(cls, text, filename=None, lineno=-1, offset=-1): |
| 1 | 763 """Parse the given string and extract expressions. |
| 764 | |
| 765 This method returns a list containing both literal text and `Expression` | |
| 766 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
|
767 |
| 1 | 768 @param text: the text to parse |
| 769 @param lineno: the line number at which the text was found (optional) | |
| 770 @param offset: the column number at which the text starts in the source | |
| 771 (optional) | |
| 772 """ | |
|
74
d54b5fd60b52
Fix expression interpolation where both shorthand notation and full notation are used inside a single text node. Thanks Jonas.
cmlenz
parents:
73
diff
changeset
|
773 def _interpolate(text, patterns): |
| 1 | 774 for idx, group in enumerate(patterns.pop(0).split(text)): |
| 775 if idx % 2: | |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
776 try: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
777 yield EXPR, Expression(group, filename, lineno), \ |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
778 (lineno, offset) |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
779 except SyntaxError, err: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
780 raise TemplateSyntaxError(err, filename, lineno, |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
781 offset + (err.offset or 0)) |
| 1 | 782 elif group: |
| 783 if patterns: | |
|
74
d54b5fd60b52
Fix expression interpolation where both shorthand notation and full notation are used inside a single text node. Thanks Jonas.
cmlenz
parents:
73
diff
changeset
|
784 for result in _interpolate(group, patterns[:]): |
| 1 | 785 yield result |
| 786 else: | |
| 69 | 787 yield TEXT, group.replace('$$', '$'), (filename, lineno, |
| 788 offset) | |
|
74
d54b5fd60b52
Fix expression interpolation where both shorthand notation and full notation are used inside a single text node. Thanks Jonas.
cmlenz
parents:
73
diff
changeset
|
789 return _interpolate(text, [cls._FULL_EXPR_RE, cls._SHORT_EXPR_RE]) |
| 1 | 790 _interpolate = classmethod(_interpolate) |
| 791 | |
|
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
|
792 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
|
793 """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
|
794 |
|
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
|
795 @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
|
796 @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
|
797 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
|
798 """ |
|
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
|
799 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
|
800 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
|
801 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
|
802 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
|
803 |
| 69 | 804 stream = self.stream |
| 805 for filter_ in [self._eval, self._match, self._flatten] + self.filters: | |
|
35
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
806 stream = filter_(iter(stream), ctxt) |
|
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
807 return Stream(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
|
808 |
|
77
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
809 def _ensure(self, stream, ctxt=None): |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
810 """Ensure that every item on the stream is actually a markup event.""" |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
811 for event in stream: |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
812 try: |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
813 kind, data, pos = event |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
814 except ValueError: |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
815 kind, data, pos = event.totuple() |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
816 yield kind, data, pos |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
817 |
|
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
|
818 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
|
819 """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
|
820 `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
|
821 """ |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
822 filters = (self._ensure, self._eval, self._match) |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
823 |
|
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
|
824 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
|
825 |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
826 if kind is START and data[1]: |
|
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
|
827 # 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
|
828 # 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
|
829 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
|
830 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
|
831 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
|
832 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
|
833 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
|
834 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
|
835 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
|
836 for subkind, subdata, subpos in substream: |
| 69 | 837 if subkind is EXPR: |
|
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
|
838 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
|
839 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
|
840 values.append(subdata) |
|
48
a5d585dd38c4
convert the result of expressions in attributes to strings so that values like ints are output correctly
mgood
parents:
44
diff
changeset
|
841 value = [unicode(x) for x in values if x is not None] |
|
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
|
842 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
|
843 continue |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
844 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
|
845 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
|
846 |
| 69 | 847 elif kind is EXPR: |
|
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
|
848 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
|
849 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
|
850 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
|
851 |
|
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
|
852 # 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
|
853 # 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
|
854 # 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
|
855 if isinstance(result, basestring): |
| 69 | 856 yield TEXT, 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
|
857 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
|
858 # 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
|
859 # 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
|
860 try: |
|
77
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
861 substream = iter(result) |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
862 for filter_ in filters: |
|
77
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
863 substream = filter_(substream, ctxt) |
|
f5ec6d4a61e4
* Simplify implementation of the individual XPath tests (use closures instead of callable classes)
cmlenz
parents:
75
diff
changeset
|
864 for event in substream: |
|
35
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
865 yield event |
|
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
|
866 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
|
867 # 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
|
868 # through |
| 69 | 869 yield 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
|
870 |
|
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
|
871 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
|
872 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
|
873 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
874 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
|
875 """Internal stream filter that expands `SUB` events in the stream.""" |
|
81
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
876 for kind, data, pos in stream: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
877 if kind is SUB: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
878 # This event is a list of directives and a list of nested |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
879 # events to which those directives should be applied |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
880 directives, substream = data |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
881 substream = _apply_directives(substream, ctxt, directives) |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
882 for filter_ in (self._eval, self._match, self._flatten): |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
883 substream = filter_(substream, ctxt) |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
884 for event in substream: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
885 yield event |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
886 else: |
|
d60486018004
Template expressions are now compiled to Python bytecode.
cmlenz
parents:
80
diff
changeset
|
887 yield kind, data, 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
|
888 |
|
36
ed370ebfa794
Fix for #7: match templates no longer process their own output.
cmlenz
parents:
35
diff
changeset
|
889 def _match(self, stream, ctxt=None, match_templates=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
|
890 """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
|
891 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
|
892 """ |
|
36
ed370ebfa794
Fix for #7: match templates no longer process their own output.
cmlenz
parents:
35
diff
changeset
|
893 if match_templates is None: |
|
ed370ebfa794
Fix for #7: match templates no longer process their own output.
cmlenz
parents:
35
diff
changeset
|
894 match_templates = ctxt._match_templates |
|
ed370ebfa794
Fix for #7: match templates no longer process their own output.
cmlenz
parents:
35
diff
changeset
|
895 |
|
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
|
896 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
|
897 |
|
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
|
898 # 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
|
899 # We might care about namespace events in the future, though |
|
92
01d36818bb3d
More performance improvements... this time for whitespace normalization and template loops.
cmlenz
parents:
90
diff
changeset
|
900 if not match_templates or kind not in (START, END): |
|
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
|
901 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
|
902 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
|
903 |
|
50
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
904 for idx, (test, path, template, directives) in \ |
|
d3842cd76e92
Fix the way multiple directives are applied to a single `SUB` in many cases by making the directives themselves responsible for applying any remaining directives.
cmlenz
parents:
48
diff
changeset
|
905 enumerate(match_templates): |
|
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
|
906 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
|
907 |
|
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
|
908 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
|
909 # 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
|
910 # 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
|
911 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
|
912 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
|
913 while depth > 0: |
| 73 | 914 kind, data, pos = stream.next() |
| 915 if kind is START: | |
| 916 depth += 1 | |
| 917 elif kind is END: | |
| 918 depth -= 1 | |
| 919 content.append((kind, data, pos)) | |
| 920 test(kind, data, 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
|
921 |
|
23
d88358f719fa
Separate match and eval filters from the include and user-supplied filters.
cmlenz
parents:
22
diff
changeset
|
922 content = list(self._flatten(content, ctxt)) |
|
35
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
923 ctxt.push(select=lambda path: Stream(content).select(path)) |
|
36
ed370ebfa794
Fix for #7: match templates no longer process their own output.
cmlenz
parents:
35
diff
changeset
|
924 |
|
78
46fed54f23cd
Minor improvements to how directives are applied in template processing.
cmlenz
parents:
77
diff
changeset
|
925 template = _apply_directives(template, ctxt, directives) |
| 69 | 926 for event in self._match(self._eval(template, ctxt), |
| 927 ctxt, match_templates[:idx] + | |
| 928 match_templates[idx + 1:]): | |
|
35
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
929 yield event |
|
35b9e9318fb1
Simplify template processing model by removing dynamically generated `SUB` events.
cmlenz
parents:
31
diff
changeset
|
930 ctxt.pop() |
|
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
|
931 |
|
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
|
932 break |
| 69 | 933 |
| 934 else: # no matches | |
|
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
|
935 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
|
936 |
| 1 | 937 |
| 69 | 938 EXPR = Template.EXPR |
| 939 SUB = Template.SUB | |
| 940 | |
| 941 | |
| 1 | 942 class TemplateLoader(object): |
| 943 """Responsible for loading templates from files on the specified search | |
| 944 path. | |
| 945 | |
| 946 >>> import tempfile | |
| 947 >>> fd, path = tempfile.mkstemp(suffix='.html', prefix='template') | |
| 948 >>> os.write(fd, '<p>$var</p>') | |
| 949 11 | |
| 950 >>> os.close(fd) | |
| 951 | |
| 952 The template loader accepts a list of directory paths that are then used | |
| 953 when searching for template files, in the given order: | |
| 954 | |
| 955 >>> loader = TemplateLoader([os.path.dirname(path)]) | |
| 956 | |
| 957 The `load()` method first checks the template cache whether the requested | |
| 958 template has already been loaded. If not, it attempts to locate the | |
| 959 template file, and returns the corresponding `Template` object: | |
| 960 | |
| 961 >>> template = loader.load(os.path.basename(path)) | |
| 962 >>> isinstance(template, Template) | |
| 963 True | |
| 964 | |
| 965 Template instances are cached: requesting a template with the same name | |
| 966 results in the same instance being returned: | |
| 967 | |
| 968 >>> loader.load(os.path.basename(path)) is template | |
| 969 True | |
| 970 """ | |
| 971 def __init__(self, search_path=None, auto_reload=False): | |
| 972 """Create the template laoder. | |
| 973 | |
| 974 @param search_path: a list of absolute path names that should be | |
| 975 searched for template files | |
| 976 @param auto_reload: whether to check the last modification time of | |
| 977 template files, and reload them if they have changed | |
| 978 """ | |
| 979 self.search_path = search_path | |
| 980 if self.search_path is None: | |
| 981 self.search_path = [] | |
| 982 self.auto_reload = auto_reload | |
| 983 self._cache = {} | |
| 984 self._mtime = {} | |
| 985 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
986 def load(self, filename, relative_to=None): |
| 1 | 987 """Load the template with the given name. |
| 988 | |
|
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
|
989 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
|
990 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
|
991 name is an absolute path, the search path is not bypassed. |
| 1 | 992 |
|
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
|
993 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
|
994 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
|
995 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
|
996 |
|
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
|
997 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
|
998 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
|
999 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
|
1000 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
|
1001 changed since the last parse.) |
| 1 | 1002 |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
1003 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
|
1004 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
|
1005 |
| 1 | 1006 @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
|
1007 @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
|
1008 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
|
1009 directly |
| 1 | 1010 """ |
| 69 | 1011 from markup.filters import IncludeFilter |
| 1012 | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
1013 if relative_to: |
|
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
1014 filename = posixpath.join(posixpath.dirname(relative_to), filename) |
| 1 | 1015 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
|
1016 |
|
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
|
1017 # First check the cache to avoid reparsing the same file |
| 1 | 1018 try: |
| 1019 tmpl = self._cache[filename] | |
| 1020 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
|
1021 os.path.getmtime(tmpl.filepath) == self._mtime[filename]: |
| 1 | 1022 return tmpl |
| 1023 except KeyError: | |
| 1024 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
|
1025 |
|
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
|
1026 # 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
|
1027 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
|
1028 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
|
1029 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
|
1030 |
|
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
|
1031 for dirname in search_path: |
| 1 | 1032 filepath = os.path.join(dirname, filename) |
| 1033 try: | |
| 1034 fileobj = file(filepath, 'rt') | |
| 1035 try: | |
|
21
b4d17897d053
* Include paths are now interpreted relative to the path of the including template. Closes #3.
cmlenz
parents:
18
diff
changeset
|
1036 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
|
1037 tmpl.filters.append(IncludeFilter(self)) |
| 1 | 1038 finally: |
| 1039 fileobj.close() | |
| 1040 self._cache[filename] = tmpl | |
| 1041 self._mtime[filename] = os.path.getmtime(filepath) | |
| 1042 return tmpl | |
| 1043 except IOError: | |
| 1044 continue | |
| 1045 raise TemplateNotFound(filename, self.search_path) |