| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | """ |
| 3 | jinja2.nodes |
| 4 | ~~~~~~~~~~~~ |
| 5 | |
| 6 | This module implements additional nodes derived from the ast base node. |
| 7 | |
| 8 | It also provides some node tree helper functions like `in_lineno` and |
| 9 | `get_nodes` used by the parser and translator in order to normalize |
| 10 | python and jinja nodes. |
| 11 | |
| Armin Ronacher | 55494e4 | 2010-01-22 09:41:48 +0100 | [diff] [blame] | 12 | :copyright: (c) 2010 by the Jinja Team. |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 13 | :license: BSD, see LICENSE for more details. |
| 14 | """ |
| 15 | import operator |
| 16 | from itertools import chain, izip |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 17 | from collections import deque |
| Armin Ronacher | 5a5ce73 | 2010-05-23 22:58:28 +0200 | [diff] [blame] | 18 | from jinja2.utils import Markup, MethodType, FunctionType |
| 19 | |
| 20 | |
| 21 | #: the types we support for context functions |
| 22 | _context_function_types = (FunctionType, MethodType) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 23 | |
| 24 | |
| 25 | _binop_to_func = { |
| 26 | '*': operator.mul, |
| 27 | '/': operator.truediv, |
| 28 | '//': operator.floordiv, |
| 29 | '**': operator.pow, |
| 30 | '%': operator.mod, |
| 31 | '+': operator.add, |
| 32 | '-': operator.sub |
| 33 | } |
| 34 | |
| 35 | _uaop_to_func = { |
| 36 | 'not': operator.not_, |
| 37 | '+': operator.pos, |
| 38 | '-': operator.neg |
| 39 | } |
| 40 | |
| Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 41 | _cmpop_to_func = { |
| 42 | 'eq': operator.eq, |
| 43 | 'ne': operator.ne, |
| 44 | 'gt': operator.gt, |
| 45 | 'gteq': operator.ge, |
| 46 | 'lt': operator.lt, |
| 47 | 'lteq': operator.le, |
| Armin Ronacher | b5124e6 | 2008-04-25 00:36:14 +0200 | [diff] [blame] | 48 | 'in': lambda a, b: a in b, |
| 49 | 'notin': lambda a, b: a not in b |
| Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 50 | } |
| 51 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 52 | |
| 53 | class Impossible(Exception): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 54 | """Raised if the node could not perform a requested action.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 55 | |
| 56 | |
| 57 | class NodeType(type): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 58 | """A metaclass for nodes that handles the field and attribute |
| 59 | inheritance. fields and attributes from the parent class are |
| 60 | automatically forwarded to the child.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 61 | |
| 62 | def __new__(cls, name, bases, d): |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 63 | for attr in 'fields', 'attributes': |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 64 | storage = [] |
| Armin Ronacher | 7324eb8 | 2008-04-21 07:55:52 +0200 | [diff] [blame] | 65 | storage.extend(getattr(bases[0], attr, ())) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 66 | storage.extend(d.get(attr, ())) |
| Armin Ronacher | 7324eb8 | 2008-04-21 07:55:52 +0200 | [diff] [blame] | 67 | assert len(bases) == 1, 'multiple inheritance not allowed' |
| 68 | assert len(storage) == len(set(storage)), 'layout conflict' |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 69 | d[attr] = tuple(storage) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 70 | d.setdefault('abstract', False) |
| Armin Ronacher | 7324eb8 | 2008-04-21 07:55:52 +0200 | [diff] [blame] | 71 | return type.__new__(cls, name, bases, d) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 72 | |
| 73 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 74 | class EvalContext(object): |
| Armin Ronacher | 30fda27 | 2010-03-15 03:06:04 +0100 | [diff] [blame] | 75 | """Holds evaluation time information. Custom attributes can be attached |
| 76 | to it in extensions. |
| 77 | """ |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 78 | |
| Armin Ronacher | 1da23d1 | 2010-04-05 18:11:18 +0200 | [diff] [blame] | 79 | def __init__(self, environment, template_name=None): |
| 80 | if callable(environment.autoescape): |
| 81 | self.autoescape = environment.autoescape(template_name) |
| 82 | else: |
| 83 | self.autoescape = environment.autoescape |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 84 | self.volatile = False |
| 85 | |
| 86 | def save(self): |
| 87 | return self.__dict__.copy() |
| 88 | |
| 89 | def revert(self, old): |
| 90 | self.__dict__.clear() |
| 91 | self.__dict__.update(old) |
| 92 | |
| 93 | |
| 94 | def get_eval_context(node, ctx): |
| 95 | if ctx is None: |
| 96 | if node.environment is None: |
| 97 | raise RuntimeError('if no eval context is passed, the ' |
| 98 | 'node must have an attached ' |
| 99 | 'environment.') |
| 100 | return EvalContext(node.environment) |
| 101 | return ctx |
| 102 | |
| 103 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 104 | class Node(object): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 105 | """Baseclass for all Jinja2 nodes. There are a number of nodes available |
| 106 | of different types. There are three major types: |
| 107 | |
| 108 | - :class:`Stmt`: statements |
| 109 | - :class:`Expr`: expressions |
| 110 | - :class:`Helper`: helper nodes |
| 111 | - :class:`Template`: the outermost wrapper node |
| 112 | |
| 113 | All nodes have fields and attributes. Fields may be other nodes, lists, |
| 114 | or arbitrary values. Fields are passed to the constructor as regular |
| 115 | positional arguments, attributes as keyword arguments. Each node has |
| 116 | two attributes: `lineno` (the line number of the node) and `environment`. |
| 117 | The `environment` attribute is set at the end of the parsing process for |
| 118 | all nodes automatically. |
| 119 | """ |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 120 | __metaclass__ = NodeType |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 121 | fields = () |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 122 | attributes = ('lineno', 'environment') |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 123 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 124 | |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 125 | def __init__(self, *fields, **attributes): |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 126 | if self.abstract: |
| 127 | raise TypeError('abstract nodes are not instanciable') |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 128 | if fields: |
| 129 | if len(fields) != len(self.fields): |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 130 | if not self.fields: |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 131 | raise TypeError('%r takes 0 arguments' % |
| 132 | self.__class__.__name__) |
| 133 | raise TypeError('%r takes 0 or %d argument%s' % ( |
| 134 | self.__class__.__name__, |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 135 | len(self.fields), |
| 136 | len(self.fields) != 1 and 's' or '' |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 137 | )) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 138 | for name, arg in izip(self.fields, fields): |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 139 | setattr(self, name, arg) |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 140 | for attr in self.attributes: |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 141 | setattr(self, attr, attributes.pop(attr, None)) |
| 142 | if attributes: |
| 143 | raise TypeError('unknown attribute %r' % |
| 144 | iter(attributes).next()) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 145 | |
| Armin Ronacher | 105f0dc | 2008-05-23 16:12:47 +0200 | [diff] [blame] | 146 | def iter_fields(self, exclude=None, only=None): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 147 | """This method iterates over all fields that are defined and yields |
| Armin Ronacher | 3da9031 | 2008-05-23 16:37:28 +0200 | [diff] [blame] | 148 | ``(key, value)`` tuples. Per default all fields are returned, but |
| 149 | it's possible to limit that to some fields by providing the `only` |
| 150 | parameter or to exclude some using the `exclude` parameter. Both |
| 151 | should be sets or tuples of field names. |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 152 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 153 | for name in self.fields: |
| Armin Ronacher | 105f0dc | 2008-05-23 16:12:47 +0200 | [diff] [blame] | 154 | if (exclude is only is None) or \ |
| 155 | (exclude is not None and name not in exclude) or \ |
| 156 | (only is not None and name in only): |
| Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 157 | try: |
| 158 | yield name, getattr(self, name) |
| 159 | except AttributeError: |
| 160 | pass |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 161 | |
| Armin Ronacher | 105f0dc | 2008-05-23 16:12:47 +0200 | [diff] [blame] | 162 | def iter_child_nodes(self, exclude=None, only=None): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 163 | """Iterates over all direct child nodes of the node. This iterates |
| 164 | over all fields and yields the values of they are nodes. If the value |
| 165 | of a field is a list all the nodes in that list are returned. |
| 166 | """ |
| Armin Ronacher | 105f0dc | 2008-05-23 16:12:47 +0200 | [diff] [blame] | 167 | for field, item in self.iter_fields(exclude, only): |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 168 | if isinstance(item, list): |
| 169 | for n in item: |
| 170 | if isinstance(n, Node): |
| 171 | yield n |
| 172 | elif isinstance(item, Node): |
| 173 | yield item |
| 174 | |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 175 | def find(self, node_type): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 176 | """Find the first node of a given type. If no such node exists the |
| 177 | return value is `None`. |
| 178 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 179 | for result in self.find_all(node_type): |
| 180 | return result |
| 181 | |
| 182 | def find_all(self, node_type): |
| Armin Ronacher | 63cf9b8 | 2009-07-26 10:33:36 +0200 | [diff] [blame] | 183 | """Find all the nodes of a given type. If the type is a tuple, |
| 184 | the check is performed for any of the tuple items. |
| 185 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 186 | for child in self.iter_child_nodes(): |
| 187 | if isinstance(child, node_type): |
| 188 | yield child |
| 189 | for result in child.find_all(node_type): |
| 190 | yield result |
| 191 | |
| 192 | def set_ctx(self, ctx): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 193 | """Reset the context of a node and all child nodes. Per default the |
| 194 | parser will all generate nodes that have a 'load' context as it's the |
| 195 | most common one. This method is used in the parser to set assignment |
| 196 | targets and other nodes to a store context. |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 197 | """ |
| 198 | todo = deque([self]) |
| 199 | while todo: |
| 200 | node = todo.popleft() |
| 201 | if 'ctx' in node.fields: |
| 202 | node.ctx = ctx |
| 203 | todo.extend(node.iter_child_nodes()) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 204 | return self |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 205 | |
| Armin Ronacher | 2e9396b | 2008-04-16 14:21:57 +0200 | [diff] [blame] | 206 | def set_lineno(self, lineno, override=False): |
| 207 | """Set the line numbers of the node and children.""" |
| 208 | todo = deque([self]) |
| 209 | while todo: |
| 210 | node = todo.popleft() |
| 211 | if 'lineno' in node.attributes: |
| 212 | if node.lineno is None or override: |
| 213 | node.lineno = lineno |
| 214 | todo.extend(node.iter_child_nodes()) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 215 | return self |
| Armin Ronacher | 2e9396b | 2008-04-16 14:21:57 +0200 | [diff] [blame] | 216 | |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 217 | def set_environment(self, environment): |
| 218 | """Set the environment for all nodes.""" |
| 219 | todo = deque([self]) |
| 220 | while todo: |
| 221 | node = todo.popleft() |
| 222 | node.environment = environment |
| 223 | todo.extend(node.iter_child_nodes()) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 224 | return self |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 225 | |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 226 | def __eq__(self, other): |
| Armin Ronacher | b3a1fcf | 2008-05-15 11:04:14 +0200 | [diff] [blame] | 227 | return type(self) is type(other) and \ |
| 228 | tuple(self.iter_fields()) == tuple(other.iter_fields()) |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 229 | |
| 230 | def __ne__(self, other): |
| 231 | return not self.__eq__(other) |
| 232 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 233 | def __repr__(self): |
| 234 | return '%s(%s)' % ( |
| 235 | self.__class__.__name__, |
| 236 | ', '.join('%s=%r' % (arg, getattr(self, arg, None)) for |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 237 | arg in self.fields) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 238 | ) |
| 239 | |
| 240 | |
| 241 | class Stmt(Node): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 242 | """Base node for all statements.""" |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 243 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 244 | |
| 245 | |
| 246 | class Helper(Node): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 247 | """Nodes that exist in a specific context only.""" |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 248 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 249 | |
| 250 | |
| 251 | class Template(Node): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 252 | """Node that represents a template. This must be the outermost node that |
| 253 | is passed to the compiler. |
| 254 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 255 | fields = ('body',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 256 | |
| 257 | |
| 258 | class Output(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 259 | """A node that holds multiple expressions which are then printed out. |
| 260 | This is used both for the `print` statement and the regular template data. |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 261 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 262 | fields = ('nodes',) |
| 263 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 264 | |
| 265 | class Extends(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 266 | """Represents an extends statement.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 267 | fields = ('template',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 268 | |
| 269 | |
| 270 | class For(Stmt): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 271 | """The for loop. `target` is the target for the iteration (usually a |
| 272 | :class:`Name` or :class:`Tuple`), `iter` the iterable. `body` is a list |
| 273 | of nodes that are used as loop-body, and `else_` a list of nodes for the |
| 274 | `else` block. If no else node exists it has to be an empty list. |
| 275 | |
| 276 | For filtered nodes an expression can be stored as `test`, otherwise `None`. |
| 277 | """ |
| Armin Ronacher | fdf9530 | 2008-05-11 22:20:51 +0200 | [diff] [blame] | 278 | fields = ('target', 'iter', 'body', 'else_', 'test', 'recursive') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 279 | |
| 280 | |
| 281 | class If(Stmt): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 282 | """If `test` is true, `body` is rendered, else `else_`.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 283 | fields = ('test', 'body', 'else_') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 284 | |
| 285 | |
| 286 | class Macro(Stmt): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 287 | """A macro definition. `name` is the name of the macro, `args` a list of |
| 288 | arguments and `defaults` a list of defaults if there are any. `body` is |
| 289 | a list of nodes for the macro body. |
| 290 | """ |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 291 | fields = ('name', 'args', 'defaults', 'body') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 292 | |
| 293 | |
| 294 | class CallBlock(Stmt): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 295 | """Like a macro without a name but a call instead. `call` is called with |
| 296 | the unnamed macro as `caller` argument this node holds. |
| 297 | """ |
| Armin Ronacher | c9705c2 | 2008-04-27 21:28:03 +0200 | [diff] [blame] | 298 | fields = ('call', 'args', 'defaults', 'body') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 299 | |
| 300 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 301 | class FilterBlock(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 302 | """Node for filter sections.""" |
| Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 303 | fields = ('body', 'filter') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 304 | |
| 305 | |
| 306 | class Block(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 307 | """A node that represents a block.""" |
| Armin Ronacher | 74a0cd9 | 2009-02-19 15:56:53 +0100 | [diff] [blame] | 308 | fields = ('name', 'body', 'scoped') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 309 | |
| 310 | |
| 311 | class Include(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 312 | """A node that represents the include tag.""" |
| Armin Ronacher | 37f58ce | 2008-12-27 13:10:38 +0100 | [diff] [blame] | 313 | fields = ('template', 'with_context', 'ignore_missing') |
| Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 314 | |
| 315 | |
| 316 | class Import(Stmt): |
| 317 | """A node that represents the import tag.""" |
| Armin Ronacher | ea847c5 | 2008-05-02 20:04:32 +0200 | [diff] [blame] | 318 | fields = ('template', 'target', 'with_context') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 319 | |
| 320 | |
| Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 321 | class FromImport(Stmt): |
| 322 | """A node that represents the from import tag. It's important to not |
| 323 | pass unsafe names to the name attribute. The compiler translates the |
| 324 | attribute lookups directly into getattr calls and does *not* use the |
| Armin Ronacher | b938877 | 2008-06-25 20:43:18 +0200 | [diff] [blame] | 325 | subscript callback of the interface. As exported variables may not |
| Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 326 | start with double underscores (which the parser asserts) this is not a |
| 327 | problem for regular Jinja code, but if this node is used in an extension |
| 328 | extra care must be taken. |
| Armin Ronacher | 2feed1d | 2008-04-26 16:26:52 +0200 | [diff] [blame] | 329 | |
| 330 | The list of names may contain tuples if aliases are wanted. |
| Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 331 | """ |
| Armin Ronacher | ea847c5 | 2008-05-02 20:04:32 +0200 | [diff] [blame] | 332 | fields = ('template', 'names', 'with_context') |
| Armin Ronacher | 0611e49 | 2008-04-25 23:44:14 +0200 | [diff] [blame] | 333 | |
| 334 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 335 | class ExprStmt(Stmt): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 336 | """A statement that evaluates an expression and discards the result.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 337 | fields = ('node',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 338 | |
| 339 | |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 340 | class Assign(Stmt): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 341 | """Assigns an expression to a target.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 342 | fields = ('target', 'node') |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 343 | |
| 344 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 345 | class Expr(Node): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 346 | """Baseclass for all expressions.""" |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 347 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 348 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 349 | def as_const(self, eval_ctx=None): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 350 | """Return the value of the expression as constant or raise |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 351 | :exc:`Impossible` if this was not possible. |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 352 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 353 | An :class:`EvalContext` can be provided, if none is given |
| 354 | a default context is created which requires the nodes to have |
| 355 | an attached environment. |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 356 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 357 | .. versionchanged:: 2.4 |
| 358 | the `eval_ctx` parameter was added. |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 359 | """ |
| 360 | raise Impossible() |
| 361 | |
| 362 | def can_assign(self): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 363 | """Check if it's possible to assign something to this node.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 364 | return False |
| 365 | |
| 366 | |
| 367 | class BinExpr(Expr): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 368 | """Baseclass for all binary expressions.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 369 | fields = ('left', 'right') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 370 | operator = None |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 371 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 372 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 373 | def as_const(self, eval_ctx=None): |
| 374 | eval_ctx = get_eval_context(self, eval_ctx) |
| Armin Ronacher | a919538 | 2010-11-29 13:21:57 +0100 | [diff] [blame] | 375 | # intercepted operators cannot be folded at compile time |
| 376 | if self.environment.sandboxed and \ |
| 377 | self.operator in self.environment.intercepted_binops: |
| 378 | raise Impossible() |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 379 | f = _binop_to_func[self.operator] |
| 380 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 381 | return f(self.left.as_const(eval_ctx), self.right.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 382 | except Exception: |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 383 | raise Impossible() |
| 384 | |
| 385 | |
| 386 | class UnaryExpr(Expr): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 387 | """Baseclass for all unary expressions.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 388 | fields = ('node',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 389 | operator = None |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 390 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 391 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 392 | def as_const(self, eval_ctx=None): |
| 393 | eval_ctx = get_eval_context(self, eval_ctx) |
| Armin Ronacher | a919538 | 2010-11-29 13:21:57 +0100 | [diff] [blame] | 394 | # intercepted operators cannot be folded at compile time |
| 395 | if self.environment.sandboxed and \ |
| 396 | self.operator in self.environment.intercepted_unops: |
| 397 | raise Impossible() |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 398 | f = _uaop_to_func[self.operator] |
| 399 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 400 | return f(self.node.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 401 | except Exception: |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 402 | raise Impossible() |
| 403 | |
| 404 | |
| 405 | class Name(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 406 | """Looks up a name or stores a value in a name. |
| 407 | The `ctx` of the node can be one of the following values: |
| 408 | |
| 409 | - `store`: store a value in the name |
| 410 | - `load`: load that name |
| 411 | - `param`: like `store` but if the name was defined as function parameter. |
| 412 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 413 | fields = ('name', 'ctx') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 414 | |
| 415 | def can_assign(self): |
| Armin Ronacher | 9bb7e47 | 2008-05-28 11:26:59 +0200 | [diff] [blame] | 416 | return self.name not in ('true', 'false', 'none', |
| 417 | 'True', 'False', 'None') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 418 | |
| 419 | |
| 420 | class Literal(Expr): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 421 | """Baseclass for literals.""" |
| Armin Ronacher | 69e12db | 2008-05-12 09:00:03 +0200 | [diff] [blame] | 422 | abstract = True |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 423 | |
| 424 | |
| 425 | class Const(Literal): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 426 | """All constant values. The parser will return this node for simple |
| 427 | constants such as ``42`` or ``"foo"`` but it can be used to store more |
| 428 | complex values such as lists too. Only constants with a safe |
| 429 | representation (objects where ``eval(repr(x)) == x`` is true). |
| 430 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 431 | fields = ('value',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 432 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 433 | def as_const(self, eval_ctx=None): |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 434 | return self.value |
| 435 | |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 436 | @classmethod |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 437 | def from_untrusted(cls, value, lineno=None, environment=None): |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 438 | """Return a const object if the value is representable as |
| 439 | constant value in the generated code, otherwise it will raise |
| Armin Ronacher | 2e9396b | 2008-04-16 14:21:57 +0200 | [diff] [blame] | 440 | an `Impossible` exception. |
| 441 | """ |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 442 | from compiler import has_safe_repr |
| 443 | if not has_safe_repr(value): |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 444 | raise Impossible() |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 445 | return cls(value, lineno=lineno, environment=environment) |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 446 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 447 | |
| Armin Ronacher | 5411ce7 | 2008-05-25 11:36:22 +0200 | [diff] [blame] | 448 | class TemplateData(Literal): |
| 449 | """A constant template string.""" |
| 450 | fields = ('data',) |
| 451 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 452 | def as_const(self, eval_ctx=None): |
| Armin Ronacher | ffaa2e7 | 2010-05-29 20:57:16 +0200 | [diff] [blame] | 453 | eval_ctx = get_eval_context(self, eval_ctx) |
| 454 | if eval_ctx.volatile: |
| 455 | raise Impossible() |
| 456 | if eval_ctx.autoescape: |
| Armin Ronacher | 5411ce7 | 2008-05-25 11:36:22 +0200 | [diff] [blame] | 457 | return Markup(self.data) |
| 458 | return self.data |
| 459 | |
| 460 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 461 | class Tuple(Literal): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 462 | """For loop unpacking and some other things like multiple arguments |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 463 | for subscripts. Like for :class:`Name` `ctx` specifies if the tuple |
| 464 | is used for loading the names or storing. |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 465 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 466 | fields = ('items', 'ctx') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 467 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 468 | def as_const(self, eval_ctx=None): |
| 469 | eval_ctx = get_eval_context(self, eval_ctx) |
| 470 | return tuple(x.as_const(eval_ctx) for x in self.items) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 471 | |
| 472 | def can_assign(self): |
| 473 | for item in self.items: |
| 474 | if not item.can_assign(): |
| 475 | return False |
| 476 | return True |
| 477 | |
| 478 | |
| 479 | class List(Literal): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 480 | """Any list literal such as ``[1, 2, 3]``""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 481 | fields = ('items',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 482 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 483 | def as_const(self, eval_ctx=None): |
| 484 | eval_ctx = get_eval_context(self, eval_ctx) |
| 485 | return [x.as_const(eval_ctx) for x in self.items] |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 486 | |
| 487 | |
| 488 | class Dict(Literal): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 489 | """Any dict literal such as ``{1: 2, 3: 4}``. The items must be a list of |
| 490 | :class:`Pair` nodes. |
| 491 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 492 | fields = ('items',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 493 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 494 | def as_const(self, eval_ctx=None): |
| 495 | eval_ctx = get_eval_context(self, eval_ctx) |
| 496 | return dict(x.as_const(eval_ctx) for x in self.items) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 497 | |
| 498 | |
| 499 | class Pair(Helper): |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 500 | """A key, value pair for dicts.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 501 | fields = ('key', 'value') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 502 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 503 | def as_const(self, eval_ctx=None): |
| 504 | eval_ctx = get_eval_context(self, eval_ctx) |
| 505 | return self.key.as_const(eval_ctx), self.value.as_const(eval_ctx) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 506 | |
| 507 | |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 508 | class Keyword(Helper): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 509 | """A key, value pair for keyword arguments where key is a string.""" |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 510 | fields = ('key', 'value') |
| 511 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 512 | def as_const(self, eval_ctx=None): |
| 513 | eval_ctx = get_eval_context(self, eval_ctx) |
| 514 | return self.key, self.value.as_const(eval_ctx) |
| Armin Ronacher | 335b87a | 2008-09-21 17:08:48 +0200 | [diff] [blame] | 515 | |
| Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 516 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 517 | class CondExpr(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 518 | """A conditional expression (inline if expression). (``{{ |
| 519 | foo if bar else baz }}``) |
| 520 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 521 | fields = ('test', 'expr1', 'expr2') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 522 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 523 | def as_const(self, eval_ctx=None): |
| 524 | eval_ctx = get_eval_context(self, eval_ctx) |
| 525 | if self.test.as_const(eval_ctx): |
| 526 | return self.expr1.as_const(eval_ctx) |
| Armin Ronacher | 547d0b6 | 2008-07-04 16:35:10 +0200 | [diff] [blame] | 527 | |
| 528 | # if we evaluate to an undefined object, we better do that at runtime |
| 529 | if self.expr2 is None: |
| 530 | raise Impossible() |
| 531 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 532 | return self.expr2.as_const(eval_ctx) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 533 | |
| 534 | |
| 535 | class Filter(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 536 | """This node applies a filter on an expression. `name` is the name of |
| 537 | the filter, the rest of the fields are the same as for :class:`Call`. |
| Armin Ronacher | 105f0dc | 2008-05-23 16:12:47 +0200 | [diff] [blame] | 538 | |
| 539 | If the `node` of a filter is `None` the contents of the last buffer are |
| 540 | filtered. Buffers are created by macros and filter blocks. |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 541 | """ |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 542 | fields = ('node', 'name', 'args', 'kwargs', 'dyn_args', 'dyn_kwargs') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 543 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 544 | def as_const(self, eval_ctx=None): |
| 545 | eval_ctx = get_eval_context(self, eval_ctx) |
| 546 | if eval_ctx.volatile or self.node is None: |
| Armin Ronacher | fa865fb | 2008-04-12 22:11:53 +0200 | [diff] [blame] | 547 | raise Impossible() |
| Armin Ronacher | 0d242be | 2010-02-10 01:35:13 +0100 | [diff] [blame] | 548 | # we have to be careful here because we call filter_ below. |
| 549 | # if this variable would be called filter, 2to3 would wrap the |
| 550 | # call in a list beause it is assuming we are talking about the |
| 551 | # builtin filter function here which no longer returns a list in |
| 552 | # python 3. because of that, do not rename filter_ to filter! |
| 553 | filter_ = self.environment.filters.get(self.name) |
| 554 | if filter_ is None or getattr(filter_, 'contextfilter', False): |
| Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 555 | raise Impossible() |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 556 | obj = self.node.as_const(eval_ctx) |
| 557 | args = [x.as_const(eval_ctx) for x in self.args] |
| 558 | if getattr(filter_, 'evalcontextfilter', False): |
| 559 | args.insert(0, eval_ctx) |
| 560 | elif getattr(filter_, 'environmentfilter', False): |
| Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame] | 561 | args.insert(0, self.environment) |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 562 | kwargs = dict(x.as_const(eval_ctx) for x in self.kwargs) |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 563 | if self.dyn_args is not None: |
| 564 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 565 | args.extend(self.dyn_args.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 566 | except Exception: |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 567 | raise Impossible() |
| 568 | if self.dyn_kwargs is not None: |
| 569 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 570 | kwargs.update(self.dyn_kwargs.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 571 | except Exception: |
| Armin Ronacher | d55ab53 | 2008-04-09 16:13:39 +0200 | [diff] [blame] | 572 | raise Impossible() |
| 573 | try: |
| Armin Ronacher | 0d242be | 2010-02-10 01:35:13 +0100 | [diff] [blame] | 574 | return filter_(obj, *args, **kwargs) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 575 | except Exception: |
| Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 576 | raise Impossible() |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 577 | |
| 578 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 579 | class Test(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 580 | """Applies a test on an expression. `name` is the name of the test, the |
| 581 | rest of the fields are the same as for :class:`Call`. |
| 582 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 583 | fields = ('node', 'name', 'args', 'kwargs', 'dyn_args', 'dyn_kwargs') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 584 | |
| 585 | |
| 586 | class Call(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 587 | """Calls an expression. `args` is a list of arguments, `kwargs` a list |
| 588 | of keyword arguments (list of :class:`Keyword` nodes), and `dyn_args` |
| 589 | and `dyn_kwargs` has to be either `None` or a node that is used as |
| 590 | node for dynamic positional (``*args``) or keyword (``**kwargs``) |
| 591 | arguments. |
| 592 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 593 | fields = ('node', 'args', 'kwargs', 'dyn_args', 'dyn_kwargs') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 594 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 595 | def as_const(self, eval_ctx=None): |
| 596 | eval_ctx = get_eval_context(self, eval_ctx) |
| 597 | if eval_ctx.volatile: |
| 598 | raise Impossible() |
| 599 | obj = self.node.as_const(eval_ctx) |
| Armin Ronacher | 4f7d2d5 | 2008-04-22 10:40:26 +0200 | [diff] [blame] | 600 | |
| 601 | # don't evaluate context functions |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 602 | args = [x.as_const(eval_ctx) for x in self.args] |
| Armin Ronacher | 5a5ce73 | 2010-05-23 22:58:28 +0200 | [diff] [blame] | 603 | if isinstance(obj, _context_function_types): |
| 604 | if getattr(obj, 'contextfunction', False): |
| 605 | raise Impossible() |
| 606 | elif getattr(obj, 'evalcontextfunction', False): |
| 607 | args.insert(0, eval_ctx) |
| 608 | elif getattr(obj, 'environmentfunction', False): |
| 609 | args.insert(0, self.environment) |
| Armin Ronacher | 203bfcb | 2008-04-24 21:54:44 +0200 | [diff] [blame] | 610 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 611 | kwargs = dict(x.as_const(eval_ctx) for x in self.kwargs) |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 612 | if self.dyn_args is not None: |
| 613 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 614 | args.extend(self.dyn_args.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 615 | except Exception: |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 616 | raise Impossible() |
| 617 | if self.dyn_kwargs is not None: |
| 618 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 619 | kwargs.update(self.dyn_kwargs.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 620 | except Exception: |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 621 | raise Impossible() |
| 622 | try: |
| 623 | return obj(*args, **kwargs) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 624 | except Exception: |
| Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 625 | raise Impossible() |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 626 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 627 | |
| Armin Ronacher | 6dc6f29 | 2008-06-12 08:50:07 +0200 | [diff] [blame] | 628 | class Getitem(Expr): |
| Armin Ronacher | b938877 | 2008-06-25 20:43:18 +0200 | [diff] [blame] | 629 | """Get an attribute or item from an expression and prefer the item.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 630 | fields = ('node', 'arg', 'ctx') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 631 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 632 | def as_const(self, eval_ctx=None): |
| 633 | eval_ctx = get_eval_context(self, eval_ctx) |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 634 | if self.ctx != 'load': |
| 635 | raise Impossible() |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 636 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 637 | return self.environment.getitem(self.node.as_const(eval_ctx), |
| 638 | self.arg.as_const(eval_ctx)) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 639 | except Exception: |
| Armin Ronacher | 6dc6f29 | 2008-06-12 08:50:07 +0200 | [diff] [blame] | 640 | raise Impossible() |
| 641 | |
| 642 | def can_assign(self): |
| 643 | return False |
| 644 | |
| 645 | |
| 646 | class Getattr(Expr): |
| Armin Ronacher | b938877 | 2008-06-25 20:43:18 +0200 | [diff] [blame] | 647 | """Get an attribute or item from an expression that is a ascii-only |
| 648 | bytestring and prefer the attribute. |
| 649 | """ |
| Armin Ronacher | 6dc6f29 | 2008-06-12 08:50:07 +0200 | [diff] [blame] | 650 | fields = ('node', 'attr', 'ctx') |
| 651 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 652 | def as_const(self, eval_ctx=None): |
| Armin Ronacher | 6dc6f29 | 2008-06-12 08:50:07 +0200 | [diff] [blame] | 653 | if self.ctx != 'load': |
| 654 | raise Impossible() |
| 655 | try: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 656 | eval_ctx = get_eval_context(self, eval_ctx) |
| Georg Brandl | 93d2df7 | 2010-05-23 22:35:53 +0200 | [diff] [blame] | 657 | return self.environment.getattr(self.node.as_const(eval_ctx), |
| 658 | self.attr) |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 659 | except Exception: |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 660 | raise Impossible() |
| 661 | |
| 662 | def can_assign(self): |
| Armin Ronacher | 4f7d2d5 | 2008-04-22 10:40:26 +0200 | [diff] [blame] | 663 | return False |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 664 | |
| 665 | |
| 666 | class Slice(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 667 | """Represents a slice object. This must only be used as argument for |
| 668 | :class:`Subscript`. |
| 669 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 670 | fields = ('start', 'stop', 'step') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 671 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 672 | def as_const(self, eval_ctx=None): |
| 673 | eval_ctx = get_eval_context(self, eval_ctx) |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 674 | def const(obj): |
| 675 | if obj is None: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 676 | return None |
| 677 | return obj.as_const(eval_ctx) |
| Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame] | 678 | return slice(const(self.start), const(self.stop), const(self.step)) |
| 679 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 680 | |
| 681 | class Concat(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 682 | """Concatenates the list of expressions provided after converting them to |
| 683 | unicode. |
| 684 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 685 | fields = ('nodes',) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 686 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 687 | def as_const(self, eval_ctx=None): |
| 688 | eval_ctx = get_eval_context(self, eval_ctx) |
| 689 | return ''.join(unicode(x.as_const(eval_ctx)) for x in self.nodes) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 690 | |
| 691 | |
| 692 | class Compare(Expr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 693 | """Compares an expression with some other expressions. `ops` must be a |
| 694 | list of :class:`Operand`\s. |
| 695 | """ |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 696 | fields = ('expr', 'ops') |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 697 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 698 | def as_const(self, eval_ctx=None): |
| 699 | eval_ctx = get_eval_context(self, eval_ctx) |
| 700 | result = value = self.expr.as_const(eval_ctx) |
| Armin Ronacher | b5124e6 | 2008-04-25 00:36:14 +0200 | [diff] [blame] | 701 | try: |
| 702 | for op in self.ops: |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 703 | new_value = op.expr.as_const(eval_ctx) |
| Armin Ronacher | b5124e6 | 2008-04-25 00:36:14 +0200 | [diff] [blame] | 704 | result = _cmpop_to_func[op.op](value, new_value) |
| 705 | value = new_value |
| Ian Lewis | ab014bd | 2010-10-31 20:29:28 +0900 | [diff] [blame] | 706 | except Exception: |
| Armin Ronacher | b5124e6 | 2008-04-25 00:36:14 +0200 | [diff] [blame] | 707 | raise Impossible() |
| Armin Ronacher | 625215e | 2008-04-13 16:31:08 +0200 | [diff] [blame] | 708 | return result |
| 709 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 710 | |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 711 | class Operand(Helper): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 712 | """Holds an operator and an expression.""" |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 713 | fields = ('op', 'expr') |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 714 | |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 715 | if __debug__: |
| 716 | Operand.__doc__ += '\nThe following operators are available: ' + \ |
| 717 | ', '.join(sorted('``%s``' % x for x in set(_binop_to_func) | |
| 718 | set(_uaop_to_func) | set(_cmpop_to_func))) |
| 719 | |
| Armin Ronacher | 82b3f3d | 2008-03-31 20:01:08 +0200 | [diff] [blame] | 720 | |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 721 | class Mul(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 722 | """Multiplies the left with the right node.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 723 | operator = '*' |
| 724 | |
| 725 | |
| 726 | class Div(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 727 | """Divides the left by the right node.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 728 | operator = '/' |
| 729 | |
| 730 | |
| 731 | class FloorDiv(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 732 | """Divides the left by the right node and truncates conver the |
| 733 | result into an integer by truncating. |
| 734 | """ |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 735 | operator = '//' |
| 736 | |
| 737 | |
| 738 | class Add(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 739 | """Add the left to the right node.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 740 | operator = '+' |
| 741 | |
| 742 | |
| 743 | class Sub(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 744 | """Substract the right from the left node.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 745 | operator = '-' |
| 746 | |
| 747 | |
| 748 | class Mod(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 749 | """Left modulo right.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 750 | operator = '%' |
| 751 | |
| 752 | |
| 753 | class Pow(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 754 | """Left to the power of right.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 755 | operator = '**' |
| 756 | |
| 757 | |
| 758 | class And(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 759 | """Short circuited AND.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 760 | operator = 'and' |
| 761 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 762 | def as_const(self, eval_ctx=None): |
| 763 | eval_ctx = get_eval_context(self, eval_ctx) |
| 764 | return self.left.as_const(eval_ctx) and self.right.as_const(eval_ctx) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 765 | |
| 766 | |
| 767 | class Or(BinExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 768 | """Short circuited OR.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 769 | operator = 'or' |
| 770 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 771 | def as_const(self, eval_ctx=None): |
| 772 | eval_ctx = get_eval_context(self, eval_ctx) |
| 773 | return self.left.as_const(eval_ctx) or self.right.as_const(eval_ctx) |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 774 | |
| 775 | |
| 776 | class Not(UnaryExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 777 | """Negate the expression.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 778 | operator = 'not' |
| 779 | |
| 780 | |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 781 | class Neg(UnaryExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 782 | """Make the expression negative.""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 783 | operator = '-' |
| 784 | |
| 785 | |
| Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 786 | class Pos(UnaryExpr): |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 787 | """Make the expression positive (noop for most expressions)""" |
| Armin Ronacher | 07bc684 | 2008-03-31 14:18:49 +0200 | [diff] [blame] | 788 | operator = '+' |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 789 | |
| 790 | |
| 791 | # Helpers for extensions |
| 792 | |
| 793 | |
| 794 | class EnvironmentAttribute(Expr): |
| 795 | """Loads an attribute from the environment object. This is useful for |
| 796 | extensions that want to call a callback stored on the environment. |
| 797 | """ |
| 798 | fields = ('name',) |
| 799 | |
| 800 | |
| 801 | class ExtensionAttribute(Expr): |
| 802 | """Returns the attribute of an extension bound to the environment. |
| 803 | The identifier is the identifier of the :class:`Extension`. |
| Armin Ronacher | b9e7875 | 2008-05-10 23:36:28 +0200 | [diff] [blame] | 804 | |
| 805 | This node is usually constructed by calling the |
| 806 | :meth:`~jinja2.ext.Extension.attr` method on an extension. |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 807 | """ |
| Armin Ronacher | 6df604e | 2008-05-23 22:18:38 +0200 | [diff] [blame] | 808 | fields = ('identifier', 'name') |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 809 | |
| 810 | |
| 811 | class ImportedName(Expr): |
| 812 | """If created with an import name the import name is returned on node |
| 813 | access. For example ``ImportedName('cgi.escape')`` returns the `escape` |
| 814 | function from the cgi module on evaluation. Imports are optimized by the |
| 815 | compiler so there is no need to assign them to local variables. |
| 816 | """ |
| 817 | fields = ('importname',) |
| 818 | |
| 819 | |
| 820 | class InternalName(Expr): |
| 821 | """An internal name in the compiler. You cannot create these nodes |
| Armin Ronacher | 762079c | 2008-05-08 23:57:56 +0200 | [diff] [blame] | 822 | yourself but the parser provides a |
| 823 | :meth:`~jinja2.parser.Parser.free_identifier` method that creates |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 824 | a new identifier for you. This identifier is not available from the |
| 825 | template and is not threated specially by the compiler. |
| 826 | """ |
| 827 | fields = ('name',) |
| 828 | |
| 829 | def __init__(self): |
| 830 | raise TypeError('Can\'t create internal names. Use the ' |
| 831 | '`free_identifier` method on a parser.') |
| 832 | |
| 833 | |
| 834 | class MarkSafe(Expr): |
| 835 | """Mark the wrapped expression as safe (wrap it as `Markup`).""" |
| 836 | fields = ('expr',) |
| 837 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 838 | def as_const(self, eval_ctx=None): |
| 839 | eval_ctx = get_eval_context(self, eval_ctx) |
| 840 | return Markup(self.expr.as_const(eval_ctx)) |
| Armin Ronacher | 023b5e9 | 2008-05-08 11:03:10 +0200 | [diff] [blame] | 841 | |
| 842 | |
| Armin Ronacher | 4da9034 | 2010-05-29 17:35:10 +0200 | [diff] [blame] | 843 | class MarkSafeIfAutoescape(Expr): |
| 844 | """Mark the wrapped expression as safe (wrap it as `Markup`) but |
| 845 | only if autoescaping is active. |
| 846 | |
| 847 | .. versionadded:: 2.5 |
| 848 | """ |
| 849 | fields = ('expr',) |
| 850 | |
| 851 | def as_const(self, eval_ctx=None): |
| 852 | eval_ctx = get_eval_context(self, eval_ctx) |
| Armin Ronacher | ffaa2e7 | 2010-05-29 20:57:16 +0200 | [diff] [blame] | 853 | if eval_ctx.volatile: |
| 854 | raise Impossible() |
| Armin Ronacher | 4da9034 | 2010-05-29 17:35:10 +0200 | [diff] [blame] | 855 | expr = self.expr.as_const(eval_ctx) |
| 856 | if eval_ctx.autoescape: |
| 857 | return Markup(expr) |
| 858 | return expr |
| 859 | |
| 860 | |
| Armin Ronacher | 6df604e | 2008-05-23 22:18:38 +0200 | [diff] [blame] | 861 | class ContextReference(Expr): |
| Armin Ronacher | cedb482 | 2010-03-24 10:53:22 +0100 | [diff] [blame] | 862 | """Returns the current template context. It can be used like a |
| 863 | :class:`Name` node, with a ``'load'`` ctx and will return the |
| 864 | current :class:`~jinja2.runtime.Context` object. |
| 865 | |
| 866 | Here an example that assigns the current template name to a |
| 867 | variable named `foo`:: |
| 868 | |
| 869 | Assign(Name('foo', ctx='store'), |
| 870 | Getattr(ContextReference(), 'name')) |
| 871 | """ |
| Armin Ronacher | 6df604e | 2008-05-23 22:18:38 +0200 | [diff] [blame] | 872 | |
| 873 | |
| Armin Ronacher | ed1e0d4 | 2008-05-18 20:25:28 +0200 | [diff] [blame] | 874 | class Continue(Stmt): |
| 875 | """Continue a loop.""" |
| 876 | |
| 877 | |
| 878 | class Break(Stmt): |
| 879 | """Break a loop.""" |
| 880 | |
| 881 | |
| Armin Ronacher | 271a0eb | 2009-02-11 22:49:08 +0100 | [diff] [blame] | 882 | class Scope(Stmt): |
| 883 | """An artificial scope.""" |
| 884 | fields = ('body',) |
| 885 | |
| 886 | |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 887 | class EvalContextModifier(Stmt): |
| Armin Ronacher | 30fda27 | 2010-03-15 03:06:04 +0100 | [diff] [blame] | 888 | """Modifies the eval context. For each option that should be modified, |
| 889 | a :class:`Keyword` has to be added to the :attr:`options` list. |
| 890 | |
| 891 | Example to change the `autoescape` setting:: |
| 892 | |
| 893 | EvalContextModifier(options=[Keyword('autoescape', Const(True))]) |
| 894 | """ |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 895 | fields = ('options',) |
| 896 | |
| 897 | |
| 898 | class ScopedEvalContextModifier(EvalContextModifier): |
| Armin Ronacher | 30fda27 | 2010-03-15 03:06:04 +0100 | [diff] [blame] | 899 | """Modifies the eval context and reverts it later. Works exactly like |
| 900 | :class:`EvalContextModifier` but will only modify the |
| Armin Ronacher | 0dbaf39 | 2010-03-15 10:06:53 +0100 | [diff] [blame] | 901 | :class:`~jinja2.nodes.EvalContext` for nodes in the :attr:`body`. |
| Armin Ronacher | 30fda27 | 2010-03-15 03:06:04 +0100 | [diff] [blame] | 902 | """ |
| Armin Ronacher | 8346bd7 | 2010-03-14 19:43:47 +0100 | [diff] [blame] | 903 | fields = ('body',) |
| 904 | |
| 905 | |
| Armin Ronacher | 8a1d27f | 2008-05-19 08:37:19 +0200 | [diff] [blame] | 906 | # make sure nobody creates custom nodes |
| 907 | def _failing_new(*args, **kwargs): |
| 908 | raise TypeError('can\'t create custom node types') |
| 909 | NodeType.__new__ = staticmethod(_failing_new); del _failing_new |