From f859485cf732731594d3a5c5c50415f32a4aa412 Mon Sep 17 00:00:00 2001 From: Armin Ronacher Date: Tue, 20 Mar 2007 20:33:33 +0100 Subject: [PATCH] [svn] added jinja gti plugin --HG-- branch : trunk --- jinja/plugin.py | 87 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 jinja/plugin.py diff --git a/jinja/plugin.py b/jinja/plugin.py new file mode 100644 index 0000000..5eb70bf --- /dev/null +++ b/jinja/plugin.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +""" + jinja.plugin + ~~~~~~~~~~~~ + + Support for the `GeneralTemplateInterface`__. + + __ http://trac.pocoo.org/wiki/GeneralTemplateInterface + + :copyright: 2007 by Armin Ronacher. + :license: BSD, see LICENSE for more details. +""" +from jinja.environment import Environment +from jinja.loaders import FunctionLoader +from jinja.exceptions import TemplateNotFound + + +def jinja_plugin_factory(options): + """ + Basic implementation of the `GeneralTemplateInterface`. + + Supports ``loader_func`` and ``getmtime_func``, as well as + string and file loading but ignores ``mode`` since it's a + text based template engine. + + All options passed to this function are forwarded to the + jinja environment. Exceptions are the following keys: + + =================== ================================================= + ``environment`` If this is provided it must be the only + configuration value and it's used as jinja + environment. + ``loader_func`` Function that takes the name of the template to + load. If it returns a string or unicode object + it's used to load a template. If the return + value is None it's considered missing. + ``getmtime_func`` Function used to check if templates requires + reloading. Has to return the UNIX timestamp of + the last template change or 0 if this template + does not exist or requires updates at any cost. + ``use_memcache`` Set this to ``True`` to enable memory caching. + This is usually a good idea in production mode, + but disable it during development since it won't + reload template changes automatically. + This only works in persistent environments like + FastCGI. + ``memcache_size`` Number of template instance you want to cache. + Defaults to ``40``. + ``cache_folder`` Set this to an existing directory to enable + caching of templates on the file system. Note + that this only affects templates transformed + into python code. Default is ``None`` which means + that caching is disabled. + ``auto_reload`` Set this to `False` for a slightly better + performance. In that case of `getmtime_func` + not being provided this won't have an effect. + =================== ================================================= + """ + if 'environment' in options: + env = options['environment'] + if not len(options) == 1: + raise TypeError('if environment provided no other ' + 'arguments are allowed') + else: + loader_func = options.pop('loader_func', None) + getmtime_func = options.pop('getmtime_func', None) + use_memcache = options.pop('use_memcache', False) + memcache_size = options.pop('memcache_size', 40) + cache_folder = options.pop('cache_folder', None) + auto_reload = options.pop('auto_reload', True) + if loader_func is not None: + options['loader'] = FunctionLoader(loader_func, getmtime_func, + use_memcache, memcache_size, + cache_folder, auto_reload) + env = Environment(**options) + + def render_function(template, values, options): + if options.get('is_string'): + tmpl = env.from_string(template) + else: + try: + tmpl = env.get_template(template) + except TemplateNotFound: + return + return (tmpl.render(**values),) + + return render_function -- 2.26.2