← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to turbosimpletal/zptsupport.py

  • Committer: Michael Hudson
  • Date: 2008-06-16 09:48:20 UTC
  • mto: This revision was merged to the branch mainline in revision 160.
  • Revision ID: michael.hudson@canonical.com-20080616094820-fgsn8vbl1sqly01h
readme changes

Show diffs side-by-side

added added

removed removed

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