← Back to branch summary

~ubuntu-branches/ubuntu/raring/genshi/raring-proposed

« back to all changes in this revision

Viewing changes to doc/api/genshi.template.base.Template-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Fontaine
  • Date: 2007-04-16 17:49:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070416174903-x2p3n9g890v18d0m
Tags: 0.4-1
* New upstream release.
* Remove useless python-markup transition package.
* Add Provides against python-markup.
* Add doc-base.
* Add depends against python-xml.
* Add suggests to python-setuptools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/genshi.template.base.Template-class.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>genshi.template.base.Template</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
  <!-- Project homepage -->
 
34
      <th class="navbar" align="right" width="100%">
 
35
        <table border="0" cellpadding="0" cellspacing="0">
 
36
          <tr><th class="navbar" align="center"
 
37
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
38
          </tr></table></th>
 
39
  </tr>
 
40
</table>
 
41
<table width="100%" cellpadding="0" cellspacing="0">
 
42
  <tr valign="top">
 
43
    <td width="100%">
 
44
      <span class="breadcrumbs">
 
45
        <a href="genshi-module.html">Package&nbsp;genshi</a> ::
 
46
        <a href="genshi.template-module.html">Package&nbsp;template</a> ::
 
47
        <a href="genshi.template.base-module.html">Module&nbsp;base</a> ::
 
48
        Class&nbsp;Template
 
49
      </span>
 
50
    </td>
 
51
    <td>
 
52
      <table cellpadding="0" cellspacing="0">
 
53
        <!-- hide/show private -->
 
54
      </table>
 
55
    </td>
 
56
  </tr>
 
57
</table>
 
58
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
59
<h1 class="epydoc">Class Template</h1><br /><br />
 
60
<pre class="base-tree">
 
61
object --+
 
62
         |
 
63
        <strong class="uidshort">Template</strong>
 
64
</pre>
 
65
 
 
66
<dl><dt>Known Subclasses:</dt>
 
67
<dd>
 
68
    <a href="genshi.template.markup.MarkupTemplate-class.html">markup.MarkupTemplate</a>,
 
69
    <a href="genshi.template.text.TextTemplate-class.html">text.TextTemplate</a>
 
70
</dd></dl>
 
71
 
 
72
<hr />
 
73
<p>Abstract template base class.</p>
 
74
<p>This class implements most of the template processing model, but does not
 
75
specify the syntax of templates.</p><br /><br />
 
76
 
 
77
<!-- ==================== NESTED CLASSES ==================== -->
 
78
<a name="section-NestedClasses"></a>
 
79
<table class="summary" border="1" cellpadding="3"
 
80
       cellspacing="0" width="100%" bgcolor="white">
 
81
<tr bgcolor="#70b0f0" class="table-header">
 
82
  <td align="left" colspan="2" class="table-header">
 
83
    <span class="table-header">Nested Classes</span></td>
 
84
</tr>
 
85
<tr>
 
86
    <td width="15%" align="right" valign="top" class="summary">
 
87
      <span class="summary-type">&nbsp;</span>
 
88
    </td><td class="summary">
 
89
        <a href="genshi.template.base.TemplateMeta-class.html" class="summary-name">__metaclass__</a><br />
 
90
      Meta class for templates.
 
91
    </td>
 
92
  </tr>
 
93
</table>
 
94
<!-- ==================== INSTANCE METHODS ==================== -->
 
95
<a name="section-InstanceMethods"></a>
 
96
<table class="summary" border="1" cellpadding="3"
 
97
       cellspacing="0" width="100%" bgcolor="white">
 
98
<tr bgcolor="#70b0f0" class="table-header">
 
99
  <td align="left" colspan="2" class="table-header">
 
100
    <span class="table-header">Instance Methods</span></td>
 
101
</tr>
 
102
<tr>
 
103
    <td width="15%" align="right" valign="top" class="summary">
 
104
      <span class="summary-type">&nbsp;</span>
 
