Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | """ |
| 3 | jinja2.compiler |
| 4 | ~~~~~~~~~~~~~~~ |
| 5 | |
| 6 | Compiles nodes into python code. |
| 7 | |
| 8 | :copyright: Copyright 2008 by Armin Ronacher. |
| 9 | :license: GNU GPL. |
| 10 | """ |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 11 | from time import time |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 12 | from copy import copy |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 13 | from random import randrange |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 14 | from keyword import iskeyword |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 15 | from cStringIO import StringIO |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 16 | from itertools import chain |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 17 | from jinja2 import nodes |
| 18 | from jinja2.visitor import NodeVisitor, NodeTransformer |
| 19 | from jinja2.exceptions import TemplateAssertionError |
Armin Ronacher | 7ceced5 | 2008-05-03 10:15:31 +0200 | [diff] [blame] | 20 | from jinja2.utils import Markup, concat |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 21 | |
| 22 | |
| 23 | operators = { |
| 24 | 'eq': '==', |
| 25 | 'ne': '!=', |
| 26 | 'gt': '>', |
| 27 | 'gteq': '>=', |
| 28 | 'lt': '<', |
| 29 | 'lteq': '<=', |
| 30 | 'in': 'in', |
| 31 | 'notin': 'not in' |
| 32 | } |
| 33 | |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 34 | try: |
| 35 | exec '(0 if 0 else 0)' |
| 36 | except SyntaxError: |
| 37 | have_condexpr = False |
| 38 | else: |
| 39 | have_condexpr = True |
| 40 | |
| 41 | |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 42 | def generate(node, environment, name, filename, stream=None): |
Armin Ronacher | bcb7c53 | 2008-04-11 16:30:34 +0200 | [diff] [blame] | 43 | """Generate the python source for a node tree.""" |
Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 44 | if not isinstance(node, nodes.Template): |
| 45 | raise TypeError('Can\'t compile non template nodes') |
Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 46 | node.freeze() |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 47 | generator = CodeGenerator(environment, name, filename, stream) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 48 | generator.visit(node) |
| 49 | if stream is None: |
| 50 | return generator.stream.getvalue() |
| 51 | |
| 52 | |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 53 | def has_safe_repr(value): |
| 54 | """Does the node have a safe representation?""" |
Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 55 | if value is None or value is NotImplemented or value is Ellipsis: |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 56 | return True |
Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 57 | if isinstance(value, (bool, int, long, float, complex, basestring, |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 58 | xrange, Markup)): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 59 | return True |
Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 60 | if isinstance(value, (tuple, list, set, frozenset)): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 61 | for item in value: |
| 62 | if not has_safe_repr(item): |
| 63 | return False |
| 64 | return True |
| 65 | elif isinstance(value, dict): |
| 66 | for key, value in value.iteritems(): |
| 67 | if not has_safe_repr(key): |
| 68 | return False |
| 69 | if not has_safe_repr(value): |
| 70 | return False |
| 71 | return True |
| 72 | return False |
| 73 | |
| 74 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 75 | def find_undeclared(nodes, names): |
| 76 | """Check if the names passed are accessed undeclared. The return value |
| 77 | is a set of all the undeclared names from the sequence of names found. |
| 78 | """ |
| 79 | visitor = UndeclaredNameVisitor(names) |
| 80 | try: |
| 81 | for node in nodes: |
| 82 | visitor.visit(node) |
| 83 | except VisitorExit: |
| 84 | pass |
| 85 | return visitor.undeclared |
| 86 | |
| 87 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 88 | class Identifiers(object): |
| 89 | """Tracks the status of identifiers in frames.""" |
| 90 | |
| 91 | def __init__(self): |
| 92 | # variables that are known to be declared (probably from outer |
| 93 | # frames or because they are special for the frame) |
| 94 | self.declared = set() |
| 95 | |
Armin Ronacher | 10f3ba2 | 2008-04-18 11:30:37 +0200 | [diff] [blame] | 96 | # undeclared variables from outer scopes |
| 97 | self.outer_undeclared = set() |
| 98 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 99 | # names that are accessed without being explicitly declared by |
| 100 | # this one or any of the outer scopes. Names can appear both in |
| 101 | # declared and undeclared. |
| 102 | self.undeclared = set() |
| 103 | |
| 104 | # names that are declared locally |
| 105 | self.declared_locally = set() |
| 106 | |
| 107 | # names that are declared by parameters |
| 108 | self.declared_parameter = set() |
| 109 | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 110 | # static subscribes |
| 111 | self.static_subscribes = {} |
| 112 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 113 | def add_special(self, name): |
| 114 | """Register a special name like `loop`.""" |
| 115 | self.undeclared.discard(name) |
| 116 | self.declared.add(name) |
| 117 | |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 118 | def is_declared(self, name, local_only=False): |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 119 | """Check if a name is declared in this or an outer scope.""" |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 120 | if name in self.declared_locally or name in self.declared_parameter: |
| 121 | return True |
| 122 | if local_only: |
| 123 | return False |
| 124 | return name in self.declared |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 125 | |
| 126 | def find_shadowed(self): |
| 127 | """Find all the shadowed names.""" |
Armin Ronacher | 10f3ba2 | 2008-04-18 11:30:37 +0200 | [diff] [blame] | 128 | return (self.declared | self.outer_undeclared) & \ |
| 129 | (self.declared_locally | self.declared_parameter) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 130 | |
| 131 | |
| 132 | class Frame(object): |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 133 | """Holds compile time information for us.""" |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 134 | |
| 135 | def __init__(self, parent=None): |
| 136 | self.identifiers = Identifiers() |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 137 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 138 | # a toplevel frame is the root + soft frames such as if conditions. |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 139 | self.toplevel = False |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 140 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 141 | # the root frame is basically just the outermost frame, so no if |
| 142 | # conditions. This information is used to optimize inheritance |
| 143 | # situations. |
| 144 | self.rootlevel = False |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 145 | |
| 146 | # inside some tags we are using a buffer rather than yield statements. |
| 147 | # this for example affects {% filter %} or {% macro %}. If a frame |
| 148 | # is buffered this variable points to the name of the list used as |
| 149 | # buffer. |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 150 | self.buffer = None |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 151 | |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 152 | # the name of the block we're in, otherwise None. |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 153 | self.block = parent and parent.block or None |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 154 | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 155 | # node overlays. see `CodeGenerator.overlay` for more details |
| 156 | self.overlays = {} |
| 157 | |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 158 | # the parent of this frame |
| 159 | self.parent = parent |
| 160 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 161 | if parent is not None: |
| 162 | self.identifiers.declared.update( |
| 163 | parent.identifiers.declared | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 164 | parent.identifiers.declared_locally | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 165 | parent.identifiers.declared_parameter | |
| 166 | parent.identifiers.undeclared |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 167 | ) |
Armin Ronacher | 10f3ba2 | 2008-04-18 11:30:37 +0200 | [diff] [blame] | 168 | self.identifiers.outer_undeclared.update( |
| 169 | parent.identifiers.undeclared - |
| 170 | self.identifiers.declared |
| 171 | ) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 172 | self.buffer = parent.buffer |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 173 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 174 | def copy(self): |
| 175 | """Create a copy of the current one.""" |
| 176 | rv = copy(self) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 177 | rv.identifiers = copy(self.identifiers) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 178 | return rv |
| 179 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 180 | def inspect(self, nodes, hard_scope=False): |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 181 | """Walk the node and check for identifiers. If the scope is hard (eg: |
| 182 | enforce on a python level) overrides from outer scopes are tracked |
| 183 | differently. |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 184 | """ |
| 185 | visitor = FrameIdentifierVisitor(self.identifiers, hard_scope) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 186 | for node in nodes: |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 187 | visitor.visit(node) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 188 | |
| 189 | def inner(self): |
| 190 | """Return an inner frame.""" |
| 191 | return Frame(self) |
| 192 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 193 | def soft(self): |
| 194 | """Return a soft frame. A soft frame may not be modified as |
| 195 | standalone thing as it shares the resources with the frame it |
| 196 | was created of, but it's not a rootlevel frame any longer. |
| 197 | """ |
| 198 | rv = copy(self) |
| 199 | rv.rootlevel = False |
| 200 | return rv |
| 201 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 202 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 203 | class VisitorExit(RuntimeError): |
| 204 | """Exception used by the `UndeclaredNameVisitor` to signal a stop.""" |
| 205 | |
| 206 | |
| 207 | class DependencyFinderVisitor(NodeVisitor): |
| 208 | """A visitor that collects filter and test calls.""" |
| 209 | |
| 210 | def __init__(self): |
| 211 | self.filters = set() |
| 212 | self.tests = set() |
| 213 | |
| 214 | def visit_Filter(self, node): |
| 215 | self.generic_visit(node) |
| 216 | self.filters.add(node.name) |
| 217 | |
| 218 | def visit_Test(self, node): |
| 219 | self.generic_visit(node) |
| 220 | self.tests.add(node.name) |
| 221 | |
| 222 | def visit_Block(self, node): |
| 223 | """Stop visiting at blocks.""" |
| 224 | |
| 225 | |
| 226 | class UndeclaredNameVisitor(NodeVisitor): |
| 227 | """A visitor that checks if a name is accessed without being |
| 228 | declared. This is different from the frame visitor as it will |
| 229 | not stop at closure frames. |
| 230 | """ |
| 231 | |
| 232 | def __init__(self, names): |
| 233 | self.names = set(names) |
| 234 | self.undeclared = set() |
| 235 | |
| 236 | def visit_Name(self, node): |
| 237 | if node.ctx == 'load' and node.name in self.names: |
| 238 | self.undeclared.add(node.name) |
| 239 | if self.undeclared == self.names: |
| 240 | raise VisitorExit() |
| 241 | else: |
| 242 | self.names.discard(node.name) |
| 243 | |
| 244 | def visit_Block(self, node): |
| 245 | """Stop visiting a blocks.""" |
| 246 | |
| 247 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 248 | class FrameIdentifierVisitor(NodeVisitor): |
| 249 | """A visitor for `Frame.inspect`.""" |
| 250 | |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 251 | def __init__(self, identifiers, hard_scope): |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 252 | self.identifiers = identifiers |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 253 | self.hard_scope = hard_scope |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 254 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 255 | def visit_Name(self, node): |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 256 | """All assignments to names go through this function.""" |
Armin Ronacher | e9411b4 | 2008-05-15 16:22:07 +0200 | [diff] [blame] | 257 | if node.ctx == 'store': |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 258 | self.identifiers.declared_locally.add(node.name) |
Armin Ronacher | e9411b4 | 2008-05-15 16:22:07 +0200 | [diff] [blame] | 259 | elif node.ctx == 'param': |
| 260 | self.identifiers.declared_parameter.add(node.name) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 261 | elif node.ctx == 'load' and not \ |
| 262 | self.identifiers.is_declared(node.name, self.hard_scope): |
| 263 | self.identifiers.undeclared.add(node.name) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 264 | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 265 | def visit_Subscript(self, node): |
| 266 | """Under some circumstances subscripts are aliased with local names: |
| 267 | |
| 268 | - the subscript node is either already aliased or a name that was not |
| 269 | reassigned. |
| 270 | - and the subscription argument is a constant string. |
| 271 | """ |
| 272 | self.generic_visit(node) |
| 273 | if isinstance(node.arg, nodes.Const) and \ |
| 274 | isinstance(node.arg.value, basestring) and \ |
Armin Ronacher | 151418d | 2008-05-15 15:00:45 +0200 | [diff] [blame] | 275 | ((isinstance(node.node, nodes.Name) and |
Armin Ronacher | dc02b64 | 2008-05-15 22:47:27 +0200 | [diff] [blame] | 276 | # this code ignores parameter declared names as the may only |
| 277 | # occour at the very beginning of a scope and we pull the |
| 278 | # attributes afterwards. |
Armin Ronacher | e9411b4 | 2008-05-15 16:22:07 +0200 | [diff] [blame] | 279 | node.node.name not in (self.identifiers.declared_locally)) or |
Armin Ronacher | 151418d | 2008-05-15 15:00:45 +0200 | [diff] [blame] | 280 | node.node in self.identifiers.static_subscribes): |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 281 | if node in self.identifiers.static_subscribes: |
| 282 | self.identifiers.static_subscribes[node] += 1 |
| 283 | else: |
| 284 | self.identifiers.static_subscribes[node] = 1 |
| 285 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 286 | def visit_Macro(self, node): |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 287 | self.identifiers.declared_locally.add(node.name) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 288 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 289 | def visit_Import(self, node): |
| 290 | self.generic_visit(node) |
| 291 | self.identifiers.declared_locally.add(node.target) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 292 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 293 | def visit_FromImport(self, node): |
| 294 | self.generic_visit(node) |
| 295 | for name in node.names: |
| 296 | if isinstance(name, tuple): |
| 297 | self.identifiers.declared_locally.add(name[1]) |
| 298 | else: |
| 299 | self.identifiers.declared_locally.add(name) |
| 300 | |
| 301 | def visit_Assign(self, node): |
Armin Ronacher | ebe55aa | 2008-04-10 20:51:23 +0200 | [diff] [blame] | 302 | """Visit assignments in the correct order.""" |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 303 | self.visit(node.node) |
| 304 | self.visit(node.target) |
Armin Ronacher | ebe55aa | 2008-04-10 20:51:23 +0200 | [diff] [blame] | 305 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 306 | def visit_For(self, node): |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 307 | """Visiting stops at for blocks. However the block sequence |
| 308 | is visited as part of the outer scope. |
| 309 | """ |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 310 | self.visit(node.iter) |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 311 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 312 | def visit_CallBlock(self, node): |
| 313 | for child in node.iter_child_nodes(exclude=('body',)): |
| 314 | self.visit(child) |
| 315 | |
| 316 | def visit_FilterBlock(self, node): |
| 317 | self.visit(node.filter) |
| 318 | |
| 319 | def visit_Block(self, node): |
| 320 | """Stop visiting at blocks.""" |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 321 | |
| 322 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 323 | class CompilerExit(Exception): |
| 324 | """Raised if the compiler encountered a situation where it just |
| 325 | doesn't make sense to further process the code. Any block that |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 326 | raises such an exception is not further processed. |
| 327 | """ |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 328 | |
| 329 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 330 | class CodeGenerator(NodeVisitor): |
| 331 | |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 332 | def __init__(self, environment, name, filename, stream=None): |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 333 | if stream is None: |
| 334 | stream = StringIO() |
Christoph Hack | 65642a5 | 2008-04-08 14:46:56 +0200 | [diff] [blame] | 335 | self.environment = environment |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 336 | self.name = name |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 337 | self.filename = filename |
| 338 | self.stream = stream |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 339 | |
Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 340 | # aliases for imports |
| 341 | self.import_aliases = {} |
| 342 | |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 343 | # a registry for all blocks. Because blocks are moved out |
| 344 | # into the global python scope they are registered here |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 345 | self.blocks = {} |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 346 | |
| 347 | # the number of extends statements so far |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 348 | self.extends_so_far = 0 |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 349 | |
| 350 | # some templates have a rootlevel extends. In this case we |
| 351 | # can safely assume that we're a child template and do some |
| 352 | # more optimizations. |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 353 | self.has_known_extends = False |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 354 | |
Armin Ronacher | ba3757b | 2008-04-16 19:43:16 +0200 | [diff] [blame] | 355 | # the current line number |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 356 | self.code_lineno = 1 |
Armin Ronacher | ba3757b | 2008-04-16 19:43:16 +0200 | [diff] [blame] | 357 | |
Armin Ronacher | b9e7875 | 2008-05-10 23:36:28 +0200 | [diff] [blame] | 358 | # registry of all filters and tests (global, not block local) |
| 359 | self.tests = {} |
| 360 | self.filters = {} |
| 361 | |
Armin Ronacher | ba3757b | 2008-04-16 19:43:16 +0200 | [diff] [blame] | 362 | # the debug information |
| 363 | self.debug_info = [] |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 364 | self._write_debug_info = None |
Armin Ronacher | ba3757b | 2008-04-16 19:43:16 +0200 | [diff] [blame] | 365 | |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 366 | # the number of new lines before the next write() |
| 367 | self._new_lines = 0 |
| 368 | |
| 369 | # the line number of the last written statement |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 370 | self._last_line = 0 |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 371 | |
| 372 | # true if nothing was written so far. |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 373 | self._first_write = True |
| 374 | |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 375 | # used by the `temporary_identifier` method to get new |
| 376 | # unique, temporary identifier |
| 377 | self._last_identifier = 0 |
| 378 | |
| 379 | # the current indentation |
| 380 | self._indentation = 0 |
| 381 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 382 | def temporary_identifier(self): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 383 | """Get a new unique identifier.""" |
| 384 | self._last_identifier += 1 |
| 385 | return 't%d' % self._last_identifier |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 386 | |
| 387 | def indent(self): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 388 | """Indent by one.""" |
| 389 | self._indentation += 1 |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 390 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 391 | def outdent(self, step=1): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 392 | """Outdent by step.""" |
| 393 | self._indentation -= step |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 394 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 395 | def blockvisit(self, nodes, frame, force_generator=True): |
| 396 | """Visit a list of nodes as block in a frame. If the current frame |
| 397 | is no buffer a dummy ``if 0: yield None`` is written automatically |
| 398 | unless the force_generator parameter is set to False. |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 399 | """ |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 400 | if frame.buffer is None and force_generator: |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 401 | self.writeline('if 0: yield None') |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 402 | try: |
| 403 | for node in nodes: |
| 404 | self.visit(node, frame) |
| 405 | except CompilerExit: |
| 406 | pass |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 407 | |
| 408 | def write(self, x): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 409 | """Write a string into the output stream.""" |
| 410 | if self._new_lines: |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 411 | if not self._first_write: |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 412 | self.stream.write('\n' * self._new_lines) |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 413 | self.code_lineno += self._new_lines |
| 414 | if self._write_debug_info is not None: |
| 415 | self.debug_info.append((self._write_debug_info, |
| 416 | self.code_lineno)) |
| 417 | self._write_debug_info = None |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 418 | self._first_write = False |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 419 | self.stream.write(' ' * self._indentation) |
| 420 | self._new_lines = 0 |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 421 | self.stream.write(x) |
| 422 | |
| 423 | def writeline(self, x, node=None, extra=0): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 424 | """Combination of newline and write.""" |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 425 | self.newline(node, extra) |
| 426 | self.write(x) |
| 427 | |
| 428 | def newline(self, node=None, extra=0): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 429 | """Add one or more newlines before the next write.""" |
| 430 | self._new_lines = max(self._new_lines, 1 + extra) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 431 | if node is not None and node.lineno != self._last_line: |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 432 | self._write_debug_info = node.lineno |
| 433 | self._last_line = node.lineno |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 434 | |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 435 | def signature(self, node, frame, have_comma=True, extra_kwargs=None): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 436 | """Writes a function call to the stream for the current node. |
| 437 | Per default it will write a leading comma but this can be |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 438 | disabled by setting have_comma to False. The extra keyword |
| 439 | arguments may not include python keywords otherwise a syntax |
| 440 | error could occour. The extra keyword arguments should be given |
| 441 | as python dict. |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 442 | """ |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 443 | have_comma = have_comma and [True] or [] |
| 444 | def touch_comma(): |
| 445 | if have_comma: |
| 446 | self.write(', ') |
| 447 | else: |
| 448 | have_comma.append(True) |
| 449 | |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 450 | # if any of the given keyword arguments is a python keyword |
| 451 | # we have to make sure that no invalid call is created. |
| 452 | kwarg_workaround = False |
| 453 | for kwarg in chain((x.key for x in node.kwargs), extra_kwargs or ()): |
| 454 | if iskeyword(kwarg): |
| 455 | kwarg_workaround = True |
| 456 | break |
| 457 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 458 | for arg in node.args: |
| 459 | touch_comma() |
| 460 | self.visit(arg, frame) |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 461 | |
| 462 | if not kwarg_workaround: |
| 463 | for kwarg in node.kwargs: |
| 464 | touch_comma() |
| 465 | self.visit(kwarg, frame) |
| 466 | if extra_kwargs is not None: |
| 467 | for key, value in extra_kwargs.iteritems(): |
| 468 | touch_comma() |
| 469 | self.write('%s=%s' % (key, value)) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 470 | if node.dyn_args: |
| 471 | touch_comma() |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 472 | self.write('*') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 473 | self.visit(node.dyn_args, frame) |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 474 | |
| 475 | if kwarg_workaround: |
| 476 | touch_comma() |
| 477 | if node.dyn_kwargs is not None: |
| 478 | self.write('**dict({') |
| 479 | else: |
| 480 | self.write('**{') |
| 481 | for kwarg in node.kwargs: |
| 482 | self.write('%r: ' % kwarg.key) |
| 483 | self.visit(kwarg.value, frame) |
| 484 | self.write(', ') |
| 485 | if extra_kwargs is not None: |
| 486 | for key, value in extra_kwargs.iteritems(): |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 487 | self.write('%r: %s, ' % (key, value)) |
| 488 | if node.dyn_kwargs is not None: |
| 489 | self.write('}, **') |
| 490 | self.visit(node.dyn_kwargs, frame) |
| 491 | self.write(')') |
| 492 | else: |
| 493 | self.write('}') |
| 494 | |
| 495 | elif node.dyn_kwargs is not None: |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 496 | touch_comma() |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 497 | self.write('**') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 498 | self.visit(node.dyn_kwargs, frame) |
| 499 | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 500 | def overlay(self, node, frame): |
| 501 | """Visit an overlay and return `True` or `False` if the overlay |
| 502 | does not exist or is exhausted. An overlay is used to replace a |
| 503 | node with another one (or an identifier) N times. This is for |
| 504 | example used to replace static subscribes before reassignments |
| 505 | of a name that occour more than one time. If a node has overlays |
| 506 | it's important that this method is called, otherwise the count |
| 507 | will be out of sync and the generated code is broken. |
| 508 | """ |
| 509 | if node not in frame.overlays: |
| 510 | return False |
| 511 | overlay, count = frame.overlays[node] |
| 512 | if count is not None and count <= 0: |
| 513 | return False |
| 514 | if isinstance(overlay, basestring): |
| 515 | self.write(overlay) |
| 516 | else: |
| 517 | self.visit(overlay, frame) |
| 518 | frame.overlays[node] = (overlay, count - 1) |
| 519 | return True |
| 520 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 521 | def pull_locals(self, frame): |
| 522 | """Pull all the references identifiers into the local scope.""" |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 523 | for name in frame.identifiers.undeclared: |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 524 | self.writeline('l_%s = context.resolve(%r)' % (name, name)) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 525 | |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 526 | # find all the static subscribes with a count > 2 and |
| 527 | # order them properly so that subscribes depending on other |
| 528 | # subscribes are handled later. |
| 529 | static_subscribes = [(node, count) for node, count in |
| 530 | frame.identifiers.static_subscribes.items() if |
| 531 | count >= 2] |
| 532 | if static_subscribes: |
| 533 | static_subscribes.sort(key=lambda x: type(x[0].node) |
| 534 | is nodes.Subscript) |
| 535 | for node, count in static_subscribes: |
| 536 | ident = self.temporary_identifier() |
| 537 | self.writeline(ident + ' = ') |
| 538 | self.visit(node, frame) |
| 539 | frame.overlays[node] = (ident, count) |
| 540 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 541 | def pull_dependencies(self, nodes): |
| 542 | """Pull all the dependencies.""" |
| 543 | visitor = DependencyFinderVisitor() |
| 544 | for node in nodes: |
| 545 | visitor.visit(node) |
Armin Ronacher | b9e7875 | 2008-05-10 23:36:28 +0200 | [diff] [blame] | 546 | for dependency in 'filters', 'tests': |
| 547 | mapping = getattr(self, dependency) |
| 548 | for name in getattr(visitor, dependency): |
| 549 | if name not in mapping: |
| 550 | mapping[name] = self.temporary_identifier() |
| 551 | self.writeline('%s = environment.%s[%r]' % |
| 552 | (mapping[name], dependency, name)) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 553 | |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 554 | def collect_shadowed(self, frame): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 555 | """This function returns all the shadowed variables in a dict |
| 556 | in the form name: alias and will write the required assignments |
| 557 | into the current scope. No indentation takes place. |
| 558 | """ |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 559 | # make sure we "backup" overridden, local identifiers |
| 560 | # TODO: we should probably optimize this and check if the |
| 561 | # identifier is in use afterwards. |
| 562 | aliases = {} |
| 563 | for name in frame.identifiers.find_shadowed(): |
| 564 | aliases[name] = ident = self.temporary_identifier() |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 565 | self.writeline('%s = l_%s' % (ident, name)) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 566 | return aliases |
| 567 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 568 | def function_scoping(self, node, frame, children=None, |
| 569 | find_special=True): |
Armin Ronacher | fed44b5 | 2008-04-13 19:42:53 +0200 | [diff] [blame] | 570 | """In Jinja a few statements require the help of anonymous |
| 571 | functions. Those are currently macros and call blocks and in |
| 572 | the future also recursive loops. As there is currently |
| 573 | technical limitation that doesn't allow reading and writing a |
| 574 | variable in a scope where the initial value is coming from an |
| 575 | outer scope, this function tries to fall back with a common |
| 576 | error message. Additionally the frame passed is modified so |
| 577 | that the argumetns are collected and callers are looked up. |
| 578 | |
| 579 | This will return the modified frame. |
| 580 | """ |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 581 | # we have to iterate twice over it, make sure that works |
| 582 | if children is None: |
| 583 | children = node.iter_child_nodes() |
| 584 | children = list(children) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 585 | func_frame = frame.inner() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 586 | func_frame.inspect(children, hard_scope=True) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 587 | |
| 588 | # variables that are undeclared (accessed before declaration) and |
| 589 | # declared locally *and* part of an outside scope raise a template |
| 590 | # assertion error. Reason: we can't generate reasonable code from |
| 591 | # it without aliasing all the variables. XXX: alias them ^^ |
| 592 | overriden_closure_vars = ( |
| 593 | func_frame.identifiers.undeclared & |
| 594 | func_frame.identifiers.declared & |
| 595 | (func_frame.identifiers.declared_locally | |
| 596 | func_frame.identifiers.declared_parameter) |
| 597 | ) |
| 598 | if overriden_closure_vars: |
| 599 | vars = ', '.join(sorted(overriden_closure_vars)) |
| 600 | raise TemplateAssertionError('It\'s not possible to set and ' |
| 601 | 'access variables derived from ' |
| 602 | 'an outer scope! (affects: %s' % |
Armin Ronacher | 66a9344 | 2008-05-11 23:42:19 +0200 | [diff] [blame] | 603 | vars, node.lineno, self.filename) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 604 | |
| 605 | # remove variables from a closure from the frame's undeclared |
| 606 | # identifiers. |
| 607 | func_frame.identifiers.undeclared -= ( |
| 608 | func_frame.identifiers.undeclared & |
| 609 | func_frame.identifiers.declared |
| 610 | ) |
| 611 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 612 | # no special variables for this scope, abort early |
| 613 | if not find_special: |
| 614 | return func_frame |
| 615 | |
Armin Ronacher | 963f97d | 2008-04-25 11:44:59 +0200 | [diff] [blame] | 616 | func_frame.accesses_kwargs = False |
| 617 | func_frame.accesses_varargs = False |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 618 | func_frame.accesses_caller = False |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 619 | func_frame.arguments = args = ['l_' + x.name for x in node.args] |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 620 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 621 | undeclared = find_undeclared(children, ('caller', 'kwargs', 'varargs')) |
| 622 | |
| 623 | if 'caller' in undeclared: |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 624 | func_frame.accesses_caller = True |
| 625 | func_frame.identifiers.add_special('caller') |
| 626 | args.append('l_caller') |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 627 | if 'kwargs' in undeclared: |
Armin Ronacher | 963f97d | 2008-04-25 11:44:59 +0200 | [diff] [blame] | 628 | func_frame.accesses_kwargs = True |
| 629 | func_frame.identifiers.add_special('kwargs') |
| 630 | args.append('l_kwargs') |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 631 | if 'varargs' in undeclared: |
Armin Ronacher | 963f97d | 2008-04-25 11:44:59 +0200 | [diff] [blame] | 632 | func_frame.accesses_varargs = True |
| 633 | func_frame.identifiers.add_special('varargs') |
| 634 | args.append('l_varargs') |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 635 | return func_frame |
| 636 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 637 | # -- Visitors |
| 638 | |
| 639 | def visit_Template(self, node, frame=None): |
| 640 | assert frame is None, 'no root frame allowed' |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 641 | from jinja2.runtime import __all__ as exported |
Armin Ronacher | 709f6e5 | 2008-04-28 18:18:16 +0200 | [diff] [blame] | 642 | self.writeline('from __future__ import division') |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 643 | self.writeline('from jinja2.runtime import ' + ', '.join(exported)) |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 644 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 645 | # do we have an extends tag at all? If not, we can save some |
| 646 | # overhead by just not processing any inheritance code. |
| 647 | have_extends = node.find(nodes.Extends) is not None |
| 648 | |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 649 | # find all blocks |
| 650 | for block in node.find_all(nodes.Block): |
| 651 | if block.name in self.blocks: |
| 652 | raise TemplateAssertionError('block %r defined twice' % |
| 653 | block.name, block.lineno, |
Armin Ronacher | 66a9344 | 2008-05-11 23:42:19 +0200 | [diff] [blame] | 654 | self.filename) |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 655 | self.blocks[block.name] = block |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 656 | |
Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 657 | # find all imports and import them |
| 658 | for import_ in node.find_all(nodes.ImportedName): |
| 659 | if import_.importname not in self.import_aliases: |
| 660 | imp = import_.importname |
| 661 | self.import_aliases[imp] = alias = self.temporary_identifier() |
| 662 | if '.' in imp: |
| 663 | module, obj = imp.rsplit('.', 1) |
| 664 | self.writeline('from %s import %s as %s' % |
| 665 | (module, obj, alias)) |
| 666 | else: |
| 667 | self.writeline('import %s as %s' % (imp, alias)) |
| 668 | |
| 669 | # add the load name |
Armin Ronacher | dc02b64 | 2008-05-15 22:47:27 +0200 | [diff] [blame] | 670 | self.writeline('name = %r' % self.name) |
Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 671 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 672 | # generate the root render function. |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 673 | self.writeline('def root(context, environment=environment):', extra=1) |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 674 | |
| 675 | # process the root |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 676 | frame = Frame() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 677 | frame.inspect(node.body) |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 678 | frame.toplevel = frame.rootlevel = True |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 679 | self.indent() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 680 | if have_extends: |
| 681 | self.writeline('parent_template = None') |
| 682 | self.pull_locals(frame) |
| 683 | self.pull_dependencies(node.body) |
| 684 | if 'self' in find_undeclared(node.body, ('self',)): |
| 685 | frame.identifiers.add_special('self') |
| 686 | self.writeline('l_self = TemplateReference(context)') |
| 687 | self.blockvisit(node.body, frame) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 688 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 689 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 690 | # make sure that the parent root is called. |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 691 | if have_extends: |
| 692 | if not self.has_known_extends: |
| 693 | self.indent() |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 694 | self.writeline('if parent_template is not None:') |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 695 | self.indent() |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 696 | self.writeline('for event in parent_template.' |
| 697 | 'root_render_func(context):') |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 698 | self.indent() |
| 699 | self.writeline('yield event') |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 700 | self.outdent(2 + (not self.has_known_extends)) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 701 | |
| 702 | # at this point we now have the blocks collected and can visit them too. |
| 703 | for name, block in self.blocks.iteritems(): |
| 704 | block_frame = Frame() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 705 | block_frame.inspect(block.body) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 706 | block_frame.block = name |
Armin Ronacher | d4c64f7 | 2008-04-11 17:15:29 +0200 | [diff] [blame] | 707 | self.writeline('def block_%s(context, environment=environment):' |
| 708 | % name, block, 1) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 709 | self.indent() |
| 710 | undeclared = find_undeclared(block.body, ('self', 'super')) |
| 711 | if 'self' in undeclared: |
| 712 | block_frame.identifiers.add_special('self') |
| 713 | self.writeline('l_self = TemplateReference(context)') |
| 714 | if 'super' in undeclared: |
| 715 | block_frame.identifiers.add_special('super') |
| 716 | self.writeline('l_super = context.super(%r, ' |
| 717 | 'block_%s)' % (name, name)) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 718 | self.pull_locals(block_frame) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 719 | self.pull_dependencies(block.body) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 720 | self.blockvisit(block.body, block_frame) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 721 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 722 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 723 | self.writeline('blocks = {%s}' % ', '.join('%r: block_%s' % (x, x) |
Armin Ronacher | ba3757b | 2008-04-16 19:43:16 +0200 | [diff] [blame] | 724 | for x in self.blocks), |
| 725 | extra=1) |
| 726 | |
| 727 | # add a function that returns the debug info |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 728 | self.writeline('debug_info = %r' % '&'.join('%s=%s' % x for x |
| 729 | in self.debug_info)) |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 730 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 731 | def visit_Block(self, node, frame): |
| 732 | """Call a block and register it for the template.""" |
Armin Ronacher | 41ef36f | 2008-04-11 19:55:08 +0200 | [diff] [blame] | 733 | level = 1 |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 734 | if frame.toplevel: |
Armin Ronacher | bcb7c53 | 2008-04-11 16:30:34 +0200 | [diff] [blame] | 735 | # if we know that we are a child template, there is no need to |
| 736 | # check if we are one |
| 737 | if self.has_known_extends: |
| 738 | return |
Armin Ronacher | 41ef36f | 2008-04-11 19:55:08 +0200 | [diff] [blame] | 739 | if self.extends_so_far > 0: |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 740 | self.writeline('if parent_template is None:') |
Armin Ronacher | 41ef36f | 2008-04-11 19:55:08 +0200 | [diff] [blame] | 741 | self.indent() |
| 742 | level += 1 |
Armin Ronacher | 83fbc0f | 2008-05-15 12:22:28 +0200 | [diff] [blame] | 743 | self.writeline('for event in context.blocks[%r][0](context):' % |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 744 | node.name, node) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 745 | self.indent() |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 746 | if frame.buffer is None: |
| 747 | self.writeline('yield event') |
| 748 | else: |
| 749 | self.writeline('%s.append(event)' % frame.buffer) |
Armin Ronacher | 41ef36f | 2008-04-11 19:55:08 +0200 | [diff] [blame] | 750 | self.outdent(level) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 751 | |
| 752 | def visit_Extends(self, node, frame): |
| 753 | """Calls the extender.""" |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 754 | if not frame.toplevel: |
| 755 | raise TemplateAssertionError('cannot use extend from a non ' |
| 756 | 'top-level scope', node.lineno, |
Armin Ronacher | 66a9344 | 2008-05-11 23:42:19 +0200 | [diff] [blame] | 757 | self.filename) |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 758 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 759 | # if the number of extends statements in general is zero so |
| 760 | # far, we don't have to add a check if something extended |
| 761 | # the template before this one. |
| 762 | if self.extends_so_far > 0: |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 763 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 764 | # if we have a known extends we just add a template runtime |
| 765 | # error into the generated code. We could catch that at compile |
| 766 | # time too, but i welcome it not to confuse users by throwing the |
| 767 | # same error at different times just "because we can". |
| 768 | if not self.has_known_extends: |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 769 | self.writeline('if parent_template is not None:') |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 770 | self.indent() |
| 771 | self.writeline('raise TemplateRuntimeError(%r)' % |
| 772 | 'extended multiple times') |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 773 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 774 | # if we have a known extends already we don't need that code here |
| 775 | # as we know that the template execution will end here. |
| 776 | if self.has_known_extends: |
| 777 | raise CompilerExit() |
| 778 | self.outdent() |
| 779 | |
Armin Ronacher | 9d42abf | 2008-05-14 18:10:41 +0200 | [diff] [blame] | 780 | self.writeline('parent_template = environment.get_template(', node) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 781 | self.visit(node.template, frame) |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 782 | self.write(', %r)' % self.name) |
| 783 | self.writeline('for name, parent_block in parent_template.' |
| 784 | 'blocks.iteritems():') |
| 785 | self.indent() |
| 786 | self.writeline('context.blocks.setdefault(name, []).' |
Armin Ronacher | 83fbc0f | 2008-05-15 12:22:28 +0200 | [diff] [blame] | 787 | 'append(parent_block)') |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 788 | self.outdent() |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 789 | |
| 790 | # if this extends statement was in the root level we can take |
| 791 | # advantage of that information and simplify the generated code |
| 792 | # in the top level from this point onwards |
Armin Ronacher | 27069d7 | 2008-05-11 19:48:12 +0200 | [diff] [blame] | 793 | if frame.rootlevel: |
| 794 | self.has_known_extends = True |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 795 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 796 | # and now we have one more |
| 797 | self.extends_so_far += 1 |
| 798 | |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 799 | def visit_Include(self, node, frame): |
| 800 | """Handles includes.""" |
Armin Ronacher | ea847c5 | 2008-05-02 20:04:32 +0200 | [diff] [blame] | 801 | if node.with_context: |
| 802 | self.writeline('template = environment.get_template(', node) |
| 803 | self.visit(node.template, frame) |
| 804 | self.write(', %r)' % self.name) |
| 805 | self.writeline('for event in template.root_render_func(' |
| 806 | 'template.new_context(context.parent, True)):') |
| 807 | else: |
| 808 | self.writeline('for event in environment.get_template(', node) |
| 809 | self.visit(node.template, frame) |
| 810 | self.write(', %r).module._TemplateModule__body_stream:' % |
| 811 | self.name) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 812 | self.indent() |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 813 | if frame.buffer is None: |
| 814 | self.writeline('yield event') |
| 815 | else: |
| 816 | self.writeline('%s.append(event)' % frame.buffer) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 817 | self.outdent() |
| 818 | |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 819 | def visit_Import(self, node, frame): |
| 820 | """Visit regular imports.""" |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 821 | self.writeline('l_%s = ' % node.target, node) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 822 | if frame.toplevel: |
Armin Ronacher | 5304229 | 2008-04-26 18:30:19 +0200 | [diff] [blame] | 823 | self.write('context.vars[%r] = ' % node.target) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 824 | self.write('environment.get_template(') |
| 825 | self.visit(node.template, frame) |
Armin Ronacher | ea847c5 | 2008-05-02 20:04:32 +0200 | [diff] [blame] | 826 | self.write(', %r).' % self.name) |
| 827 | if node.with_context: |
| 828 | self.write('make_module(context.parent, True)') |
| 829 | else: |
| 830 | self.write('module') |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 831 | if frame.toplevel and not node.target.startswith('__'): |
Armin Ronacher | 5304229 | 2008-04-26 18:30:19 +0200 | [diff] [blame] | 832 | self.writeline('context.exported_vars.discard(%r)' % node.target) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 833 | |
| 834 | def visit_FromImport(self, node, frame): |
| 835 | """Visit named imports.""" |
| 836 | self.newline(node) |
| 837 | self.write('included_template = environment.get_template(') |
| 838 | self.visit(node.template, frame) |
Armin Ronacher | ea847c5 | 2008-05-02 20:04:32 +0200 | [diff] [blame] | 839 | self.write(', %r).' % self.name) |
| 840 | if node.with_context: |
| 841 | self.write('make_module(context.parent, True)') |
| 842 | else: |
| 843 | self.write('module') |
Armin Ronacher | a78d276 | 2008-05-15 23:18:07 +0200 | [diff] [blame^] | 844 | |
| 845 | var_names = [] |
| 846 | discarded_names = [] |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 847 | for name in node.names: |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 848 | if isinstance(name, tuple): |
| 849 | name, alias = name |
| 850 | else: |
| 851 | alias = name |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 852 | self.writeline('l_%s = getattr(included_template, ' |
| 853 | '%r, missing)' % (alias, name)) |
| 854 | self.writeline('if l_%s is missing:' % alias) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 855 | self.indent() |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 856 | self.writeline('l_%s = environment.undefined(%r %% ' |
Armin Ronacher | dc02b64 | 2008-05-15 22:47:27 +0200 | [diff] [blame] | 857 | 'included_template.__name__, ' |
Armin Ronacher | 0a2ac69 | 2008-05-13 01:03:08 +0200 | [diff] [blame] | 858 | 'name=%r)' % |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 859 | (alias, 'the template %r does not export ' |
Armin Ronacher | 0a2ac69 | 2008-05-13 01:03:08 +0200 | [diff] [blame] | 860 | 'the requested name ' + repr(name), name)) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 861 | self.outdent() |
| 862 | if frame.toplevel: |
Armin Ronacher | a78d276 | 2008-05-15 23:18:07 +0200 | [diff] [blame^] | 863 | var_names.append(alias) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 864 | if not alias.startswith('__'): |
Armin Ronacher | a78d276 | 2008-05-15 23:18:07 +0200 | [diff] [blame^] | 865 | discarded_names.append(alias) |
| 866 | |
| 867 | if var_names: |
| 868 | if len(var_names) == 1: |
| 869 | name = var_names[0] |
| 870 | self.writeline('context.vars[%r] = l_%s' % (name, name)) |
| 871 | else: |
| 872 | self.writeline('context.vars.update({%s})' % ', '.join( |
| 873 | '%r: l_%s' % (name, name) for name in var_names |
| 874 | )) |
| 875 | if discarded_names: |
| 876 | if len(discarded_names) == 1: |
| 877 | self.writeline('context.exported_vars.discard(%r)' % |
| 878 | discarded_names[0]) |
| 879 | else: |
| 880 | self.writeline('context.exported_vars.difference_' |
| 881 | 'update((%s))' % ', '.join(map(repr, discarded_names))) |
Armin Ronacher | f059ec1 | 2008-04-11 22:21:00 +0200 | [diff] [blame] | 882 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 883 | def visit_For(self, node, frame): |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 884 | # when calculating the nodes for the inner frame we have to exclude |
| 885 | # the iterator contents from it |
| 886 | children = node.iter_child_nodes(exclude=('iter',)) |
| 887 | |
| 888 | if node.recursive: |
| 889 | loop_frame = self.function_scoping(node, frame, children, |
| 890 | find_special=False) |
| 891 | else: |
| 892 | loop_frame = frame.inner() |
| 893 | loop_frame.inspect(children) |
| 894 | |
| 895 | extended_loop = node.recursive or node.else_ or \ |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 896 | 'loop' in loop_frame.identifiers.undeclared |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 897 | if extended_loop: |
| 898 | loop_frame.identifiers.add_special('loop') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 899 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 900 | # if we don't have an recursive loop we have to find the shadowed |
| 901 | # variables at that point |
| 902 | if not node.recursive: |
| 903 | aliases = self.collect_shadowed(loop_frame) |
| 904 | |
| 905 | # otherwise we set up a buffer and add a function def |
| 906 | else: |
| 907 | loop_frame.buffer = buf = self.temporary_identifier() |
| 908 | self.writeline('def loop(reciter, loop_render_func):', node) |
| 909 | self.indent() |
| 910 | self.writeline('%s = []' % buf, node) |
| 911 | aliases = {} |
| 912 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 913 | self.pull_locals(loop_frame) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 914 | if node.else_: |
| 915 | self.writeline('l_loop = None') |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 916 | |
| 917 | self.newline(node) |
| 918 | self.writeline('for ') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 919 | self.visit(node.target, loop_frame) |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 920 | self.write(extended_loop and ', l_loop in LoopContext(' or ' in ') |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 921 | |
| 922 | # the expression pointing to the parent loop. We make the |
| 923 | # undefined a bit more debug friendly at the same time. |
| 924 | parent_loop = 'loop' in aliases and aliases['loop'] \ |
Armin Ronacher | 19cf9c2 | 2008-05-01 12:49:53 +0200 | [diff] [blame] | 925 | or "environment.undefined(%r, name='loop')" % "'loop' " \ |
| 926 | 'is undefined. "the filter section of a loop as well ' \ |
| 927 | 'as the else block doesn\'t have access to the ' \ |
| 928 | "special 'loop' variable of the current loop. " \ |
| 929 | "Because there is no parent loop it's undefined." |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 930 | |
| 931 | # if we have an extened loop and a node test, we filter in the |
| 932 | # "outer frame". |
| 933 | if extended_loop and node.test is not None: |
| 934 | self.write('(') |
| 935 | self.visit(node.target, loop_frame) |
| 936 | self.write(' for ') |
| 937 | self.visit(node.target, loop_frame) |
| 938 | self.write(' in ') |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 939 | if node.recursive: |
| 940 | self.write('reciter') |
| 941 | else: |
| 942 | self.visit(node.iter, loop_frame) |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 943 | self.write(' if (') |
| 944 | test_frame = loop_frame.copy() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 945 | self.writeline('l_loop = ' + parent_loop) |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 946 | self.visit(node.test, test_frame) |
| 947 | self.write('))') |
| 948 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 949 | elif node.recursive: |
| 950 | self.write('reciter') |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 951 | else: |
| 952 | self.visit(node.iter, loop_frame) |
| 953 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 954 | if node.recursive: |
| 955 | self.write(', recurse=loop_render_func):') |
| 956 | else: |
| 957 | self.write(extended_loop and '):' or ':') |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 958 | |
| 959 | # tests in not extended loops become a continue |
| 960 | if not extended_loop and node.test is not None: |
| 961 | self.indent() |
Armin Ronacher | 47a506f | 2008-05-06 12:17:23 +0200 | [diff] [blame] | 962 | self.writeline('if not ') |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 963 | self.visit(node.test, loop_frame) |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 964 | self.write(':') |
| 965 | self.indent() |
| 966 | self.writeline('continue') |
| 967 | self.outdent(2) |
| 968 | |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 969 | self.indent() |
Armin Ronacher | be4ae24 | 2008-04-18 09:49:08 +0200 | [diff] [blame] | 970 | self.blockvisit(node.body, loop_frame, force_generator=True) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 971 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 972 | |
| 973 | if node.else_: |
| 974 | self.writeline('if l_loop is None:') |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 975 | self.indent() |
| 976 | self.writeline('l_loop = ' + parent_loop) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 977 | self.blockvisit(node.else_, loop_frame, force_generator=False) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 978 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 979 | |
Armin Ronacher | d4c64f7 | 2008-04-11 17:15:29 +0200 | [diff] [blame] | 980 | # reset the aliases if there are any. |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 981 | for name, alias in aliases.iteritems(): |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 982 | self.writeline('l_%s = %s' % (name, alias)) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 983 | |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 984 | # if the node was recursive we have to return the buffer contents |
| 985 | # and start the iteration code |
| 986 | if node.recursive: |
| 987 | if self.environment.autoescape: |
| 988 | self.writeline('return Markup(concat(%s))' % buf) |
| 989 | else: |
| 990 | self.writeline('return concat(%s)' % buf) |
| 991 | self.outdent() |
| 992 | if frame.buffer is None: |
| 993 | self.writeline('yield loop(', node) |
| 994 | else: |
| 995 | self.writeline('%s.append(loop(' % frame.buffer, node) |
| 996 | self.visit(node.iter, frame) |
| 997 | self.write(', loop)') |
| 998 | if frame.buffer is not None: |
| 999 | self.write(')') |
| 1000 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1001 | def visit_If(self, node, frame): |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1002 | if_frame = frame.soft() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1003 | self.writeline('if ', node) |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1004 | self.visit(node.test, if_frame) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1005 | self.write(':') |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1006 | self.indent() |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1007 | self.blockvisit(node.body, if_frame) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1008 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1009 | if node.else_: |
| 1010 | self.writeline('else:') |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1011 | self.indent() |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1012 | self.blockvisit(node.else_, if_frame) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1013 | self.outdent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1014 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1015 | def visit_Macro(self, node, frame): |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1016 | macro_frame = self.function_scoping(node, frame) |
| 1017 | args = macro_frame.arguments |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1018 | self.writeline('def macro(%s):' % ', '.join(args), node) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1019 | macro_frame.buffer = buf = self.temporary_identifier() |
| 1020 | self.indent() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1021 | self.pull_locals(macro_frame) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1022 | self.writeline('%s = []' % buf) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1023 | self.blockvisit(node.body, macro_frame) |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1024 | if self.environment.autoescape: |
| 1025 | self.writeline('return Markup(concat(%s))' % buf) |
| 1026 | else: |
| 1027 | self.writeline("return concat(%s)" % buf) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1028 | self.outdent() |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1029 | self.newline() |
| 1030 | if frame.toplevel: |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1031 | if not node.name.startswith('__'): |
| 1032 | self.write('context.exported_vars.add(%r)' % node.name) |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 1033 | self.writeline('context.vars[%r] = ' % node.name) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1034 | arg_tuple = ', '.join(repr(x.name) for x in node.args) |
| 1035 | if len(node.args) == 1: |
| 1036 | arg_tuple += ',' |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 1037 | self.write('l_%s = Macro(environment, macro, %r, (%s), (' % |
| 1038 | (node.name, node.name, arg_tuple)) |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 1039 | for arg in node.defaults: |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1040 | self.visit(arg, macro_frame) |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 1041 | self.write(', ') |
Armin Ronacher | 963f97d | 2008-04-25 11:44:59 +0200 | [diff] [blame] | 1042 | self.write('), %s, %s, %s)' % ( |
| 1043 | macro_frame.accesses_kwargs and '1' or '0', |
| 1044 | macro_frame.accesses_varargs and '1' or '0', |
Armin Ronacher | 00d5d21 | 2008-04-13 01:10:18 +0200 | [diff] [blame] | 1045 | macro_frame.accesses_caller and '1' or '0' |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1046 | )) |
| 1047 | |
| 1048 | def visit_CallBlock(self, node, frame): |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1049 | call_frame = self.function_scoping(node, frame, node.iter_child_nodes |
| 1050 | (exclude=('call',))) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1051 | args = call_frame.arguments |
| 1052 | self.writeline('def call(%s):' % ', '.join(args), node) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1053 | call_frame.buffer = buf = self.temporary_identifier() |
| 1054 | self.indent() |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1055 | self.pull_locals(call_frame) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1056 | self.writeline('%s = []' % buf) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1057 | self.blockvisit(node.body, call_frame) |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1058 | if self.environment.autoescape: |
| 1059 | self.writeline("return Markup(concat(%s))" % buf) |
| 1060 | else: |
| 1061 | self.writeline('return concat(%s)' % buf) |
Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 1062 | self.outdent() |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1063 | arg_tuple = ', '.join(repr(x.name) for x in node.args) |
| 1064 | if len(node.args) == 1: |
| 1065 | arg_tuple += ',' |
Armin Ronacher | c63243e | 2008-04-14 22:53:58 +0200 | [diff] [blame] | 1066 | self.writeline('caller = Macro(environment, call, None, (%s), (' % |
| 1067 | arg_tuple) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1068 | for arg in node.defaults: |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1069 | self.visit(arg, call_frame) |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1070 | self.write(', ') |
Armin Ronacher | 963f97d | 2008-04-25 11:44:59 +0200 | [diff] [blame] | 1071 | self.write('), %s, %s, 0)' % ( |
| 1072 | call_frame.accesses_kwargs and '1' or '0', |
| 1073 | call_frame.accesses_varargs and '1' or '0' |
| 1074 | )) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1075 | if frame.buffer is None: |
| 1076 | self.writeline('yield ', node) |
| 1077 | else: |
| 1078 | self.writeline('%s.append(' % frame.buffer, node) |
Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 1079 | self.visit_Call(node.call, call_frame, |
| 1080 | extra_kwargs={'caller': 'caller'}) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1081 | if frame.buffer is not None: |
| 1082 | self.write(')') |
| 1083 | |
| 1084 | def visit_FilterBlock(self, node, frame): |
| 1085 | filter_frame = frame.inner() |
| 1086 | filter_frame.inspect(node.iter_child_nodes()) |
| 1087 | |
| 1088 | aliases = self.collect_shadowed(filter_frame) |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1089 | self.pull_locals(filter_frame) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1090 | filter_frame.buffer = buf = self.temporary_identifier() |
| 1091 | |
| 1092 | self.writeline('%s = []' % buf, node) |
| 1093 | for child in node.body: |
| 1094 | self.visit(child, filter_frame) |
| 1095 | |
| 1096 | if frame.buffer is None: |
| 1097 | self.writeline('yield ', node) |
| 1098 | else: |
| 1099 | self.writeline('%s.append(' % frame.buffer, node) |
Armin Ronacher | de6bf71 | 2008-04-26 01:44:14 +0200 | [diff] [blame] | 1100 | self.visit_Filter(node.filter, filter_frame, 'concat(%s)' % buf) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1101 | if frame.buffer is not None: |
| 1102 | self.write(')') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1103 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1104 | def visit_ExprStmt(self, node, frame): |
| 1105 | self.newline(node) |
Armin Ronacher | 6ce170c | 2008-04-25 12:32:36 +0200 | [diff] [blame] | 1106 | self.visit(node.node, frame) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1107 | |
| 1108 | def visit_Output(self, node, frame): |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1109 | # if we have a known extends statement, we don't output anything |
Armin Ronacher | 7a52df8 | 2008-04-11 13:58:22 +0200 | [diff] [blame] | 1110 | if self.has_known_extends and frame.toplevel: |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1111 | return |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1112 | |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1113 | self.newline(node) |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 1114 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 1115 | # if we are in the toplevel scope and there was already an extends |
| 1116 | # statement we have to add a check that disables our yield(s) here |
| 1117 | # so that they don't appear in the output. |
| 1118 | outdent_later = False |
| 1119 | if frame.toplevel and self.extends_so_far != 0: |
Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 1120 | self.writeline('if parent_template is None:') |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1121 | self.indent() |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 1122 | outdent_later = True |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1123 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1124 | # try to evaluate as many chunks as possible into a static |
| 1125 | # string at compile time. |
| 1126 | body = [] |
| 1127 | for child in node.nodes: |
| 1128 | try: |
| 1129 | const = unicode(child.as_const()) |
| 1130 | except: |
| 1131 | body.append(child) |
| 1132 | continue |
| 1133 | if body and isinstance(body[-1], list): |
| 1134 | body[-1].append(const) |
| 1135 | else: |
| 1136 | body.append([const]) |
| 1137 | |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 1138 | # if we have less than 3 nodes or less than 6 and a buffer we |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 1139 | # yield or extend/append |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 1140 | if len(body) < 3 or (frame.buffer is not None and len(body) < 6): |
| 1141 | if frame.buffer is not None: |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 1142 | # for one item we append, for more we extend |
| 1143 | if len(body) == 1: |
| 1144 | self.writeline('%s.append(' % frame.buffer) |
| 1145 | else: |
| 1146 | self.writeline('%s.extend((' % frame.buffer) |
Armin Ronacher | 1f627ff | 2008-05-15 13:23:26 +0200 | [diff] [blame] | 1147 | self.indent() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1148 | for item in body: |
| 1149 | if isinstance(item, list): |
Armin Ronacher | de6bf71 | 2008-04-26 01:44:14 +0200 | [diff] [blame] | 1150 | val = repr(concat(item)) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1151 | if frame.buffer is None: |
| 1152 | self.writeline('yield ' + val) |
| 1153 | else: |
Armin Ronacher | 1f627ff | 2008-05-15 13:23:26 +0200 | [diff] [blame] | 1154 | self.writeline(val + ', ') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1155 | else: |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1156 | if frame.buffer is None: |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 1157 | self.writeline('yield ') |
Armin Ronacher | 1f627ff | 2008-05-15 13:23:26 +0200 | [diff] [blame] | 1158 | else: |
| 1159 | self.newline(item) |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1160 | close = 1 |
| 1161 | if self.environment.autoescape: |
| 1162 | self.write('escape(') |
| 1163 | else: |
| 1164 | self.write('unicode(') |
| 1165 | if self.environment.finalize is not None: |
| 1166 | self.write('environment.finalize(') |
| 1167 | close += 1 |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1168 | self.visit(item, frame) |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1169 | self.write(')' * close) |
Armin Ronacher | 32a910f | 2008-04-26 23:21:03 +0200 | [diff] [blame] | 1170 | if frame.buffer is not None: |
| 1171 | self.write(', ') |
| 1172 | if frame.buffer is not None: |
Armin Ronacher | 1e1e890 | 2008-05-11 23:21:16 +0200 | [diff] [blame] | 1173 | # close the open parentheses |
Armin Ronacher | 1f627ff | 2008-05-15 13:23:26 +0200 | [diff] [blame] | 1174 | self.outdent() |
| 1175 | self.writeline(len(body) == 1 and ')' or '))') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1176 | |
| 1177 | # otherwise we create a format string as this is faster in that case |
| 1178 | else: |
| 1179 | format = [] |
| 1180 | arguments = [] |
| 1181 | for item in body: |
| 1182 | if isinstance(item, list): |
Armin Ronacher | de6bf71 | 2008-04-26 01:44:14 +0200 | [diff] [blame] | 1183 | format.append(concat(item).replace('%', '%%')) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1184 | else: |
| 1185 | format.append('%s') |
| 1186 | arguments.append(item) |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1187 | if frame.buffer is None: |
| 1188 | self.writeline('yield ') |
| 1189 | else: |
| 1190 | self.writeline('%s.append(' % frame.buffer) |
Armin Ronacher | de6bf71 | 2008-04-26 01:44:14 +0200 | [diff] [blame] | 1191 | self.write(repr(concat(format)) + ' % (') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1192 | idx = -1 |
Armin Ronacher | 8e8d071 | 2008-04-16 23:10:49 +0200 | [diff] [blame] | 1193 | for argument in arguments: |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1194 | close = 0 |
| 1195 | if self.environment.autoescape: |
| 1196 | self.write('escape(') |
| 1197 | close += 1 |
| 1198 | if self.environment.finalize is not None: |
| 1199 | self.write('environment.finalize(') |
| 1200 | close += 1 |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1201 | self.visit(argument, frame) |
Armin Ronacher | 1f627ff | 2008-05-15 13:23:26 +0200 | [diff] [blame] | 1202 | self.write(')' * close + ', ') |
| 1203 | self.write(')') |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1204 | if frame.buffer is not None: |
| 1205 | self.write(')') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1206 | |
Armin Ronacher | 7fb3897 | 2008-04-11 13:54:28 +0200 | [diff] [blame] | 1207 | if outdent_later: |
Armin Ronacher | 75cfb86 | 2008-04-11 13:47:22 +0200 | [diff] [blame] | 1208 | self.outdent() |
| 1209 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1210 | def visit_Assign(self, node, frame): |
| 1211 | self.newline(node) |
| 1212 | # toplevel assignments however go into the local namespace and |
| 1213 | # the current template's context. We create a copy of the frame |
| 1214 | # here and add a set so that the Name visitor can add the assigned |
| 1215 | # names here. |
| 1216 | if frame.toplevel: |
| 1217 | assignment_frame = frame.copy() |
| 1218 | assignment_frame.assigned_names = set() |
| 1219 | else: |
| 1220 | assignment_frame = frame |
| 1221 | self.visit(node.target, assignment_frame) |
| 1222 | self.write(' = ') |
| 1223 | self.visit(node.node, frame) |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 1224 | |
| 1225 | # make sure toplevel assignments are added to the context. |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1226 | if frame.toplevel: |
Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 1227 | public_names = [x for x in assignment_frame.assigned_names |
| 1228 | if not x.startswith('__')] |
| 1229 | if len(assignment_frame.assigned_names) == 1: |
| 1230 | name = iter(assignment_frame.assigned_names).next() |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 1231 | self.writeline('context.vars[%r] = l_%s' % (name, name)) |
Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 1232 | else: |
| 1233 | self.writeline('context.vars.update({') |
| 1234 | for idx, name in enumerate(assignment_frame.assigned_names): |
| 1235 | if idx: |
| 1236 | self.write(', ') |
| 1237 | self.write('%r: l_%s' % (name, name)) |
| 1238 | self.write('})') |
| 1239 | if public_names: |
| 1240 | if len(public_names) == 1: |
| 1241 | self.writeline('context.exported_vars.add(%r)' % |
| 1242 | public_names[0]) |
| 1243 | else: |
| 1244 | self.writeline('context.exported_vars.update((%s))' % |
| 1245 | ', '.join(map(repr, public_names))) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1246 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1247 | def visit_Name(self, node, frame): |
Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 1248 | if node.ctx == 'store' and frame.toplevel: |
| 1249 | frame.assigned_names.add(node.name) |
Armin Ronacher | d1ff858 | 2008-05-11 00:30:43 +0200 | [diff] [blame] | 1250 | self.write('l_' + node.name) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1251 | |
Armin Ronacher | d84ec46 | 2008-04-29 13:43:16 +0200 | [diff] [blame] | 1252 | def visit_MarkSafe(self, node, frame): |
| 1253 | self.write('Markup(') |
| 1254 | self.visit(node.expr, frame) |
| 1255 | self.write(')') |
| 1256 | |
Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 1257 | def visit_EnvironmentAttribute(self, node, frame): |
| 1258 | self.write('environment.' + node.name) |
| 1259 | |
| 1260 | def visit_ExtensionAttribute(self, node, frame): |
| 1261 | self.write('environment.extensions[%r].%s' % (node.identifier, node.attr)) |
| 1262 | |
| 1263 | def visit_ImportedName(self, node, frame): |
| 1264 | self.write(self.import_aliases[node.importname]) |
| 1265 | |
| 1266 | def visit_InternalName(self, node, frame): |
| 1267 | self.write(node.name) |
| 1268 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1269 | def visit_Const(self, node, frame): |
| 1270 | val = node.value |
| 1271 | if isinstance(val, float): |
| 1272 | # XXX: add checks for infinity and nan |
| 1273 | self.write(str(val)) |
| 1274 | else: |
| 1275 | self.write(repr(val)) |
| 1276 | |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1277 | def visit_Tuple(self, node, frame): |
| 1278 | self.write('(') |
| 1279 | idx = -1 |
| 1280 | for idx, item in enumerate(node.items): |
| 1281 | if idx: |
| 1282 | self.write(', ') |
| 1283 | self.visit(item, frame) |
| 1284 | self.write(idx == 0 and ',)' or ')') |
| 1285 | |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 1286 | def visit_List(self, node, frame): |
| 1287 | self.write('[') |
| 1288 | for idx, item in enumerate(node.items): |
| 1289 | if idx: |
| 1290 | self.write(', ') |
| 1291 | self.visit(item, frame) |
| 1292 | self.write(']') |
| 1293 | |
| 1294 | def visit_Dict(self, node, frame): |
| 1295 | self.write('{') |
| 1296 | for idx, item in enumerate(node.items): |
| 1297 | if idx: |
| 1298 | self.write(', ') |
| 1299 | self.visit(item.key, frame) |
| 1300 | self.write(': ') |
| 1301 | self.visit(item.value, frame) |
| 1302 | self.write('}') |
| 1303 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1304 | def binop(operator): |
| 1305 | def visitor(self, node, frame): |
| 1306 | self.write('(') |
| 1307 | self.visit(node.left, frame) |
| 1308 | self.write(' %s ' % operator) |
| 1309 | self.visit(node.right, frame) |
| 1310 | self.write(')') |
| 1311 | return visitor |
| 1312 | |
| 1313 | def uaop(operator): |
| 1314 | def visitor(self, node, frame): |
| 1315 | self.write('(' + operator) |
Armin Ronacher | 9a82205 | 2008-04-17 18:44:07 +0200 | [diff] [blame] | 1316 | self.visit(node.node, frame) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1317 | self.write(')') |
| 1318 | return visitor |
| 1319 | |
| 1320 | visit_Add = binop('+') |
| 1321 | visit_Sub = binop('-') |
| 1322 | visit_Mul = binop('*') |
| 1323 | visit_Div = binop('/') |
| 1324 | visit_FloorDiv = binop('//') |
| 1325 | visit_Pow = binop('**') |
| 1326 | visit_Mod = binop('%') |
| 1327 | visit_And = binop('and') |
| 1328 | visit_Or = binop('or') |
| 1329 | visit_Pos = uaop('+') |
| 1330 | visit_Neg = uaop('-') |
| 1331 | visit_Not = uaop('not ') |
| 1332 | del binop, uaop |
| 1333 | |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1334 | def visit_Concat(self, node, frame): |
Armin Ronacher | fdf9530 | 2008-05-11 22:20:51 +0200 | [diff] [blame] | 1335 | self.write('%s((' % (self.environment.autoescape and |
| 1336 | 'markup_join' or 'unicode_join')) |
Armin Ronacher | d134231 | 2008-04-28 12:20:12 +0200 | [diff] [blame] | 1337 | for arg in node.nodes: |
| 1338 | self.visit(arg, frame) |
| 1339 | self.write(', ') |
| 1340 | self.write('))') |
| 1341 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1342 | def visit_Compare(self, node, frame): |
| 1343 | self.visit(node.expr, frame) |
| 1344 | for op in node.ops: |
| 1345 | self.visit(op, frame) |
| 1346 | |
| 1347 | def visit_Operand(self, node, frame): |
| 1348 | self.write(' %s ' % operators[node.op]) |
| 1349 | self.visit(node.expr, frame) |
| 1350 | |
| 1351 | def visit_Subscript(self, node, frame): |
Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 1352 | # subscripts can have overlays |
| 1353 | if self.overlay(node, frame): |
| 1354 | return |
| 1355 | |
Armin Ronacher | 08a6a3b | 2008-05-13 15:35:47 +0200 | [diff] [blame] | 1356 | # slices or integer subscriptions bypass the subscribe |
| 1357 | # method if we can determine that at compile time. |
| 1358 | if isinstance(node.arg, nodes.Slice) or \ |
| 1359 | (isinstance(node.arg, nodes.Const) and |
| 1360 | isinstance(node.arg.value, (int, long))): |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1361 | self.visit(node.node, frame) |
| 1362 | self.write('[') |
| 1363 | self.visit(node.arg, frame) |
| 1364 | self.write(']') |
| 1365 | return |
| 1366 | try: |
| 1367 | const = node.arg.as_const() |
| 1368 | have_const = True |
| 1369 | except nodes.Impossible: |
| 1370 | have_const = False |
Armin Ronacher | c63243e | 2008-04-14 22:53:58 +0200 | [diff] [blame] | 1371 | self.write('environment.subscribe(') |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1372 | self.visit(node.node, frame) |
| 1373 | self.write(', ') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1374 | if have_const: |
| 1375 | self.write(repr(const)) |
| 1376 | else: |
| 1377 | self.visit(node.arg, frame) |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 1378 | self.write(')') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1379 | |
| 1380 | def visit_Slice(self, node, frame): |
| 1381 | if node.start is not None: |
| 1382 | self.visit(node.start, frame) |
| 1383 | self.write(':') |
| 1384 | if node.stop is not None: |
| 1385 | self.visit(node.stop, frame) |
| 1386 | if node.step is not None: |
| 1387 | self.write(':') |
| 1388 | self.visit(node.step, frame) |
| 1389 | |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1390 | def visit_Filter(self, node, frame, initial=None): |
Armin Ronacher | b9e7875 | 2008-05-10 23:36:28 +0200 | [diff] [blame] | 1391 | self.write(self.filters[node.name] + '(') |
Christoph Hack | 8090986 | 2008-04-14 01:35:10 +0200 | [diff] [blame] | 1392 | func = self.environment.filters.get(node.name) |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 1393 | if func is None: |
| 1394 | raise TemplateAssertionError('no filter named %r' % node.name, |
| 1395 | node.lineno, self.filename) |
Christoph Hack | 8090986 | 2008-04-14 01:35:10 +0200 | [diff] [blame] | 1396 | if getattr(func, 'contextfilter', False): |
| 1397 | self.write('context, ') |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame] | 1398 | elif getattr(func, 'environmentfilter', False): |
| 1399 | self.write('environment, ') |
Christoph Hack | 8090986 | 2008-04-14 01:35:10 +0200 | [diff] [blame] | 1400 | if isinstance(node.node, nodes.Filter): |
| 1401 | self.visit_Filter(node.node, frame, initial) |
| 1402 | elif node.node is None: |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1403 | self.write(initial) |
| 1404 | else: |
Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 1405 | self.visit(node.node, frame) |
Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 1406 | self.signature(node, frame) |
| 1407 | self.write(')') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1408 | |
| 1409 | def visit_Test(self, node, frame): |
Armin Ronacher | b9e7875 | 2008-05-10 23:36:28 +0200 | [diff] [blame] | 1410 | self.write(self.tests[node.name] + '(') |
Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 1411 | if node.name not in self.environment.tests: |
| 1412 | raise TemplateAssertionError('no test named %r' % node.name, |
| 1413 | node.lineno, self.filename) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1414 | self.visit(node.node, frame) |
| 1415 | self.signature(node, frame) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1416 | self.write(')') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1417 | |
Armin Ronacher | 3d8b784 | 2008-04-13 13:16:50 +0200 | [diff] [blame] | 1418 | def visit_CondExpr(self, node, frame): |
| 1419 | if not have_condexpr: |
| 1420 | self.write('((') |
| 1421 | self.visit(node.test, frame) |
| 1422 | self.write(') and (') |
| 1423 | self.visit(node.expr1, frame) |
| 1424 | self.write(',) or (') |
| 1425 | self.visit(node.expr2, frame) |
| 1426 | self.write(',))[0]') |
| 1427 | else: |
| 1428 | self.write('(') |
| 1429 | self.visit(node.expr1, frame) |
| 1430 | self.write(' if ') |
| 1431 | self.visit(node.test, frame) |
| 1432 | self.write(' else ') |
| 1433 | self.visit(node.expr2, frame) |
| 1434 | self.write(')') |
| 1435 | |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1436 | def visit_Call(self, node, frame, extra_kwargs=None): |
Armin Ronacher | c63243e | 2008-04-14 22:53:58 +0200 | [diff] [blame] | 1437 | if self.environment.sandboxed: |
| 1438 | self.write('environment.call(') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1439 | self.visit(node.node, frame) |
Armin Ronacher | c63243e | 2008-04-14 22:53:58 +0200 | [diff] [blame] | 1440 | self.write(self.environment.sandboxed and ', ' or '(') |
Armin Ronacher | 7108207 | 2008-04-12 14:19:36 +0200 | [diff] [blame] | 1441 | self.signature(node, frame, False, extra_kwargs) |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1442 | self.write(')') |
| 1443 | |
| 1444 | def visit_Keyword(self, node, frame): |
Armin Ronacher | 2e9396b | 2008-04-16 14:21:57 +0200 | [diff] [blame] | 1445 | self.write(node.key + '=') |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 1446 | self.visit(node.value, frame) |