1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
Templates
=========
A :term:`template` is a usually file on disk which can be used to
render data provided by a :term:`view`, surrounded by more static
information.
Templating With :term:`z3c.pt` (ZPT) Page Templates
---------------------------------------------------
Like Zope, :mod:`repoze.bfg` uses Zope Page Templates (:term:`ZPT`) as
its default templating language. However, :mod:`repoze.bfg` uses a
different implementation of the :term:`ZPT` specification than Zope
does: the :term:`z3c.pt` templating engine. This templating engine
complies with the `Zope Page Template
<http://wiki.zope.org/ZPT/FrontPage>`_ template specification. While
:term:`z3c.pt` doesn't implement the :term:`METAL` specification, it
is significantly faster.
Given that there is a :term:`z3c.pt` template named ``foo.html`` in a
directory in your application named ``templates``, you can render the
template from a view like so:
.. code-block:: python
:linenos:
from repoze.bfg.template import render_template_to_response
def sample_view(context, request):
return render_template_to_response('templates/foo.html', foo=1, bar=2)
The first argument to ``render_template_to_response`` shown above (and
its sister function ``render_template``, not shown, which just returns
a string body) is the template *path*. Above, the path
``templates/foo.html`` is *relative*. Relative to what, you ask?
Relative to the directory in which the ``views.py`` file which names
it lives, which is usually the :mod:`repoze.bfg` application's
:term:`package` directory.
``render_template_to_response`` always renders a :term:`z3c.pt`
template, and always returns a Response object which has a *status
code* of ``200 OK`` and a *content-type* of ``text-html``. If you
need more control over the status code and content-type, use the
``render_template`` function instead, which also renders a z3c.pt
template but returns a string instead of a Response. You can use
the string manually as a response body:
.. code-block:: python
:linenos:
from repoze.bfg.template import render_template
from webob import Response
def sample_view(context, request):
result = render_template('templates/foo.html', foo=1, bar=2)
response = Response(result)
response.content_type = 'text/plain'
return response
:mod:`repoze.bfg` loads the template and keeps it in memory between
requests. This means that modifications to the ZPT require a restart
before you can see the changes.
Templating with XSLT
------------------------
:mod:`repoze.bfg` also supports XSLT as an optional templating
language. Like ZPT, an XSLT template is loaded once and re-used
between requests.
Given a template ``foo.xsl`` in the templates directory, you can render
an XSLT as follows:
.. code-block:: python
:linenos:
from repoze.bfg.template import render_transform_to_response
from lxml import etree
node = etree.Element("root")
return render_transform_to_response('templates/foo.xsl', node)
As shown, the second argument to ``render_transform_to_response`` is
the element (and children) that you want as the top of the data for
the XSLT.
You can also pass XSLT parameters in as keyword arguments:
.. code-block:: python
:linenos:
from repoze.bfg.template import render_transform_to_response
from lxml import etree
node = etree.Element("root")
value1 = "'app1'"
return render_transform_to_response('templates/foo.xsl', node, param1=value1)
This would then assign 'app1' as the value of an ``<xsl:param
name="param1"/>`` parameter in the XSLT template.
Templating with other Templating Languages
------------------------------------------
Because :term:`view` functions are typically the only code in
:mod:`repoze.bfg` that need to know anything about templates, and
because view functions are very simple Python, you can use whatever
templating system you're most comfortable with within
:mod:`repoze.bfg`. Install the templating system, import its API
functions into your views module, use those APIs to generate a string,
then return that string as the body of a :term:`WebOb` ``Response``
object. Assuming you have `Mako <http://www.makotemplates.org/>`_
installed, here's an example of using Mako from within a
:mod:`repoze.bfg` :term:`view`:
.. code-block:: python
:linenos:
from mako.template import Template
from webob import Response
def make_view(context, request):
template = Template(filename='/templates/template.mak')
result = template.render(name=context.name)
response = Response(result)
return response
|