105
    </td><td class="summary">
 
106
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
107
        <tr>
 
108
          <td><span class="summary-sig"><a href="genshi.template.base.Template-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 
109
        <span class="summary-sig-arg">source</span>,
 
110
        <span class="summary-sig-arg">basedir</span>=<span class="summary-sig-default">None</span>,
 
111
        <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
 
112
        <span class="summary-sig-arg">loader</span>=<span class="summary-sig-default">None</span>,
 
113
        <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
 
114
        <span class="summary-sig-arg">lookup</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">lenient</code><code class="variable-quote">'</code></span>)</span><br />
 
115
      Initialize a template from either a string, a file-like object, or
 
116
an already parsed markup stream.</td>
 
117
          <td align="right" valign="top">
 
118
            
 
119
            
 
120
          </td>
 
121
        </tr>
 
122
      </table>
 
123
      
 
124
    </td>
 
125
  </tr>
 
126
<tr>
 
127
    <td width="15%" align="right" valign="top" class="summary">
 
128
      <span class="summary-type">&nbsp;</span>
 
129
    </td><td class="summary">
 
130
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
131
        <tr>
 
132
          <td><span class="summary-sig"><a href="genshi.template.base.Template-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
133
      repr(x)</td>
 
134
          <td align="right" valign="top">
 
135
            
 
136
            
 
137
          </td>
 
138
        </tr>
 
139
      </table>
 
140
      
 
141
    </td>
 
142
  </tr>
 
143
<tr>
 
144
    <td width="15%" align="right" valign="top" class="summary">
 
145
      <span class="summary-type">&nbsp;</span>
 
146
    </td><td class="summary">
 
147
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
148
        <tr>
 
