lib/template.py
author Tero Marttila <terom@fixme.fi>
Sat, 07 Feb 2009 02:46:58 +0200
changeset 158 0aad1e154ced
parent 153 01f5ef2890c4
child 21 b05979822dee
permissions -rw-r--r--
better error handling of import errors in CGI, and split PageTree out from page.py into page_tree.py and tree_parse.py
150
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     1
"""
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     2
    Template handler
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     3
"""
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     4
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     5
# use Mako
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     6
from mako import exceptions
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     7
from mako.template import Template
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     8
from mako.lookup import TemplateLookup
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
     9
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    10
# for http.ResponseError
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    11
import http
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    12
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    13
# path to template files
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    14
TEMPLATE_DIR = "templates"
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    15
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    16
# path to cached templates
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    17
CACHE_DIR = "cache/templates"
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    18
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    19
# template file extension
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    20
TEMPLATE_EXT = "tmpl"
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    21
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    22
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    23
# our Mako template lookup handler
817a8bb1cdc6 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)
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    25
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    26
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    27
class TemplateError (http.ResponseError) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    28
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    29
        Raised by the template module functions
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    30
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    31
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    32
    pass
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    33
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    34
def lookup (name) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    35
    """
817a8bb1cdc6 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
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    37
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    38
    
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    39
    try :
817a8bb1cdc6 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))
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    41
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    42
    except :
817a8bb1cdc6 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())
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    44
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    45
def load (path) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    46
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    47
        Loads a template from a specific file
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    48
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    49
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    50
    try :
817a8bb1cdc6 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)
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    52
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    53
    except :
817a8bb1cdc6 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())
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    55
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    56
def render_template (tpl, **params) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    57
    """
817a8bb1cdc6 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
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    59
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    60
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    61
    try :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    62
        return tpl.render(**params)
153
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    63
    
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    64
    # a template may render other templates
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    65
    except TemplateError :
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    66
        raise
150
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    67
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    68
    except :
153
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    69
        details = exceptions.text_error_template().render()
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    70
01f5ef2890c4 funky PageTree stuff
Tero Marttila <terom@fixme.fi>
parents: 150
diff changeset
    71
        raise TemplateError("Template render failed", status='500 Internal Server Error', details=details)
150
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    72
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    73
def render (name, **params) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    74
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    75
        Render a template, using lookup() on the given name
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    76
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    77
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    78
    return render_template(lookup(name), **params)
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    79
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    80
def render_file (path, **params) :
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    81
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    82
        Render a template, using load() on the given path
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    83
    """
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    84
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    85
    return render_template(load(path), **params)
817a8bb1cdc6 and it works, a lot better than before
Tero Marttila <terom@fixme.fi>
parents:
diff changeset
    86