← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbozpt/zptsupport.py

start at revision.pt

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
 
 
3
import sys, os
 
4
 
 
5
from template import PageTemplate
 
6
import pkg_resources
2
7
 
3
8
import logging
4
 
import os
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
 
 
13
 
 
14
 
_zpt_cache = {}
15
 
def zpt(tfile):
16
 
    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)
21
 
    return tinstance
22
 
 
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)
 
9
log = logging.getLogger("turbogears.zptsupport")
 
10
 
 
11
def _recompile_template(package, basename, tfile, classname):
 
12
    log.debug("Recompiling template for %s" % classname)
 
13
    mod = PageTemplate(tfile)
 
14
    mtime = os.stat(tfile).st_mtime
 
15
    mod.__mtime__ = mtime
 
16
    return mod
 
17
 
 
18
class TurboZpt:
 
19
    extension = "pt"
 
20
    
 
21
    def __init__(self, extra_vars_func=None, options={}):
 
22
        self.options = options
 
23
        self.get_extra_vars = extra_vars_func
 
24
        self.compiledTemplates = {}
 
25
    
 
26
    def load_template(self, classname, loadingSite=False):
 
27
        """Searches for a template along the Python path.
 
28
 
 
29
        Template files must end in ".pt" and be in legitimate packages.
 
30
        U can set "zpt.cache_templates" option to cache a loaded template
 
31
        class and only check for updates. Templates are automatically
 
32
        checked for changes and reloaded as neccessary.
 
33
        """
 
34
        ct = self.compiledTemplates
 
35
 
 
36
        divider = classname.rfind(".")
 
37
        if divider > -1:
 
38
            package = classname[0:divider]
 
39
            basename = classname[divider+1:]
 
40
        else:
 
41
            raise ValueError, "All templates must be in a package"
 
42
 
 
43
        cache_templates = self.options.get("zpt.cache_templates", True)
 
44
        tfile = pkg_resources.resource_filename(package, 
 
45
                                                "%s.%s" % 
 
46
                                                (basename,
 
47
                                                self.extension))
 
48
                                                
 
49
        if cache_templates:
 
50
            if ct.has_key(classname):
 
51
                mtime = os.stat(tfile).st_mtime
 
52
                mod = ct[classname]
 
53
                if mod.__mtime__ != mtime:
 
54
                    # Recompile template
 
55
                    mod = _recompile_template(package, basename, tfile, classname)
 
56
                    ct[classname] = mod
 
57
                #else:
 
58
                    # use template from cache    
 
59
                    # pass 
 
60
            else:
 
61
                # First time compile template
 
62
                mod = PageTemplate(tfile)
 
63
                mod.__mtime__ = os.stat(tfile).st_mtime
 
64
                ct[classname] = mod
 
65
        else:
 
66
            mod = PageTemplate(tfile)
 
67
 
 
68
        return mod
 
69
 
 
70
    def render(self, info, format="html", fragment=False, template=None):
 
71
        """Renders data in the desired format.
 
72
        
 
73
        @param info: the data / context itself
 
74
        @type info: dict
 
75
        @para format: "html"
 
76
        @type format: "string"
 
77
        @para template: name of the template to use
 
78
        @type template: string
 
79
        """
 
80
        #if isinstance(template, type):
 
81
        #    tclass = template
 
82
        #else:
 
83
        
 
84
        tinstance = self.load_template(template)
 
85
        log.debug("Applying template %s" % (tinstance.filename))
 
86
        data = dict()
 
87
        if self.get_extra_vars:
 
88
            data.update(self.get_extra_vars())
 
89
        data.update(info)
 
90
        return tinstance(**data).encode('utf-8')
 
91
 
 
92
    def transform(self, info, template):
 
93
        "Render the output to Elements"
 
94
        pass