annotate markup/template.py @ 145:47bbd9d2a5af trunk

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