149
          <td><span class="summary-sig"><a href="genshi.template.base.Template-class.html#generate" class="summary-sig-name">generate</a>(<span class="summary-sig-arg">self</span>,
 
150
        <span class="summary-sig-arg">*args</span>,
 
151
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
 
152
      Apply the template to the given context data.</td>
 
153
          <td align="right" valign="top">
 
154
            
 
155
            
 
156
          </td>
 
157
        </tr>
 
158
      </table>
 
159
      
 
160
    </td>
 
161
  </tr>
 
162
  <tr>
 
163
    <td colspan="2" class="summary">
 
164
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
165
      <code>__delattr__</code>,
 
166
      <code>__getattribute__</code>,
 
167
      <code>__hash__</code>,
 
168
      <code>__new__</code>,
 
169
      <code>__reduce__</code>,
 
170
      <code>__reduce_ex__</code>,
 
171
      <code>__setattr__</code>,
 
172
      <code>__str__</code>
 
173
      </p>
 
174
    </td>
 
175
  </tr>
 
176
</table>
 
177
<!-- ==================== CLASS VARIABLES ==================== -->
 
178
<a name="section-ClassVariables"></a>
 
179
<table class="summary" border="1" cellpadding="3"
 
180
       cellspacing="0" width="100%" bgcolor="white">
 
181
<tr bgcolor="#70b0f0" class="table-header">
 
182
  <td align="left" colspan="2" class="table-header">
 
183
    <span class="table-header">Class Variables</span></td>
 
184
</tr>
 
185
<tr>
 
186
    <td width="15%" align="right" valign="top" class="summary">
 
187
      <span class="summary-type">&nbsp;</span>
 
188
    </td><td class="summary">
 
189
        <a name="EXPR"></a><span class="summary-name">EXPR</span> = <code title="'EXPR'">'EXPR'</code><br />
 
190
      Stream event kind representing a Python expression.
 
191
    </td>
 
192
  </tr>
 
193
<tr>
 
194
    <td width="15%" align="right" valign="top" class="summary">
 
195
      <span class="summary-type">&nbsp;</span>
 
196
    </td><td class="summary">
 
197
        <a name="SUB"></a><span class="summary-name">SUB</span> = <code title="'SUB'">'SUB'</code><br />
 
198
      Stream event kind representing a nested stream to which one or more
 
199
directives should be applied.
 
200
    </td>
 
201
  </tr>
 
202
</table>
 
203
<!-- ==================== PROPERTIES ==================== -->
 
204
<a name="section-Properties"></a>
 
205
<table class="summary" border="1" cellpadding="3"
 
206
       cellspacing="0" width="100%" bgcolor="white">
 
207
<tr bgcolor="#70b0f0" class="table-header">
 
208
  <td align="left" colspan="2" class="table-header">
 
209
    <span class="table-header">Properties</span></td>
 
210
</tr>
 
211
  <tr>
 
212
    <td colspan="2" class="summary">
 
213
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
214
      <code>__class__</code>
 
215
      </p>
 
216
    </td>
 
217
  </tr>
 
218
</table>
 
219
<!-- ==================== METHOD DETAILS ==================== -->
 
220
<a name="section-MethodDetails"></a>
 
221
<table class="details" border="1" cellpadding="3"
 
222
       cellspacing="0" width="100%" bgcolor="white">
 
223
<tr bgcolor="#70b0f0" class="table-header">
 
224
  <td align="left" colspan="2" class="table-header">
 
225
    <span class="table-header">Method Details</span></td>
 
226
</tr>
 
227
</table>
 
228
<a name="__init__"></a>
 
229
<div>
 
230
<table class="details" border="1" cellpadding="3"
 
231
       cellspacing="0" width="100%" bgcolor="white">
 
232
<tr><td>
 
233
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
234
  <tr valign="top"><td>
 
235
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
236
        <span class="sig-arg">source</span>,
 
237
        <span class="sig-arg">basedir</span>=<span class="sig-default">None</span>,
 
238
        <span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
 
239
        <span class="sig-arg">loader</span>=<span class="sig-default">None</span>,
 
240
        <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
 
241
        <span class="sig-arg">lookup</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">lenient</code><code class="variable-quote">'</code></span>)</span>
 
242
    <br /><em class="fname">(Constructor)</em>
 
243
  </h3>
 
244
  </td><td align="right" valign="top"
 
245
    >&nbsp;
 
246
    </td>
 
247
  </table>
 
248
  
 
249
  Initialize a template from either a string, a file-like object, or
 
250
an already parsed markup stream.
 
251
  <dl class="fields">
 
252
    <dt>Parameters:</dt>
 
253
    <dd><ul class="nomargin-top">
 
254
        <li><strong class="pname"><code>source</code></strong> - a string, file-like object, or markup stream to read the
 
255
template from</li>
 
256
        <li><strong class="pname"><code>basedir</code></strong> - the base directory containing the template file; when
 
257
loaded from a <a href="genshi.template.loader.TemplateLoader-class.html" class="link">TemplateLoader</a>, this will be the
 
258
directory on the template search path in which the
 
259
template was found</li>
 
260
        <li><strong class="pname"><code>filename</code></strong> - the name of the template file, relative to the given
 
261
base directory</li>
 
262
        <li><strong class="pname"><code>loader</code></strong> - the <a href="genshi.template.loader.TemplateLoader-class.html" class="link">TemplateLoader</a> to use for load included templates</li>
 
263
        <li><strong class="pname"><code>encoding</code></strong> - the encoding of the <code class="link">source</code></li>
 
264
        <li><strong class="pname"><code>lookup</code></strong> - the variable lookup mechanism; either &quot;lenient&quot; (the
 
265
default), &quot;strict&quot;, or a custom lookup class</li>
 
266
    </ul></dd>
 
267
    <dt>Overrides:
 
268
      object.__init__
 
269
    </dt>
 
270
  </dl>
 
271
</td></tr></table>
 
272
</div>
 
273
<a name="__repr__"></a>
 
274
<div>
 
275
<table class="details" border="1" cellpadding="3"
 
276
       cellspacing="0" width="100%" bgcolor="white">
 
277
<tr><td>
 
278
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
279
  <tr valign="top"><td>
 
280
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 
281
    <br /><em class="fname">(Representation operator)</em>
 
282
  </h3>
 
283
  </td><td align="right" valign="top"
 
284
    >&nbsp;
 
285
    </td>
 
286
  </table>
 
287
  
 
288
  repr(x)
 
289
  <dl class="fields">
 
290
    <dt>Overrides:
 
291
      object.__repr__
 
292
        <dd><em class="note">(inherited documentation)</em></dd>
 
293
    </dt>
 
294
  </dl>
 
295
</td></tr></table>
 
296
</div>
 
297
<a name="generate"></a>
 
298
<div>
 
299
<table class="details" border="1" cellpadding="3"
 
300
       cellspacing="0" width="100%" bgcolor="white">
 
301
<tr><td>
 
302
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
303
  <tr valign="top"><td>
 
304
  <h3 class="epydoc"><span class="sig"><span class="sig-name">generate</span>(<span class="sig-arg">self</span>,
 
305
        <span class="sig-arg">*args</span>,
 
306
        <span class="sig-arg">**kwargs</span>)</span>
 
307
  </h3>
 
308
  </td><td align="right" valign="top"
 
309
    >&nbsp;
 
310
    </td>
 
311
  </table>
 
312
  
 
313
  <p>Apply the template to the given context data.</p>
 
314
<p>Any keyword arguments are made available to the template as context
 
315
data.</p>
 
316
<p>Only one positional argument is accepted: if it is provided, it must be
 
317
an instance of the <a href="genshi.template.base.Context-class.html" class="link">Context</a> class, and keyword arguments are ignored.
 
318
This calling style is used for internal processing.</p>
 
319
  <dl class="fields">
 
320
    <dt>Returns:</dt>
 
321
        <dd>a markup event stream representing the result of applying
 
322
the template to the context data.</dd>
 
323
  </dl>
 
324
</td></tr></table>
 
325
</div>
 
326
<br />
 
327
<!-- ==================== NAVIGATION BAR ==================== -->
 
328
<table class="navbar" border="0" width="100%" cellpadding="0"
 
329
       bgcolor="#a0c0ff" cellspacing="0">
 
330
  <tr valign="middle">
 
331
  <!-- Home link -->
 
332
      <th>&nbsp;&nbsp;&nbsp;<a
 
333
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
334
 
 
335
  <!-- Tree link -->
 
336
      <th>&nbsp;&nbsp;&nbsp;<a
 
337
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
338
 
 
339
  <!-- Index link -->
 
340
      <th>&nbsp;&nbsp;&nbsp;<a
 
341
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
342
 
 
343
  <!-- Help link -->
 
344
      <th>&nbsp;&nbsp;&nbsp;<a
 
345
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
346
 
 
347
  <!-- Project homepage -->
 
348
      <th class="navbar" align="right" width="100%">
 
349
        <table border="0" cellpadding="0" cellspacing="0">
 
350
          <tr><th class="navbar" align="center"
 
351
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
352
          </tr></table></th>
 
353
  </tr>
 
354
</table>
 
355
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
356
  <tr>
 
357
    <td align="left" class="footer">
 
358
    Generated by Epydoc 3.0beta1 on Mon Apr 16 16:02:14 2007
 
359
    </td>
 
360
    <td align="right" class="footer">
 
361
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
362
    </td>
 
363
  </tr>
 
364
</table>
 
365
 
 
366
<script type="text/javascript">
 
367
  <!--
 
368
  // Private objects are initially displayed (because if
 
369
  // javascript is turned off then we want them to be
 
370
  // visible); but by default, we want to hide them.  So hide
 
371
  // them unless we have a cookie that says to show them.
 
372
  checkCookie()
 
373
  // -->
 
374
</script>
 
375
  
 
376
</body>
 
377
</html>