← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbozpt/zptsupport.py

clean up dusty parts of turbozpt

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
 
3
from template import zpt
6
4
import pkg_resources
7
5
 
8
6
import logging
9
7
log = logging.getLogger("turbogears.zptsupport")
10
8
 
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:
 
9
class TurboZpt(object):
19
10
    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
 
    
 
11
 
 
12
    def __init__(self, extra_vars_func=None):
 
13
        self.get_extra_vars = extra_vars_func
 
14
 
26
15
    def load_template(self, classname, loadingSite=False):
27
16
        """Searches for a template along the Python path.
28
17
 
29
18
        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.
 
19
        Templates are automatically checked for changes and reloaded as
 
20
        neccessary.
33
21
        """
34
 
        ct = self.compiledTemplates
35
 
 
36
22
        divider = classname.rfind(".")
37
23
        if divider > -1:
38
24
            package = classname[0:divider]
40
26
        else:
41
27
            raise ValueError, "All templates must be in a package"
42
28
 
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
 
29
        tfile = pkg_resources.resource_filename(
 
30
            package, "%s.%s" % (basename, self.extension))
 
31
        return zpt(tfile)
69
32
 
70
33
    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)
 
34
        """Renders data in the desired format.
 
35
 
 
36
        @param info: the data / context itself
 
37
        @type info: dict
 
38
        @para format: "html"
 
39
        @type format: "string"
 
40
        @para template: name of the template to use
 
41
        @type template: string
 
42
        """
 
43
        tinstance = self.load_template(template)
 
44
        log.debug("Applying template %s" % (tinstance.filename))
 
45
        data = dict()
 
46
        if self.get_extra_vars:
 
47
            data.update(self.get_extra_vars())
 
48
        data.update(info)
90
49
        return tinstance(**data).encode('utf-8')
91
50
 
92
 
    def transform(self, info, template):
93
 
        "Render the output to Elements"
94
 
        pass