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