← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbozpt/zptsupport.py

page template cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
turbozpt/zptsupport.py
1
 
#
2
 
# This program is free software; you can redistribute it and/or modify
3
 
# it under the terms of the GNU General Public License as published by
4
 
# the Free Software Foundation; either version 2 of the License, or
5
 
# (at your option) any later version.
6
 
#
7
 
# This program is distributed in the hope that it will be useful,
8
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 
# GNU General Public License for more details.
11
 
#
12
 
# You should have received a copy of the GNU General Public License
13
 
# along with this program; if not, write to the Free Software
14
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
15
 
#
16
 
"""Support for Zope Page Templates using the simpletal library."""
 
1
"TurboGears support for Zope Page Templates"
17
2
 
18
3
import logging
19
4
import os
20
5
import pkg_resources
21
 
import re
22
 
import StringIO
23
 
 
24
 
from simpletal import simpleTAL, simpleTALES
 
6
 
 
7
from zope.pagetemplate.pagetemplatefile import PageTemplateFile
 
8
 
 
9
log = logging.getLogger("turbogears.zptsupport")
25
10
 
26
11
_zpt_cache = {}
27
12
 
28
 
 
29
13
def zpt(tfile):
30
14
    tinstance = _zpt_cache.get(tfile)
31
 
    stat = os.stat(tfile)
32
 
    if tinstance is None or tinstance.stat != stat:
33
 
        text = open(tfile).read()
34
 
        text = re.sub(r'\s*\n\s*', '\n', text)
35
 
        text = re.sub(r'[ \t]+', ' ', text)
36
 
        tinstance = _zpt_cache[tfile] = TemplateWrapper(
37
 
            simpleTAL.compileXMLTemplate(text), tfile, stat)
 
15
    if tinstance is None:
 
16
        tinstance = _zpt_cache[tfile] = TGPageTemplateFile(tfile)
38
17
    return tinstance
39
18
 
40
 
 
41
 
class TemplateWrapper(object):
42
 
 
43
 
    def __init__(self, template, filename, stat):
44
 
        self.template = template
45
 
        self.filename = filename
46
 
        self.stat = stat
47
 
 
48
 
    def expand(self, **info):
49
 
        context = simpleTALES.Context(allowPythonPath=1)
50
 
        for k, v in info.iteritems():
51
 
            context.addGlobal(k, v)
52
 
        s = StringIO.StringIO()
53
 
        self.template.expandInline(context, s)
54
 
        return s.getvalue()
55
 
 
56
 
    def expand_into(self, f, **info):
57
 
        context = simpleTALES.Context(allowPythonPath=1)
58
 
        for k, v in info.iteritems():
59
 
            context.addGlobal(k, v)
60
 
        self.template.expand(context, f, 'utf-8')
61
 
 
62
 
    @property
63
 
    def macros(self):
64
 
        return self.template.macros
65
 
 
66
 
 
67
 
def load_template(classname):
68
 
    """Searches for a template along the Python path.
69
 
 
70
 
    Template files must end in ".pt" and be in legitimate packages.
71
 
    Templates are automatically checked for changes and reloaded as
72
 
    neccessary.
73
 
    """
74
 
    divider = classname.rfind(".")
75
 
    if divider > -1:
76
 
        package = classname[0:divider]
77
 
        basename = classname[divider+1:]
78
 
    else:
79
 
        raise ValueError("All templates must be in a package")
80
 
 
81
 
    tfile = pkg_resources.resource_filename(
82
 
        package, "%s.%s" % (basename, "pt"))
83
 
    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')