← 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
 
#
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"
 
2
 
 
3
from template import zpt
 
4
import pkg_resources
17
5
 
18
6
import logging
19
 
import os
20
 
import pkg_resources
21
 
import re
22
 
import StringIO
23
 
 
24
 
from simpletal import simpleTAL, simpleTALES
25
 
 
26
 
logging.getLogger("simpleTAL").setLevel(logging.INFO)
27
 
logging.getLogger("simpleTALES").setLevel(logging.INFO)
28
 
 
29
 
 
30
 
_zpt_cache = {}
31
 
 
32
 
 
33
 
def zpt(tfile):
34
 
    tinstance = _zpt_cache.get(tfile)
35
 
    stat = os.stat(tfile)
36
 
    if tinstance is None or tinstance.stat != stat:
37
 
        text = open(tfile).read()
38
 
        text = re.sub(r'\s*\n\s*', '\n', text)
39
 
        text = re.sub(r'[ \t]+', ' ', text)
40
 
        tinstance = _zpt_cache[tfile] = TemplateWrapper(
41
 
            simpleTAL.compileXMLTemplate(text), tfile, stat)
42
 
    return tinstance
43
 
 
44
 
 
45
 
class TemplateWrapper(object):
46
 
 
47
 
    def __init__(self, template, filename, stat):
48
 
        self.template = template
49
 
        self.filename = filename
50
 
        self.stat = stat
51
 
 
52
 
    def expand(self, **info):
53
 
        context = simpleTALES.Context(allowPythonPath=1)
54
 
        for k, v in info.iteritems():
55
 
            context.addGlobal(k, v)
56
 
        s = StringIO.StringIO()
57
 
        self.template.expandInline(context, s)
58
 
        return s.getvalue()
59
 
 
60
 
    def expand_into(self, f, **info):
61
 
        context = simpleTALES.Context(allowPythonPath=1)
62
 
        for k, v in info.iteritems():
63
 
            context.addGlobal(k, v)
64
 
        self.template.expand(context, f, 'utf-8')
65
 
 
66
 
    @property
67
 
    def macros(self):
68
 
        return self.template.macros
69
 
 
70
 
 
71
 
def load_template(classname):
72
 
    """Searches for a template along the Python path.
73
 
 
74
 
    Template files must end in ".pt" and be in legitimate packages.
75
 
    Templates are automatically checked for changes and reloaded as
76
 
    neccessary.
77
 
    """
78
 
    divider = classname.rfind(".")
79
 
    if divider > -1:
80
 
        package = classname[0:divider]
81
 
        basename = classname[divider+1:]
82
 
    else:
83
 
        raise ValueError("All templates must be in a package")
84
 
 
85
 
    tfile = pkg_resources.resource_filename(
86
 
        package, "%s.%s" % (basename, "pt"))
87
 
    return zpt(tfile)
 
7
log = logging.getLogger("turbogears.zptsupport")
 
8
 
 
9
class TurboZpt(object):
 
10
    extension = "pt"
 
11
 
 
12
    def __init__(self, extra_vars_func=None):
 
13
        self.get_extra_vars = extra_vars_func
 
14
 
 
15
    def load_template(self, classname, loadingSite=False):
 
16
        """Searches for a template along the Python path.
 
17
 
 
18
        Template files must end in ".pt" and be in legitimate packages.
 
19
        Templates are automatically checked for changes and reloaded as
 
20
        neccessary.
 
21
        """
 
22
        divider = classname.rfind(".")
 
23
        if divider > -1:
 
24
            package = classname[0:divider]
 
25
            basename = classname[divider+1:]
 
26
        else:
 
27
            raise ValueError, "All templates must be in a package"
 
28
 
 
29
        tfile = pkg_resources.resource_filename(
 
30
            package, "%s.%s" % (basename, self.extension))
 
31
        return zpt(tfile)
 
32
 
 
33
    def render(self, info, format="html", fragment=False, template=None):
 
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)
 
49
        return tinstance(**data).encode('utf-8')
 
50