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