← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbozpt/zptsupport.py

merge trunk

Show diffs side-by-side

added added

removed removed

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