← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbosimpletal/zptsupport.py

  • Committer: Michael Hudson
  • Date: 2008-06-11 05:05:43 UTC
  • mfrom: (128.6.75 zpt-templating)
  • Revision ID: michael.hudson@canonical.com-20080611050543-o8vel8ydossw3wkc
merge zpt-templating.
this gets rid of all the kid templates and replaces them with zope page
templates and adds glue to render them under turbogears with the simpletal
library.

Show diffs side-by-side

added added

removed removed

Lines of Context:
turbosimpletal/zptsupport.py
 
1
"TurboGears support for Zope Page Templates"
 
2
 
 
3
import StringIO
 
4
import logging
 
5
import os
 
6
import pkg_resources
 
7
 
 
8
from simpletal import simpleTAL, simpleTALES
 
9
 
 
10
log = logging.getLogger("turbogears.zptsupport")
 
11
 
 
12
 
 
13
_zpt_cache = {}
 
14
def zpt(tfile):
 
15
    tinstance = _zpt_cache.get(tfile)
 
16
    stat = os.stat(tfile)
 
17
    if tinstance is None or tinstance.stat != stat:
 
18
        tinstance = _zpt_cache[tfile] = TemplateWrapper(
 
19
            simpleTAL.compileXMLTemplate(open(tfile)), tfile, stat)
 
20
    return tinstance
 
21
 
 
22
 
 
23
class TemplateWrapper(object):
 
24
 
 
25
    def __init__(self, template, filename, stat):
 
26
        self.template = template
 
27
        self.filename = filename
 
28
        self.stat = stat
 
29
 
 
30
    def expand(self, **info):
 
31
        context = simpleTALES.Context(allowPythonPath=1)
 
32
        for k, v in info.iteritems():
 
33
            context.addGlobal(k, v)
 
34
        s = StringIO.StringIO()
 
35
        self.template.expandInline(context, s)
 
36
        return s.getvalue()
 
37
 
 
38
    @property
 
39
    def macros(self):
 
40
        return self.template.macros
 
41
 
 
42
 
 
43
class TurboZpt(object):
 
44
    extension = "pt"
 
45
 
 
46
    def __init__(self, extra_vars_func=None):
 
47
        self.get_extra_vars = extra_vars_func
 
48
 
 
49
    def load_template(self, classname, loadingSite=False):
 
50
        """Searches for a template along the Python path.
 
51
 
 
52
        Template files must end in ".pt" and be in legitimate packages.
 
53
        Templates are automatically checked for changes and reloaded as
 
54
        neccessary.
 
55
        """
 
56
        divider = classname.rfind(".")
 
57
        if divider > -1:
 
58
            package = classname[0:divider]
 
59
            basename = classname[divider+1:]
 
60
        else:
 
61
            raise ValueError, "All templates must be in a package"
 
62
 
 
63
        tfile = pkg_resources.resource_filename(
 
64
            package, "%s.%s" % (basename, self.extension))
 
65
        return zpt(tfile)
 
66
 
 
67
    def render(self, info, format="html", fragment=False, template=None):
 
68
        """Renders data in the desired format.
 
69
 
 
70
        @param info: the data / context itself
 
71
        @type info: dict
 
72
        @para format: "html"
 
73
        @type format: "string"
 
74
        @para template: name of the template to use
 
75
        @type template: string
 
76
        """
 
77
        tinstance = self.load_template(template)
 
78
        log.debug("Applying template %s" % (tinstance.filename))
 
79
        data = dict()
 
80
        if self.get_extra_vars:
 
81
            data.update(self.get_extra_vars())
 
82
        data.update(info)
 
83
        return tinstance.expand(**data).encode('utf-8')