Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | """ |
| 3 | jinja2.runtime |
| 4 | ~~~~~~~~~~~~~~ |
| 5 | |
| 6 | Runtime helpers. |
| 7 | |
| 8 | :copyright: Copyright 2008 by Armin Ronacher. |
| 9 | :license: GNU GPL. |
| 10 | """ |
| 11 | try: |
| 12 | from collections import defaultdict |
| 13 | except ImportError: |
| 14 | defaultdict = None |
| 15 | |
| 16 | |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 17 | __all__ = ['extends', 'subscribe', 'LoopContext', 'StaticLoopContext', |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 18 | 'TemplateContext', 'Macro', 'Undefined'] |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 19 | |
| 20 | |
| 21 | def extends(template, namespace): |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 22 | """This loads a template (and evaluates it) and replaces the blocks.""" |
| 23 | |
| 24 | |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 25 | def subscribe(obj, argument): |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 26 | """Get an item or attribute of an object.""" |
| 27 | try: |
Armin Ronacher | 81b8817 | 2008-04-09 00:40:05 +0200 | [diff] [blame] | 28 | return getattr(obj, str(argument)) |
| 29 | except (AttributeError, UnicodeError): |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 30 | try: |
| 31 | return obj[argument] |
| 32 | except LookupError: |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 33 | return Undefined(obj, argument) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 34 | |
| 35 | |
| 36 | class TemplateContext(dict): |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 37 | """ |
| 38 | Holds the variables of the local template or of the global one. It's |
| 39 | not save to use this class outside of the compiled code. For example |
| 40 | update and other methods will not work as they seem (they don't update |
| 41 | the exported variables for example). |
| 42 | """ |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 43 | |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 44 | def __init__(self, globals, filename): |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 45 | dict.__init__(self, globals) |
| 46 | self.exported = set() |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 47 | self.filename = filename |
Armin Ronacher | 8efc522 | 2008-04-08 14:47:40 +0200 | [diff] [blame] | 48 | self.filters = {} |
| 49 | self.tests = {} |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 50 | |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 51 | def __setitem__(self, key, value): |
| 52 | """If we set items to the dict we track the variables set so |
| 53 | that includes can access the exported variables.""" |
| 54 | dict.__setitem__(self, key, value) |
| 55 | self.exported.add(key) |
| 56 | |
| 57 | def __delitem__(self, key): |
| 58 | """On delete we no longer export it.""" |
| 59 | dict.__delitem__(self, key) |
| 60 | self.exported.dicard(key) |
| 61 | |
| 62 | def get_exported(self): |
| 63 | """Get a dict of all exported variables.""" |
| 64 | return dict((k, self[k]) for k in self.exported) |
| 65 | |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 66 | # if there is a default dict, dict has a __missing__ method we can use. |
| 67 | if defaultdict is None: |
| 68 | def __getitem__(self, name): |
| 69 | if name in self: |
| 70 | return self[name] |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 71 | return Undefined(name) |
Armin Ronacher | e791c2a | 2008-04-07 18:39:54 +0200 | [diff] [blame] | 72 | else: |
| 73 | def __missing__(self, key): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 74 | return Undefined(key) |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 75 | |
| 76 | |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 77 | class LoopContextBase(object): |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 78 | """Helper for extended iteration.""" |
| 79 | |
| 80 | def __init__(self, iterable, parent=None): |
| 81 | self._iterable = iterable |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 82 | self._length = None |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 83 | self.index0 = 0 |
| 84 | self.parent = parent |
| 85 | |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 86 | first = property(lambda x: x.index0 == 0) |
| 87 | last = property(lambda x: x.revindex0 == 0) |
| 88 | index = property(lambda x: x.index0 + 1) |
| 89 | revindex = property(lambda x: x.length) |
| 90 | revindex0 = property(lambda x: x.length - 1) |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 91 | length = property(lambda x: len(x)) |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 92 | |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 93 | |
| 94 | class LoopContext(LoopContextBase): |
| 95 | |
| 96 | def __init__(self, iterable, parent=None, enforce_length=False): |
| 97 | self._iterable = iterable |
| 98 | self._length = None |
| 99 | self.index0 = 0 |
| 100 | self.parent = parent |
| 101 | if enforce_length: |
| 102 | len(self) |
| 103 | |
| 104 | def make_static(self): |
| 105 | """Return a static loop context for the optimizer.""" |
| 106 | parent = None |
| 107 | if self.parent is not None: |
| 108 | parent = self.parent.make_static() |
| 109 | return StaticLoopContext(self.index0, self.length, parent) |
| 110 | |
| 111 | def __iter__(self): |
| 112 | for item in self._iterable: |
| 113 | yield self, item |
| 114 | self.index0 += 1 |
| 115 | |
| 116 | def __len__(self): |
| 117 | if self._length is None: |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 118 | try: |
| 119 | length = len(self._iterable) |
| 120 | except TypeError: |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 121 | self._iterable = tuple(self._iterable) |
| 122 | length = self.index0 + len(tuple(self._iterable)) |
Armin Ronacher | 180a1bd | 2008-04-09 12:14:24 +0200 | [diff] [blame] | 123 | self._length = length |
| 124 | return self._length |
| 125 | |
| 126 | |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 127 | class StaticLoopContext(LoopContextBase): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 128 | """The static loop context is used in the optimizer to "freeze" the |
| 129 | status of an iteration. The only reason for this object is if the |
| 130 | loop object is accessed in a non static way (eg: becomes part of a |
| 131 | function call).""" |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 132 | |
| 133 | def __init__(self, index0, length, parent): |
| 134 | self.index0 = index0 |
| 135 | self.parent = parent |
| 136 | self._length = length |
| 137 | |
| 138 | def __repr__(self): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 139 | """The repr is used by the optimizer to dump the object.""" |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 140 | return 'StaticLoopContext(%r, %r, %r)' % ( |
| 141 | self.index0, |
| 142 | self._length, |
| 143 | self.parent |
| 144 | ) |
| 145 | |
| 146 | def make_static(self): |
| 147 | return self |
| 148 | |
| 149 | |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 150 | class Macro(object): |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 151 | """ |
| 152 | Wraps a macor |
| 153 | """ |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 154 | |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 155 | def __init__(self, func, name, arguments, defaults, catch_all): |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 156 | self.func = func |
| 157 | self.name = name |
| 158 | self.arguments = arguments |
| 159 | self.defaults = defaults |
| 160 | self.catch_all = catch_all |
| 161 | |
| 162 | def __call__(self, *args, **kwargs): |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 163 | arg_count = len(self.arguments) |
| 164 | if len(args) > arg_count: |
Armin Ronacher | 4f62a9f | 2008-04-08 18:09:13 +0200 | [diff] [blame] | 165 | raise TypeError('macro %r takes not more than %d argument(s).' % |
| 166 | (self.name, len(self.arguments))) |
| 167 | arguments = {} |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 168 | for idx, name in enumerate(self.arguments): |
| 169 | try: |
| 170 | value = args[idx] |
| 171 | except IndexError: |
| 172 | try: |
| 173 | value = kwargs.pop(name) |
| 174 | except KeyError: |
| 175 | try: |
| 176 | value = self.defaults[idx - arg_count] |
| 177 | except IndexError: |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 178 | value = Undefined(name) |
Armin Ronacher | 9706fab | 2008-04-08 18:49:56 +0200 | [diff] [blame] | 179 | arguments['l_' + name] = arg |
| 180 | if self.catch_all: |
| 181 | arguments['l_arguments'] = kwargs |
| 182 | return u''.join(self.func(**arguments)) |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 183 | |
| 184 | |
| 185 | class Undefined(object): |
Armin Ronacher | 4dfc975 | 2008-04-09 15:03:29 +0200 | [diff] [blame^] | 186 | """The object for undefined values.""" |
Armin Ronacher | d1d2f3d | 2008-04-09 14:02:55 +0200 | [diff] [blame] | 187 | |
| 188 | def __init__(self, name=None, attr=None): |
| 189 | if attr is None: |
| 190 | self._undefined_hint = '%r is undefined' % attr |
| 191 | elif name is None: |
| 192 | self._undefined_hint = 'attribute %r is undefined' % name |
| 193 | else: |
| 194 | self._undefined_hint = 'attribute %r of %r is undefined' \ |
| 195 | % (attr, name) |
| 196 | |
| 197 | def fail(self, *args, **kwargs): |
| 198 | raise TypeError(self._undefined_hint) |
| 199 | __getattr__ = __getitem__ = __add__ = __mul__ = __div__ = \ |
| 200 | __realdiv__ = __floordiv__ = __mod__ = __pos__ = __neg__ = fail |
| 201 | del fail |
| 202 | |
| 203 | def __unicode__(self): |
| 204 | return '' |
| 205 | |
| 206 | def __repr__(self): |
| 207 | return 'Undefined' |
| 208 | |
| 209 | def __len__(self): |
| 210 | return 0 |
| 211 | |
| 212 | def __iter__(self): |
| 213 | if 0: |
| 214 | yield None |