annotate genshi/template/base.py @ 820:1837f39efd6f experimental-inline

Sync (old) experimental inline branch with trunk@1027.
author cmlenz
date Wed, 11 Mar 2009 17:51:06 +0000
parents 0742f421caba
children eb8aa8690480
rev   line source
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
2 #
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
3 # Copyright (C) 2006-2008 Edgewall Software
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
4 # All rights reserved.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
5 #
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
8 # are also available at http://genshi.edgewall.org/wiki/License.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
9 #
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
12 # history and logs, available at http://genshi.edgewall.org/log/.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
13
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
14 """Basic templating functionality."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
15
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
16 try:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
17 from collections import deque
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
18 except ImportError:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
19 class deque(list):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
20 def appendleft(self, x): self.insert(0, x)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
21 def popleft(self): return self.pop(0)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
22 import os
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
23 from StringIO import StringIO
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
24 import sys
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
25
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
26 from genshi.core import Attrs, Stream, StreamEventKind, START, TEXT, _ensure
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
27 from genshi.input import ParseError
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
28
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
29 __all__ = ['Context', 'DirectiveFactory', 'Template', 'TemplateError',
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
30 'TemplateRuntimeError', 'TemplateSyntaxError', 'BadDirectiveError']
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
31 __docformat__ = 'restructuredtext en'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
32
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
33
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
34 class TemplateError(Exception):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
35 """Base exception class for errors related to template processing."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
36
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
37 def __init__(self, message, filename=None, lineno=-1, offset=-1):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
38 """Create the exception.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
39
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
40 :param message: the error message
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
41 :param filename: the filename of the template
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
42 :param lineno: the number of line in the template at which the error
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
43 occurred
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
44 :param offset: the column number at which the error occurred
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
45 """
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
46 if filename is None:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
47 filename = '<string>'
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
48 self.msg = message #: the error message string
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
49 if filename != '<string>' or lineno >= 0:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
50 message = '%s (%s, line %d)' % (self.msg, filename, lineno)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
51 Exception.__init__(self, message)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
52 self.filename = filename #: the name of the template file
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
53 self.lineno = lineno #: the number of the line containing the error
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
54 self.offset = offset #: the offset on the line
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
55
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
56
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
57 class TemplateSyntaxError(TemplateError):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
58 """Exception raised when an expression in a template causes a Python syntax
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
59 error, or the template is not well-formed.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
60 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
61
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
62 def __init__(self, message, filename=None, lineno=-1, offset=-1):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
63 """Create the exception
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
64
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
65 :param message: the error message
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
66 :param filename: the filename of the template
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
67 :param lineno: the number of line in the template at which the error
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
68 occurred
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
69 :param offset: the column number at which the error occurred
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
70 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
71 if isinstance(message, SyntaxError) and message.lineno is not None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
72 message = str(message).replace(' (line %d)' % message.lineno, '')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
73 TemplateError.__init__(self, message, filename, lineno)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
74
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
75
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
76 class BadDirectiveError(TemplateSyntaxError):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
77 """Exception raised when an unknown directive is encountered when parsing
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
78 a template.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
79
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
80 An unknown directive is any attribute using the namespace for directives,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
81 with a local name that doesn't match any registered directive.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
82 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
83
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
84 def __init__(self, name, filename=None, lineno=-1):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
85 """Create the exception
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
86
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
87 :param name: the name of the directive
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
88 :param filename: the filename of the template
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
89 :param lineno: the number of line in the template at which the error
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
90 occurred
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
91 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
92 TemplateSyntaxError.__init__(self, 'bad directive "%s"' % name,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
93 filename, lineno)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
94
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
95
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
96 class TemplateRuntimeError(TemplateError):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
97 """Exception raised when an the evaluation of a Python expression in a
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
98 template causes an error.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
99 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
100
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
101
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
102 class Context(object):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
103 """Container for template input data.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
104
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
105 A context provides a stack of scopes (represented by dictionaries).
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
106
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
107 Template directives such as loops can push a new scope on the stack with
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
108 data that should only be available inside the loop. When the loop
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
109 terminates, that scope can get popped off the stack again.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
110
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
111 >>> ctxt = Context(one='foo', other=1)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
112 >>> ctxt.get('one')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
113 'foo'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
114 >>> ctxt.get('other')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
115 1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
116 >>> ctxt.push(dict(one='frost'))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
117 >>> ctxt.get('one')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
118 'frost'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
119 >>> ctxt.get('other')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
120 1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
121 >>> ctxt.pop()
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
122 {'one': 'frost'}
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
123 >>> ctxt.get('one')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
124 'foo'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
125 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
126
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
127 def __init__(self, **data):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
128 """Initialize the template context with the given keyword arguments as
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
129 data.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
130 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
131 self.frames = deque([data])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
132 self.pop = self.frames.popleft
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
133 self.push = self.frames.appendleft
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
134 self._match_templates = []
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
135 self._choice_stack = []
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
136
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
137 # Helper functions for use in expressions
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
138 def defined(name):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
139 """Return whether a variable with the specified name exists in the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
140 expression scope."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
141 return name in self
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
142 def value_of(name, default=None):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
143 """If a variable of the specified name is defined, return its value.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
144 Otherwise, return the provided default value, or ``None``."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
145 return self.get(name, default)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
146 data.setdefault('defined', defined)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
147 data.setdefault('value_of', value_of)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
148
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
149 def __repr__(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
150 return repr(list(self.frames))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
151
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
152 def __contains__(self, key):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
153 """Return whether a variable exists in any of the scopes.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
154
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
155 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
156 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
157 return self._find(key)[1] is not None
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
158 has_key = __contains__
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
159
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
160 def __delitem__(self, key):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
161 """Remove a variable from all scopes.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
162
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
163 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
164 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
165 for frame in self.frames:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
166 if key in frame:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
167 del frame[key]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
168
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
169 def __getitem__(self, key):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
170 """Get a variables's value, starting at the current scope and going
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
171 upward.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
172
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
173 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
174 :return: the variable value
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
175 :raises KeyError: if the requested variable wasn't found in any scope
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
176 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
177 value, frame = self._find(key)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
178 if frame is None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
179 raise KeyError(key)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
180 return value
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
181
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
182 def __len__(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
183 """Return the number of distinctly named variables in the context.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
184
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
185 :return: the number of variables in the context
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
186 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
187 return len(self.items())
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
188
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
189 def __setitem__(self, key, value):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
190 """Set a variable in the current scope.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
191
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
192 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
193 :param value: the variable value
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
194 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
195 self.frames[0][key] = value
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
196
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
197 def _find(self, key, default=None):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
198 """Retrieve a given variable's value and the frame it was found in.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
199
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
200 Intended primarily for internal use by directives.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
201
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
202 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
203 :param default: the default value to return when the variable is not
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
204 found
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
205 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
206 for frame in self.frames:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
207 if key in frame:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
208 return frame[key], frame
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
209 return default, None
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
210
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
211 def get(self, key, default=None):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
212 """Get a variable's value, starting at the current scope and going
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
213 upward.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
214
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
215 :param key: the name of the variable
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
216 :param default: the default value to return when the variable is not
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
217 found
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
218 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
219 for frame in self.frames:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
220 if key in frame:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
221 return frame[key]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
222 return default
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
223
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
224 def keys(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
225 """Return the name of all variables in the context.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
226
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
227 :return: a list of variable names
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
228 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
229 keys = []
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
230 for frame in self.frames:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
231 keys += [key for key in frame if key not in keys]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
232 return keys
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
233
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
234 def items(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
235 """Return a list of ``(name, value)`` tuples for all variables in the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
236 context.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
237
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
238 :return: a list of variables
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
239 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
240 return [(key, self.get(key)) for key in self.keys()]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
241
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
242 def update(self, mapping):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
243 """Update the context from the mapping provided."""
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
244 self.frames[0].update(mapping)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
245
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
246 def push(self, data):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
247 """Push a new scope on the stack.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
248
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
249 :param data: the data dictionary to push on the context stack.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
250 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
251
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
252 def pop(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
253 """Pop the top-most scope from the stack."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
254
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
255
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
256 def _apply_directives(stream, directives, ctxt, **vars):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
257 """Apply the given directives to the stream.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
258
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
259 :param stream: the stream the directives should be applied to
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
260 :param directives: the list of directives to apply
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
261 :param ctxt: the `Context`
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
262 :param vars: additional variables that should be available when Python
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
263 code is executed
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
264 :return: the stream with the given directives applied
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
265 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
266 if directives:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
267 stream = directives[0](iter(stream), directives[1:], ctxt, **vars)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
268 return stream
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
269
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
270 def _eval_expr(expr, ctxt, **vars):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
271 """Evaluate the given `Expression` object.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
272
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
273 :param expr: the expression to evaluate
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
274 :param ctxt: the `Context`
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
275 :param vars: additional variables that should be available to the
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
276 expression
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
277 :return: the result of the evaluation
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
278 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
279 if vars:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
280 ctxt.push(vars)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
281 retval = expr.evaluate(ctxt)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
282 if vars:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
283 ctxt.pop()
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
284 return retval
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
285
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
286 def _exec_suite(suite, ctxt, **vars):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
287 """Execute the given `Suite` object.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
288
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
289 :param suite: the code suite to execute
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
290 :param ctxt: the `Context`
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
291 :param vars: additional variables that should be available to the
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
292 code
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
293 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
294 if vars:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
295 ctxt.push(vars)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
296 ctxt.push({})
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
297 suite.execute(ctxt)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
298 if vars:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
299 top = ctxt.pop()
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
300 ctxt.pop()
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
301 ctxt.frames[0].update(top)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
302
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
303
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
304 class DirectiveFactoryMeta(type):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
305 """Meta class for directive factories."""
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
306
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
307 def __new__(cls, name, bases, d):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
308 if 'directives' in d:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
309 d['_dir_by_name'] = dict(d['directives'])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
310 d['_dir_order'] = [directive[1] for directive in d['directives']]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
311
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
312 return type.__new__(cls, name, bases, d)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
313
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
314
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
315 class DirectiveFactory(object):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
316 """Base for classes that provide a set of template directives.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
317
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
318 :since: version 0.6
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
319 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
320 __metaclass__ = DirectiveFactoryMeta
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
321
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
322 directives = []
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
323 """A list of `(name, cls)` tuples that define the set of directives
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
324 provided by this factory.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
325 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
326
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
327 def compare_directives(self):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
328 """Return a function that takes two directive classes and compares
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
329 them to determine their relative ordering.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
330 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
331 def _get_index(cls):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
332 if cls in self._dir_order:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
333 return self._dir_order.index(cls)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
334 return 0
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
335 return lambda a, b: cmp(_get_index(a[0]), _get_index(b[0]))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
336
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
337 def get_directive(self, name):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
338 """Return the directive class for the given name.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
339
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
340 :param name: the directive name as used in the template
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
341 :return: the directive class
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
342 :see: `Directive`
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
343 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
344 return self._dir_by_name.get(name)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
345
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
346
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
347 class Template(DirectiveFactory):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
348 """Abstract template base class.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
349
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
350 This class implements most of the template processing model, but does not
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
351 specify the syntax of templates.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
352 """
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
353
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
354 EXEC = StreamEventKind('EXEC')
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
355 """Stream event kind representing a Python code suite to execute."""
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
356
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
357 EXPR = StreamEventKind('EXPR')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
358 """Stream event kind representing a Python expression."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
359
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
360 INCLUDE = StreamEventKind('INCLUDE')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
361 """Stream event kind representing the inclusion of another template."""
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
362
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
363 SUB = StreamEventKind('SUB')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
364 """Stream event kind representing a nested stream to which one or more
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
365 directives should be applied.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
366 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
367
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
368 serializer = None
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
369 _number_conv = unicode # function used to convert numbers to event data
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
370
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
371 def __init__(self, source, filepath=None, filename=None, loader=None,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
372 encoding=None, lookup='strict', allow_exec=True):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
373 """Initialize a template from either a string, a file-like object, or
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
374 an already parsed markup stream.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
375
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
376 :param source: a string, file-like object, or markup stream to read the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
377 template from
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
378 :param filepath: the absolute path to the template file
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
379 :param filename: the path to the template file relative to the search
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
380 path
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
381 :param loader: the `TemplateLoader` to use for loading included
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
382 templates
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
383 :param encoding: the encoding of the `source`
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
384 :param lookup: the variable lookup mechanism; either "strict" (the
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
385 default), "lenient", or a custom lookup class
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
386 :param allow_exec: whether Python code blocks in templates should be
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
387 allowed
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
388
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
389 :note: Changed in 0.5: Added the `allow_exec` argument
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
390 """
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
391 self.filepath = filepath or filename
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
392 self.filename = filename
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
393 self.loader = loader
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
394 self.lookup = lookup
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
395 self.allow_exec = allow_exec
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
396 self._init_filters()
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
397 self._prepared = False
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
398
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
399 if isinstance(source, basestring):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
400 source = StringIO(source)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
401 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
402 source = source
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
403 try:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
404 self._stream = self._parse(source, encoding)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
405 except ParseError, e:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
406 raise TemplateSyntaxError(e.msg, self.filepath, e.lineno, e.offset)
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
407
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
408 def __getstate__(self):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
409 state = self.__dict__.copy()
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
410 state['filters'] = []
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
411 return state
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
412
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
413 def __setstate__(self, state):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
414 self.__dict__ = state
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
415 self._init_filters()
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
416
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
417 def __repr__(self):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
418 return '<%s "%s">' % (self.__class__.__name__, self.filename)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
419
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
420 def _init_filters(self):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
421 self.filters = [self._flatten]
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
422 if self.loader:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
423 self.filters.append(self._include)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
424
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
425 def _get_stream(self):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
426 if not self._prepared:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
427 self._stream = list(self._prepare(self._stream))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
428 self._prepared = True
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
429 return self._stream
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
430 stream = property(_get_stream)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
431
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
432 def _parse(self, source, encoding):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
433 """Parse the template.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
434
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
435 The parsing stage parses the template and constructs a list of
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
436 directives that will be executed in the render stage. The input is
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
437 split up into literal output (text that does not depend on the context
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
438 data) and directives or expressions.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
439
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
440 :param source: a file-like object containing the XML source of the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
441 template, or an XML event stream
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
442 :param encoding: the encoding of the `source`
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
443 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
444 raise NotImplementedError
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
445
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
446 def _prepare(self, stream):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
447 """Call the `attach` method of every directive found in the template.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
448
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
449 :param stream: the event stream of the template
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
450 """
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
451 from genshi.template.loader import TemplateNotFound
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
452
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
453 for kind, data, pos in stream:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
454 if kind is SUB:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
455 directives = []
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
456 substream = data[1]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
457 for cls, value, namespaces, pos in data[0]:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
458 directive, substream = cls.attach(self, substream, value,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
459 namespaces, pos)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
460 if directive:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
461 directives.append(directive)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
462 substream = self._prepare(substream)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
463 if directives:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
464 yield kind, (directives, list(substream)), pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
465 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
466 for event in substream:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
467 yield event
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
468 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
469 if kind is INCLUDE:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
470 href, cls, fallback = data
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
471 if isinstance(href, basestring) and \
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
472 not getattr(self.loader, 'auto_reload', True):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
473 # If the path to the included template is static, and
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
474 # auto-reloading is disabled on the template loader,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
475 # the template is inlined into the stream
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
476 try:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
477 tmpl = self.loader.load(href, relative_to=pos[0],
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
478 cls=cls or self.__class__)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
479 for event in tmpl.stream:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
480 yield event
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
481 except TemplateNotFound:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
482 if fallback is None:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
483 raise
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
484 for event in self._prepare(fallback):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
485 yield event
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
486 continue
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
487 elif fallback:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
488 # Otherwise the include is performed at run time
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
489 data = href, cls, list(self._prepare(fallback))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
490
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
491 yield kind, data, pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
492
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
493 def compile(self):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
494 """Compile the template to a Python module, and return the module
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
495 object.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
496 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
497 from imp import new_module
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
498 from genshi.template.inline import inline
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
499
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
500 name = (self.filename or '_some_ident').replace('.', '_')
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
501 module = new_module(name)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
502 source = u'\n'.join(list(inline(self)))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
503 code = compile(source, self.filepath or '<string>', 'exec')
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
504 exec code in module.__dict__, module.__dict__
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
505 return module
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
506
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
507 def generate(self, *args, **kwargs):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
508 """Apply the template to the given context data.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
509
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
510 Any keyword arguments are made available to the template as context
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
511 data.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
512
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
513 Only one positional argument is accepted: if it is provided, it must be
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
514 an instance of the `Context` class, and keyword arguments are ignored.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
515 This calling style is used for internal processing.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
516
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
517 :return: a markup event stream representing the result of applying
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
518 the template to the context data.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
519 """
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
520 vars = {}
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
521 if args:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
522 assert len(args) == 1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
523 ctxt = args[0]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
524 if ctxt is None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
525 ctxt = Context(**kwargs)
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
526 else:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
527 vars = kwargs
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
528 assert isinstance(ctxt, Context)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
529 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
530 ctxt = Context(**kwargs)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
531
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
532 stream = self.stream
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
533 for filter_ in self.filters:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
534 stream = filter_(iter(stream), ctxt, **vars)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
535 return Stream(stream, self.serializer)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
536
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
537 def _flatten(self, stream, ctxt, **vars):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
538 number_conv = self._number_conv
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
539
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
540 for kind, data, pos in stream:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
541
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
542 if kind is START and data[1]:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
543 # Attributes may still contain expressions in start tags at
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
544 # this point, so do some evaluation
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
545 tag, attrs = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
546 new_attrs = []
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
547 for name, substream in attrs:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
548 if type(substream) is list:
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
549 values = []
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
550 for event in self._flatten(substream, ctxt, **vars):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
551 if event[0] is TEXT:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
552 values.append(event[1])
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
553 value = [x for x in values if x is not None]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
554 if not value:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
555 continue
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
556 else:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
557 value = substream
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
558 new_attrs.append((name, u''.join(value)))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
559 yield kind, (tag, Attrs(new_attrs)), pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
560
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
561 elif kind is EXPR:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
562 result = _eval_expr(data, ctxt, **vars)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
563 if result is not None:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
564 # First check for a string, otherwise the iterable test
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
565 # below succeeds, and the string will be chopped up into
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
566 # individual characters
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
567 if isinstance(result, basestring):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
568 yield TEXT, result, pos
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
569 elif isinstance(result, (int, float, long)):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
570 yield TEXT, number_conv(result), pos
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
571 elif hasattr(result, '__iter__'):
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
572 for event in self._flatten(_ensure(result), ctxt,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
573 **vars):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
574 yield event
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
575 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
576 yield TEXT, unicode(result), pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
577
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
578 elif kind is EXEC:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
579 _exec_suite(data, ctxt, **vars)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
580
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
581 elif kind is SUB:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
582 # This event is a list of directives and a list of nested
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
583 # events to which those directives should be applied
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
584 substream = _apply_directives(data[1], data[0], ctxt, **vars)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
585 for event in self._flatten(substream, ctxt, **vars):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
586 yield event
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
587
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
588 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
589 yield kind, data, pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
590
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
591 def _include(self, stream, ctxt, **vars):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
592 """Internal stream filter that performs inclusion of external
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
593 template files.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
594 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
595 from genshi.template.loader import TemplateNotFound
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
596
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
597 for event in stream:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
598 if event[0] is INCLUDE:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
599 href, cls, fallback = event[1]
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
600 if not isinstance(href, basestring):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
601 parts = []
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
602 for subkind, subdata, subpos in self._flatten(href, ctxt,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
603 **vars):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
604 if subkind is TEXT:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
605 parts.append(subdata)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
606 href = u''.join([x for x in parts if x is not None])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
607 try:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
608 tmpl = self.loader.load(href, relative_to=event[2][0],
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
609 cls=cls or self.__class__)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
610 for event in tmpl.generate(ctxt, **vars):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
611 yield event
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
612 except TemplateNotFound:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
613 if fallback is None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
614 raise
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
615 for filter_ in self.filters:
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
616 fallback = filter_(iter(fallback), ctxt, **vars)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
617 for event in fallback:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
618 yield event
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
619 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
620 yield event
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
621
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
622
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
623 EXEC = Template.EXEC
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
624 EXPR = Template.EXPR
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
625 INCLUDE = Template.INCLUDE
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents:
diff changeset
626 SUB = Template.SUB
Copyright (C) 2012-2017 Edgewall Software