Get a Template class quickly given a module name, file, or string.

This is a convenience function for getting a template in a variety of ways. One and only one of the arguments name or file must be specified.

file:string

The template module is loaded by calling load_template(file, name='', cache=1)

name:string

The kid import hook is enabled and the template module is located using the normal Python import mechanisms.

source:string

string containing the templates source.

Once the template module is obtained, a new instance of the module's Template class is created with the keyword arguments passed to this function.

Enable the kid module loader and import hooks.

This function must be called before importing kid templates if templates are not pre-compiled.

Note that if your application uses ZODB, you will need to import ZODB before calling this function as ZODB's import hooks have some issues if installed after the kid import hooks.

Import template by name.

This is identical to calling enable_import followed by an import statement. For example, importing a template named foo using the normal import mechanism looks like this:

import kid
kid.enable_import()
import foo

This function can be used to achieve the same result as follows:

import kid
foo = kid.import_template('foo')

This is sometimes useful when the name of the template is available only as a string.

Bypass import machinery and load a template module directly.

This can be used as an alternative to accessing templates using the native python import mechanisms.

file

Can be a filename, a kid template string, or an open file object.

name

Optionally specifies the module name to use for this template. This is a hack to enable relative imports in templates.

cache

Whether to look for a byte-compiled version of the template. If no byte-compiled version is found, an attempt is made to dump a byte-compiled version after compiling. This argument is ignored if file is not a filename.