Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | """ |
| 3 | jinja.filters |
| 4 | ~~~~~~~~~~~~~ |
| 5 | |
| 6 | Bundled jinja filters. |
| 7 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 8 | :copyright: 2008 by Armin Ronacher, Christoph Hack. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 9 | :license: BSD, see LICENSE for more details. |
| 10 | """ |
Georg Brandl | af31e4d | 2007-04-15 00:47:37 +0200 | [diff] [blame] | 11 | import re |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 12 | import math |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 13 | from random import choice |
Armin Ronacher | 1dcdac5 | 2007-12-09 22:53:46 +0100 | [diff] [blame] | 14 | try: |
| 15 | from operator import itemgetter |
| 16 | except ImportError: |
| 17 | itemgetter = lambda a: lambda b: b[a] |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 18 | from urllib import urlencode, quote |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 19 | from itertools import imap |
| 20 | from jinja2.utils import Markup, escape, pformat, urlize, soft_unicode |
Christoph Hack | 8090986 | 2008-04-14 01:35:10 +0200 | [diff] [blame] | 21 | from jinja2.runtime import Undefined |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 22 | |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 23 | |
| 24 | |
Armin Ronacher | eaf493e | 2007-10-01 22:31:16 +0200 | [diff] [blame] | 25 | _striptags_re = re.compile(r'(<!--.*?-->|<[^>]*>)') |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 26 | |
| 27 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 28 | def contextfilter(f): |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 29 | """Decorator for marking context dependent filters. The current context |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 30 | argument will be passed as first argument. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 31 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 32 | if getattr(f, 'environmentfilter', False): |
| 33 | raise TypeError('filter already marked as environment filter') |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 34 | f.contextfilter = True |
| 35 | return f |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 36 | |
| 37 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 38 | def environmentfilter(f): |
| 39 | """Decorator for marking evironment dependent filters. The environment |
| 40 | used for the template is passed to the filter as first argument. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 41 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 42 | if getattr(f, 'contextfilter', False): |
| 43 | raise TypeError('filter already marked as context filter') |
| 44 | f.environmentfilter = True |
| 45 | return f |
| 46 | |
| 47 | |
| 48 | def do_replace(s, old, new, count=None): |
| 49 | """Return a copy of the value with all occurrences of a substring |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 50 | replaced with a new one. The first argument is the substring |
| 51 | that should be replaced, the second is the replacement string. |
| 52 | If the optional third argument ``count`` is given, only the first |
| 53 | ``count`` occurrences are replaced: |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 54 | |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 55 | .. sourcecode:: jinja |
| 56 | |
| 57 | {{ "Hello World"|replace("Hello", "Goodbye") }} |
| 58 | -> Goodbye World |
| 59 | |
| 60 | {{ "aaaaargh"|replace("a", "d'oh, ", 2) }} |
| 61 | -> d'oh, d'oh, aaargh |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 62 | """ |
Armin Ronacher | 2da479f | 2007-04-02 10:50:18 +0200 | [diff] [blame] | 63 | if count is None: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 64 | count = -1 |
| 65 | if hasattr(old, '__html__') or hasattr(new, '__html__') and \ |
| 66 | not hasattr(s, '__html__'): |
| 67 | s = escape(s) |
| 68 | else: |
| 69 | s = soft_unicode(s) |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 70 | return s.replace(old, new, count) |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 71 | |
| 72 | |
| 73 | def do_upper(s): |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 74 | """Convert a value to uppercase.""" |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 75 | return soft_unicode(s).upper() |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 76 | |
| 77 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 78 | def do_lower(s): |
Armin Ronacher | 8edbe49 | 2008-04-10 20:43:43 +0200 | [diff] [blame] | 79 | """Convert a value to lowercase.""" |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 80 | return soft_unicode(s).lower() |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 81 | |
| 82 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 83 | def do_escape(s): |
| 84 | """XML escape ``&``, ``<``, ``>``, and ``"`` in a string of data. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 85 | |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 86 | This method will have no effect it the value is already escaped. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 87 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 88 | return escape(s) |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 89 | |
| 90 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 91 | def do_xmlattr(d, autospace=False): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 92 | """Create an SGML/XML attribute string based on the items in a dict. |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 93 | All values that are neither `none` nor `undefined` are automatically |
| 94 | escaped: |
| 95 | |
Armin Ronacher | 8ca55df | 2007-04-15 15:16:08 +0200 | [diff] [blame] | 96 | .. sourcecode:: html+jinja |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 97 | |
Armin Ronacher | c7ddd1d | 2007-04-28 15:56:27 +0200 | [diff] [blame] | 98 | <ul{{ {'class': 'my_list', 'missing': None, |
Armin Ronacher | d459e27 | 2007-04-15 15:31:05 +0200 | [diff] [blame] | 99 | 'id': 'list-%d'|format(variable)}|xmlattr }}> |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 100 | ... |
| 101 | </ul> |
| 102 | |
| 103 | Results in something like this: |
| 104 | |
Armin Ronacher | 8ca55df | 2007-04-15 15:16:08 +0200 | [diff] [blame] | 105 | .. sourcecode:: html |
| 106 | |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 107 | <ul class="my_list" id="list-42"> |
| 108 | ... |
| 109 | </ul> |
| 110 | |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 111 | As you can see it automatically prepends a space in front of the item |
Armin Ronacher | c7ddd1d | 2007-04-28 15:56:27 +0200 | [diff] [blame] | 112 | if the filter returned something. You can disable this by passing |
| 113 | `false` as only argument to the filter. |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 114 | """ |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 115 | if not hasattr(d, 'iteritems'): |
| 116 | raise TypeError('a dict is required') |
| 117 | result = [] |
| 118 | for key, value in d.iteritems(): |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 119 | if value is not None and not isinstance(value, Undefined): |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 120 | result.append(u'%s="%s"' % ( |
| 121 | escape(env.to_unicode(key)), |
| 122 | escape(env.to_unicode(value), True) |
| 123 | )) |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 124 | rv = u' '.join( |
| 125 | u'%s="%s"' % (escape(key), escape(value)) |
| 126 | for key, value in d.iteritems() |
| 127 | if value is not None and not isinstance(value, Undefined) |
| 128 | ) |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 129 | if autospace: |
| 130 | rv = ' ' + rv |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 131 | return Markup(rv) |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 132 | |
| 133 | |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 134 | def do_capitalize(s): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 135 | """Capitalize a value. The first character will be uppercase, all others |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 136 | lowercase. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 137 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 138 | return soft_unicode(s).capitalize() |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 139 | |
| 140 | |
| 141 | def do_title(s): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 142 | """Return a titlecased version of the value. I.e. words will start with |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 143 | uppercase letters, all remaining characters are lowercase. |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 144 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 145 | return soft_unicode(s).title() |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 146 | |
| 147 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 148 | def do_dictsort(value, case_sensitive=False, by='key'): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 149 | """ Sort a dict and yield (key, value) pairs. Because python dicts are |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 150 | unsorted you may want to use this function to order them by either |
| 151 | key or value: |
| 152 | |
| 153 | .. sourcecode:: jinja |
| 154 | |
| 155 | {% for item in mydict|dictsort %} |
| 156 | sort the dict by key, case insensitive |
| 157 | |
| 158 | {% for item in mydict|dicsort(true) %} |
| 159 | sort the dict by key, case sensitive |
| 160 | |
| 161 | {% for item in mydict|dictsort(false, 'value') %} |
| 162 | sort the dict by key, case insensitive, sorted |
| 163 | normally and ordered by value. |
| 164 | """ |
| 165 | if by == 'key': |
| 166 | pos = 0 |
| 167 | elif by == 'value': |
| 168 | pos = 1 |
| 169 | else: |
| 170 | raise FilterArgumentError('You can only sort by either ' |
| 171 | '"key" or "value"') |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 172 | def sort_func(item): |
| 173 | value = item[pos] |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 174 | if isinstance(value, basestring): |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 175 | value = unicode(value) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 176 | if not case_sensitive: |
| 177 | value = value.lower() |
| 178 | return value |
| 179 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 180 | return sorted(value.items(), key=sort_func) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 181 | |
| 182 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 183 | def do_default(value, default_value=u'', boolean=False): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 184 | """If the value is undefined it will return the passed default value, |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 185 | otherwise the value of the variable: |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 186 | |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 187 | .. sourcecode:: jinja |
| 188 | |
| 189 | {{ my_variable|default('my_variable is not defined') }} |
| 190 | |
| 191 | This will output the value of ``my_variable`` if the variable was |
| 192 | defined, otherwise ``'my_variable is not defined'``. If you want |
| 193 | to use default with variables that evaluate to false you have to |
| 194 | set the second parameter to `true`: |
| 195 | |
| 196 | .. sourcecode:: jinja |
| 197 | |
| 198 | {{ ''|default('the string was empty', true) }} |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 199 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 200 | if (boolean and not value) or isinstance(value, Undefined): |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 201 | return default_value |
| 202 | return value |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 203 | |
| 204 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 205 | def do_join(value, d=u''): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 206 | """Return a string which is the concatenation of the strings in the |
Armin Ronacher | 37a8851 | 2007-03-02 20:42:18 +0100 | [diff] [blame] | 207 | sequence. The separator between elements is an empty string per |
| 208 | default, you can define ith with the optional parameter: |
| 209 | |
| 210 | .. sourcecode:: jinja |
| 211 | |
| 212 | {{ [1, 2, 3]|join('|') }} |
| 213 | -> 1|2|3 |
| 214 | |
| 215 | {{ [1, 2, 3]|join }} |
| 216 | -> 123 |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 217 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 218 | # if the delimiter doesn't have an html representation we check |
| 219 | # if any of the items has. If yes we do a coercion to Markup |
| 220 | if not hasttr(d, '__html__'): |
| 221 | value = list(value) |
| 222 | do_escape = False |
| 223 | for idx, item in enumerate(value): |
| 224 | if hasattr(item, '__html__'): |
| 225 | do_escape = True |
| 226 | else: |
| 227 | value[idx] = unicode(item) |
| 228 | if do_escape: |
| 229 | d = escape(d) |
| 230 | else: |
| 231 | d = unicode(d) |
| 232 | return d.join(value) |
| 233 | |
| 234 | # no html involved, to normal joining |
| 235 | return soft_unicode(d).join(imap(soft_unicode, value)) |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 236 | |
| 237 | |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 238 | def do_center(value, width=80): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 239 | """Centers the value in a field of a given width.""" |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 240 | return unicode(value).center(width) |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 241 | |
| 242 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 243 | @environmentfilter |
| 244 | def do_first(environment, seq): |
| 245 | """Return the frist item of a sequence.""" |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 246 | try: |
| 247 | return iter(seq).next() |
| 248 | except StopIteration: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 249 | return environment.undefined('seq|first', |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 250 | extra='the sequence was empty') |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 251 | |
| 252 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 253 | @environmentfilter |
| 254 | def do_last(environment, seq): |
| 255 | """Return the last item of a sequence.""" |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 256 | try: |
| 257 | return iter(reversed(seq)).next() |
| 258 | except StopIteration: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 259 | return environment.undefined('seq|last', |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 260 | extra='the sequence was empty') |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 261 | |
| 262 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 263 | @environmentfilter |
| 264 | def do_random(environment, seq): |
| 265 | """Return a random item from the sequence.""" |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 266 | try: |
| 267 | return choice(seq) |
| 268 | except IndexError: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 269 | return environment.undefined('seq|random', |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 270 | extra='the sequence was empty') |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 271 | |
| 272 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 273 | def do_filesizeformat(value): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 274 | """Format the value like a 'human-readable' file size (i.e. 13 KB, |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 275 | 4.1 MB, 102 bytes, etc). |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 276 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 277 | # fail silently |
| 278 | try: |
| 279 | bytes = float(value) |
| 280 | except TypeError: |
| 281 | bytes = 0 |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 282 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 283 | if bytes < 1024: |
| 284 | return "%d Byte%s" % (bytes, bytes != 1 and 's' or '') |
| 285 | elif bytes < 1024 * 1024: |
| 286 | return "%.1f KB" % (bytes / 1024) |
| 287 | elif bytes < 1024 * 1024 * 1024: |
| 288 | return "%.1f MB" % (bytes / (1024 * 1024)) |
| 289 | return "%.1f GB" % (bytes / (1024 * 1024 * 1024)) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 290 | |
| 291 | |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 292 | def do_pprint(value, verbose=False): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 293 | """Pretty print a variable. Useful for debugging. |
Armin Ronacher | f2ce126 | 2007-10-21 21:51:51 +0200 | [diff] [blame] | 294 | |
| 295 | With Jinja 1.2 onwards you can pass it a parameter. If this parameter |
Armin Ronacher | 5f3f136 | 2007-10-21 22:15:04 +0200 | [diff] [blame] | 296 | is truthy the output will be more verbose (this requires `pretty`) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 297 | """ |
Christoph Hack | 2751d94 | 2008-04-09 12:14:55 +0200 | [diff] [blame] | 298 | return pformat(value, verbose=verbose) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 299 | |
| 300 | |
| 301 | def do_urlize(value, trim_url_limit=None, nofollow=False): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 302 | """Converts URLs in plain text into clickable links. |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 303 | |
| 304 | If you pass the filter an additional integer it will shorten the urls |
| 305 | to that number. Also a third argument exists that makes the urls |
| 306 | "nofollow": |
| 307 | |
| 308 | .. sourcecode:: jinja |
| 309 | |
| 310 | {{ mytext|urlize(40, True) }} |
| 311 | links are shortened to 40 chars and defined with rel="nofollow" |
| 312 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 313 | return urlize(soft_unicode(value), trim_url_limit, nofollow) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 314 | |
| 315 | |
| 316 | def do_indent(s, width=4, indentfirst=False): |
| 317 | """ |
| 318 | {{ s|indent[ width[ indentfirst[ usetab]]] }} |
| 319 | |
| 320 | Return a copy of the passed string, each line indented by |
| 321 | 4 spaces. The first line is not indented. If you want to |
| 322 | change the number of spaces or indent the first line too |
| 323 | you can pass additional parameters to the filter: |
| 324 | |
| 325 | .. sourcecode:: jinja |
| 326 | |
| 327 | {{ mytext|indent(2, True) }} |
| 328 | indent by two spaces and indent the first line too. |
| 329 | """ |
| 330 | indention = ' ' * width |
| 331 | if indentfirst: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 332 | return u'\n'.join(indention + line for line in s.splitlines()) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 333 | return s.replace('\n', '\n' + indention) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 334 | |
| 335 | |
| 336 | def do_truncate(s, length=255, killwords=False, end='...'): |
| 337 | """ |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 338 | Return a truncated copy of the string. The length is specified |
| 339 | with the first parameter which defaults to ``255``. If the second |
| 340 | parameter is ``true`` the filter will cut the text at length. Otherwise |
| 341 | it will try to save the last word. If the text was in fact |
| 342 | truncated it will append an ellipsis sign (``"..."``). If you want a |
| 343 | different ellipsis sign than ``"..."`` you can specify it using the |
| 344 | third parameter. |
| 345 | |
| 346 | .. sourcecode jinja:: |
| 347 | |
| 348 | {{ mytext|truncate(300, false, '»') }} |
| 349 | truncate mytext to 300 chars, don't split up words, use a |
| 350 | right pointing double arrow as ellipsis sign. |
| 351 | """ |
| 352 | if len(s) <= length: |
| 353 | return s |
| 354 | elif killwords: |
| 355 | return s[:length] + end |
| 356 | words = s.split(' ') |
| 357 | result = [] |
| 358 | m = 0 |
| 359 | for word in words: |
| 360 | m += len(word) + 1 |
| 361 | if m > length: |
| 362 | break |
| 363 | result.append(word) |
| 364 | result.append(end) |
| 365 | return u' '.join(result) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 366 | |
| 367 | |
| 368 | def do_wordwrap(s, pos=79, hard=False): |
| 369 | """ |
| 370 | Return a copy of the string passed to the filter wrapped after |
| 371 | ``79`` characters. You can override this default using the first |
| 372 | parameter. If you set the second parameter to `true` Jinja will |
| 373 | also split words apart (usually a bad idea because it makes |
| 374 | reading hard). |
| 375 | """ |
| 376 | if len(s) < pos: |
| 377 | return s |
| 378 | if hard: |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 379 | return u'\n'.join(s[idx:idx + pos] for idx in |
| 380 | xrange(0, len(s), pos)) |
| 381 | |
| 382 | # TODO: switch to wordwrap.wrap |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 383 | # code from http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/148061 |
| 384 | return reduce(lambda line, word, pos=pos: u'%s%s%s' % |
| 385 | (line, u' \n'[(len(line)-line.rfind('\n') - 1 + |
| 386 | len(word.split('\n', 1)[0]) >= pos)], |
| 387 | word), s.split(' ')) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 388 | |
| 389 | |
| 390 | def do_wordcount(s): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 391 | """Count the words in that string.""" |
| 392 | return len(x for x in s.split() if x) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 393 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 394 | |
| 395 | def do_int(value, default=0): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 396 | """Convert the value into an integer. If the |
Armin Ronacher | ab45b84 | 2007-03-18 20:47:50 +0100 | [diff] [blame] | 397 | conversion doesn't work it will return ``0``. You can |
| 398 | override this default using the first parameter. |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 399 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 400 | try: |
| 401 | return int(value) |
| 402 | except (TypeError, ValueError): |
Armin Ronacher | ab45b84 | 2007-03-18 20:47:50 +0100 | [diff] [blame] | 403 | try: |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 404 | return int(float(value)) |
Armin Ronacher | ab45b84 | 2007-03-18 20:47:50 +0100 | [diff] [blame] | 405 | except (TypeError, ValueError): |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 406 | return default |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 407 | |
| 408 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 409 | def do_float(value, default=0.0): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 410 | """Convert the value into a floating point number. If the |
Armin Ronacher | ab45b84 | 2007-03-18 20:47:50 +0100 | [diff] [blame] | 411 | conversion doesn't work it will return ``0.0``. You can |
| 412 | override this default using the first parameter. |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 413 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 414 | try: |
| 415 | return float(value) |
| 416 | except (TypeError, ValueError): |
| 417 | return default |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 418 | |
| 419 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 420 | def do_string(value): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 421 | """Convert the value into an string.""" |
| 422 | return soft_unicode(value) |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 423 | |
| 424 | |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 425 | def do_format(value, *args, **kwargs): |
Armin Ronacher | f0f4deb | 2007-03-18 23:10:15 +0100 | [diff] [blame] | 426 | """ |
| 427 | Apply python string formatting on an object: |
| 428 | |
| 429 | .. sourcecode:: jinja |
| 430 | |
| 431 | {{ "%s - %s"|format("Hello?", "Foo!") }} |
| 432 | -> Hello? - Foo! |
Armin Ronacher | f0f4deb | 2007-03-18 23:10:15 +0100 | [diff] [blame] | 433 | """ |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 434 | if kwargs: |
| 435 | kwargs.update(idx, arg in enumerate(args)) |
| 436 | args = kwargs |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 437 | return soft_unicode(value) % args |
Armin Ronacher | f0f4deb | 2007-03-18 23:10:15 +0100 | [diff] [blame] | 438 | |
| 439 | |
Armin Ronacher | 566295e | 2007-03-19 13:19:34 +0100 | [diff] [blame] | 440 | def do_trim(value): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 441 | """Strip leading and trailing whitespace.""" |
| 442 | return soft_unicode(value).strip() |
Armin Ronacher | 566295e | 2007-03-19 13:19:34 +0100 | [diff] [blame] | 443 | |
| 444 | |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 445 | def do_striptags(value): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 446 | """Strip SGML/XML tags and replace adjacent whitespace by one space. |
Georg Brandl | af31e4d | 2007-04-15 00:47:37 +0200 | [diff] [blame] | 447 | """ |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 448 | return ' '.join(_striptags_re.sub('', value).split()) |
Georg Brandl | af31e4d | 2007-04-15 00:47:37 +0200 | [diff] [blame] | 449 | |
| 450 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 451 | def do_slice(value, slices, fill_with=None): |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 452 | """Slice an iterator and return a list of lists containing |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 453 | those items. Useful if you want to create a div containing |
| 454 | three div tags that represent columns: |
| 455 | |
Armin Ronacher | 8937607 | 2007-04-13 22:34:35 +0200 | [diff] [blame] | 456 | .. sourcecode:: html+jinja |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 457 | |
| 458 | <div class="columwrapper"> |
| 459 | {%- for column in items|slice(3) %} |
| 460 | <ul class="column-{{ loop.index }}"> |
| 461 | {%- for item in column %} |
| 462 | <li>{{ item }}</li> |
| 463 | {%- endfor %} |
| 464 | </ul> |
| 465 | {%- endfor %} |
| 466 | </div> |
| 467 | |
Armin Ronacher | eec3138 | 2007-04-14 14:50:45 +0200 | [diff] [blame] | 468 | If you pass it a second argument it's used to fill missing |
| 469 | values on the last iteration. |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 470 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 471 | result = [] |
| 472 | seq = list(value) |
| 473 | length = len(seq) |
| 474 | items_per_slice = length // slices |
| 475 | slices_with_extra = length % slices |
| 476 | offset = 0 |
| 477 | for slice_number in xrange(slices): |
| 478 | start = offset + slice_number * items_per_slice |
| 479 | if slice_number < slices_with_extra: |
| 480 | offset += 1 |
| 481 | end = offset + (slice_number + 1) * items_per_slice |
| 482 | tmp = seq[start:end] |
| 483 | if fill_with is not None and slice_number >= slices_with_extra: |
| 484 | tmp.append(fill_with) |
| 485 | result.append(tmp) |
| 486 | return result |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 487 | |
| 488 | |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 489 | def do_batch(value, linecount, fill_with=None): |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 490 | """ |
| 491 | A filter that batches items. It works pretty much like `slice` |
| 492 | just the other way round. It returns a list of lists with the |
| 493 | given number of items. If you provide a second parameter this |
| 494 | is used to fill missing items. See this example: |
| 495 | |
Armin Ronacher | 8937607 | 2007-04-13 22:34:35 +0200 | [diff] [blame] | 496 | .. sourcecode:: html+jinja |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 497 | |
| 498 | <table> |
| 499 | {%- for row in items|batch(3, ' ') %} |
| 500 | <tr> |
| 501 | {%- for column in row %} |
| 502 | <tr>{{ column }}</td> |
| 503 | {%- endfor %} |
| 504 | </tr> |
| 505 | {%- endfor %} |
| 506 | </table> |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 507 | """ |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 508 | result = [] |
| 509 | tmp = [] |
| 510 | for item in value: |
| 511 | if len(tmp) == linecount: |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 512 | result.append(tmp) |
Christoph Hack | e9e43bb | 2008-04-13 23:35:48 +0200 | [diff] [blame] | 513 | tmp = [] |
| 514 | tmp.append(item) |
| 515 | if tmp: |
| 516 | if fill_with is not None and len(tmp) < linecount: |
| 517 | tmp += [fill_with] * (linecount - len(tmp)) |
| 518 | result.append(tmp) |
| 519 | return result |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 520 | |
| 521 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 522 | def do_round(value, precision=0, method='common'): |
| 523 | """Round the number to a given precision. The first |
Armin Ronacher | eec3138 | 2007-04-14 14:50:45 +0200 | [diff] [blame] | 524 | parameter specifies the precision (default is ``0``), the |
| 525 | second the rounding method: |
| 526 | |
| 527 | - ``'common'`` rounds either up or down |
| 528 | - ``'ceil'`` always rounds up |
| 529 | - ``'floor'`` always rounds down |
| 530 | |
| 531 | If you don't specify a method ``'common'`` is used. |
| 532 | |
| 533 | .. sourcecode:: jinja |
| 534 | |
| 535 | {{ 42.55|round }} |
| 536 | -> 43 |
| 537 | {{ 42.55|round(1, 'floor') }} |
| 538 | -> 42.5 |
| 539 | """ |
| 540 | if not method in ('common', 'ceil', 'floor'): |
| 541 | raise FilterArgumentError('method must be common, ceil or floor') |
| 542 | if precision < 0: |
| 543 | raise FilterArgumentError('precision must be a postive integer ' |
| 544 | 'or zero.') |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 545 | if method == 'common': |
| 546 | return round(value, precision) |
| 547 | func = getattr(math, method) |
| 548 | if precision: |
| 549 | return func(value * 10 * precision) / (10 * precision) |
| 550 | else: |
| 551 | return func(value) |
Armin Ronacher | eec3138 | 2007-04-14 14:50:45 +0200 | [diff] [blame] | 552 | |
| 553 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 554 | def do_sort(value, reverse=False): |
| 555 | """Sort a sequence. Per default it sorts ascending, if you pass it |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 556 | `True` as first argument it will reverse the sorting. |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 557 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 558 | return sorted(value, reverse=reverse) |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 559 | |
| 560 | |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 561 | @environmentfilter |
| 562 | def do_groupby(environment, value, attribute): |
| 563 | """Group a sequence of objects by a common attribute. |
Armin Ronacher | e39a5d2 | 2007-06-23 21:11:53 +0200 | [diff] [blame] | 564 | |
| 565 | If you for example have a list of dicts or objects that represent persons |
| 566 | with `gender`, `first_name` and `last_name` attributes and you want to |
| 567 | group all users by genders you can do something like the following |
| 568 | snippet: |
| 569 | |
| 570 | .. sourcecode:: html+jinja |
| 571 | |
| 572 | <ul> |
| 573 | {% for group in persons|groupby('gender') %} |
| 574 | <li>{{ group.grouper }}<ul> |
| 575 | {% for person in group.list %} |
| 576 | <li>{{ person.first_name }} {{ person.last_name }}</li> |
| 577 | {% endfor %}</ul></li> |
| 578 | {% endfor %} |
| 579 | </ul> |
| 580 | |
| 581 | As you can see the item we're grouping by is stored in the `grouper` |
| 582 | attribute and the `list` contains all the objects that have this grouper |
| 583 | in common. |
| 584 | """ |
Armin Ronacher | 9a027f4 | 2008-04-17 11:13:40 +0200 | [diff] [blame^] | 585 | expr = lambda x: environment.subscribe(x, attribute) |
| 586 | return sorted([{ |
| 587 | 'grouper': a, |
| 588 | 'list': b |
| 589 | } for a, b in groupby(sorted(value, key=expr), expr)], |
| 590 | key=itemgetter('grouper')) |
Armin Ronacher | e39a5d2 | 2007-06-23 21:11:53 +0200 | [diff] [blame] | 591 | |
| 592 | |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 593 | FILTERS = { |
| 594 | 'replace': do_replace, |
| 595 | 'upper': do_upper, |
| 596 | 'lower': do_lower, |
| 597 | 'escape': do_escape, |
| 598 | 'e': do_escape, |
Armin Ronacher | 450756b | 2007-04-15 15:13:59 +0200 | [diff] [blame] | 599 | 'xmlattr': do_xmlattr, |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 600 | 'capitalize': do_capitalize, |
| 601 | 'title': do_title, |
| 602 | 'default': do_default, |
| 603 | 'join': do_join, |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 604 | 'count': len, |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 605 | 'dictsort': do_dictsort, |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 606 | 'length': len, |
| 607 | 'reverse': reversed, |
Armin Ronacher | fed86c1 | 2007-02-27 10:31:14 +0100 | [diff] [blame] | 608 | 'center': do_center, |
| 609 | 'title': do_title, |
| 610 | 'capitalize': do_capitalize, |
| 611 | 'first': do_first, |
| 612 | 'last': do_last, |
| 613 | 'random': do_random, |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 614 | 'filesizeformat': do_filesizeformat, |
| 615 | 'pprint': do_pprint, |
| 616 | 'indent': do_indent, |
| 617 | 'truncate': do_truncate, |
| 618 | 'wordwrap': do_wordwrap, |
| 619 | 'wordcount': do_wordcount, |
Armin Ronacher | 2b76513 | 2007-03-13 16:48:10 +0100 | [diff] [blame] | 620 | 'int': do_int, |
| 621 | 'float': do_float, |
Tassilo Schweyer | 934cb71 | 2007-03-14 18:04:07 +0100 | [diff] [blame] | 622 | 'string': do_string, |
Armin Ronacher | f0f4deb | 2007-03-18 23:10:15 +0100 | [diff] [blame] | 623 | 'urlize': do_urlize, |
| 624 | 'format': do_format, |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 625 | 'trim': do_trim, |
Georg Brandl | af31e4d | 2007-04-15 00:47:37 +0200 | [diff] [blame] | 626 | 'striptags': do_striptags, |
Armin Ronacher | d071f95 | 2007-04-13 22:32:11 +0200 | [diff] [blame] | 627 | 'slice': do_slice, |
Armin Ronacher | eec3138 | 2007-04-14 14:50:45 +0200 | [diff] [blame] | 628 | 'batch': do_batch, |
Armin Ronacher | 5f51488 | 2008-04-16 15:29:52 +0200 | [diff] [blame] | 629 | 'sum': sum, |
| 630 | 'abs': abs, |
Armin Ronacher | 9bcd411 | 2007-05-29 14:17:24 +0200 | [diff] [blame] | 631 | 'round': do_round, |
Armin Ronacher | e39a5d2 | 2007-06-23 21:11:53 +0200 | [diff] [blame] | 632 | 'sort': do_sort, |
Armin Ronacher | 18c6ca0 | 2008-04-17 10:03:29 +0200 | [diff] [blame] | 633 | 'groupby': do_groupby, |
| 634 | 'safe': Markup |
Armin Ronacher | 92f572f | 2007-02-26 22:17:32 +0100 | [diff] [blame] | 635 | } |