← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbozpt/zptsupport.py

add a lightly hacked copy of turbozpt (it's not much code)

Show diffs side-by-side

added added

removed removed

Lines of Context:
turbozpt/zptsupport.py
1
1
"TurboGears support for Zope Page Templates"
2
2
 
 
3
import sys, os
 
4
 
 
5
from template import PageTemplate
 
6
import pkg_resources
 
7
 
3
8
import logging
4
 
import os
5
 
import pkg_resources
6
 
 
7
 
from zope.pagetemplate.pagetemplatefile import PageTemplateFile
8
 
 
9
9
log = logging.getLogger("turbogears.zptsupport")
10
10
 
11
 
_zpt_cache = {}
12
 
 
13
 
def zpt(tfile):
14
 
    tinstance = _zpt_cache.get(tfile)
15
 
    if tinstance is None:
16
 
        tinstance = _zpt_cache[tfile] = TGPageTemplateFile(tfile)
17
 
    return tinstance
18
 
 
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):
 
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:
28
19
    extension = "pt"
29
 
 
30
 
    def __init__(self, extra_vars_func=None):
31
 
        self.get_extra_vars = extra_vars_func
32
 
 
 
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
    
33
26
    def load_template(self, classname, loadingSite=False):
34
27
        """Searches for a template along the Python path.
35
28
 
36
29
        Template files must end in ".pt" and be in legitimate packages.
37
 
        Templates are automatically checked for changes and reloaded as
38
 
        neccessary.
 
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.
39
33
        """
 
34
        ct = self.compiledTemplates
 
35
 
40
36
        divider = classname.rfind(".")
41
37
        if divider > -1:
42
38
            package = classname[0:divider]
44
40
        else:
45
41
            raise ValueError, "All templates must be in a package"
46
42
 
47
 
        tfile = pkg_resources.resource_filename(
48
 
            package, "%s.%s" % (basename, self.extension))
49
 
        return zpt(tfile)
 
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
50
69
 
51
70
    def render(self, info, format="html", fragment=False, template=None):
52
 
        """Renders data in the desired format.
 
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
        
 
91
        return str(tinstance(**data))
53
92
 
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')
 
93
    def transform(self, info, template):
 
94
        "Render the output to Elements"
 
95
        pass