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