lib/template.py
author Tero Marttila <terom@fixme.fi>
Fri, 06 Feb 2009 22:48:00 +0200
changeset 8 0ce1f471e9d7
child 11 fa216534ae45
permissions -rw-r--r--
and it works, a lot better than before
8
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
"""
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
    Template handler
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
"""
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
# use Mako
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
from mako import exceptions
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
from mako.template import Template
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
from mako.lookup import TemplateLookup
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
# for http.ResponseError
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
import http
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
# path to template files
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
TEMPLATE_DIR = "templates"
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
# path to cached templates
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
CACHE_DIR = "cache/templates"
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    19
# template file extension
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
TEMPLATE_EXT = "tmpl"
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
# our Mako template lookup handler
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    24
_lookup = TemplateLookup(directories=[TEMPLATE_DIR], module_directory=CACHE_DIR)
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
class TemplateError (http.ResponseError) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
        Raised by the template module functions
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
    pass
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
def lookup (name) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    36
        Looks up a template based on the bare "name", which does not include the path or file extension
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
    
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
    try :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    40
        return _lookup.get_template("%s.%s" % (name, TEMPLATE_EXT))
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
    except :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    43
        raise TemplateError("Template broken: %r" % (name, ), status='500 Internal Server Error', details=exceptions.text_error_template().render())
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
def load (path) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
        Loads a template from a specific file
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    48
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    49
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
    try :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    51
        return Template(filename=path, module_directory=CACHE_DIR)
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    52
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    53
    except :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    54
        raise TemplateError("Template broken: %r" % (path, ), status='500 Internal Server Error', details=exceptions.text_error_template().render())
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    55
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    56
def render_template (tpl, **params) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    57
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    58
        Render the given template, returning the output, or raising a TemplateError
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    59
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    60
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    61
    try :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    62
        return tpl.render(**params)
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    63
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    64
    except :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    65
        raise TemplateError("Template render failed", status='500 Internal Server Error', details=exceptions.text_error_template().render())
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    66
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
def render (name, **params) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    68
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    69
        Render a template, using lookup() on the given name
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    70
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    71
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
    return render_template(lookup(name), **params)
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    73
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    74
def render_file (path, **params) :
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
        Render a template, using load() on the given path
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    77
    """
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    78
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    79
    return render_template(load(path), **params)
0ce1f471e9d7 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    80