← 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.Context-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.Context-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.Context</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;Context
 
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 Context</h1><br /><br />
 
60
<pre class="base-tree">
 
61
object --+
 
62
         |
 
63
        <strong class="uidshort">Context</strong>
 
64
</pre>
 
65
 
 
66
<hr />
 
67
<p>Container for template input data.</p>
 
68
<p>A context provides a stack of scopes (represented by dictionaries).</p>
 
69
<p>Template directives such as loops can push a new scope on the stack with
 
70
data that should only be available inside the loop. When the loop
 
71
terminates, that scope can get popped off the stack again.</p>
 
72
<pre class="py-doctest">
 
73
<span class="py-prompt">&gt;&gt;&gt; </span>ctxt = Context(one=<span class="py-string">'foo'</span>, other=1)
 
74
<span class="py-prompt">&gt;&gt;&gt; </span>ctxt.get(<span class="py-string">'one'</span>)
 
75
<span class="py-output">'foo'</span>
 
76
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>ctxt.get(<span class="py-string">'other'</span>)
 
77
<span class="py-output">1</span>
 
78
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>ctxt.push(dict(one=<span class="py-string">'frost'</span>))
 
79
<span class="py-prompt">&gt;&gt;&gt; </span>ctxt.get(<span class="py-string">'one'</span>)
 
80
<span class="py-output">'frost'</span>
 
81
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>ctxt.get(<span class="py-string">'other'</span>)
 
82
<span class="py-output">1</span>
 
83
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>ctxt.pop()
 
84
<span class="py-output">{'one': 'frost'}</span>
 
85
<span class="py-output"></span><span class="py-prompt">&gt;&gt;&gt; </span>ctxt.get(<span class="py-string">'one'</span>)
 
86
<span class="py-output">'foo'</span></pre><br /><br />
 
87
 
 
88
<!-- ==================== INSTANCE METHODS ==================== -->
 
89
<a name="section-InstanceMethods"></a>
 
90
<table class="summary" border="1" cellpadding="3"
 
91
       cellspacing="0" width="100%" bgcolor="white">
 
92
<tr bgcolor="#70b0f0" class="table-header">
 
93
  <td align="left" colspan="2" class="table-header">
 
94
    <span class="table-header">Instance Methods</span></td>
 
95
</tr>
 
96
<tr>
 
97
    <td width="15%" align="right" valign="top" class="summary">
 
98
      <span class="summary-type">&nbsp;</span>
 
99
    </td><td class="summary">
 
100
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
101
        <tr>
 
102
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 
103
        <span class="summary-sig-arg">**data</span>)</span><br />
 
104
      Initialize the template context with the given keyword arguments as
 
105
data.</td>
 
106
          <td align="right" valign="top">
 
107
            
 
108
            
 
109
          </td>
 
110
        </tr>
 
111
      </table>
 
112
      
 
113
    </td>
 
114
  </tr>
 
115
<tr>
 
116
    <td width="15%" align="right" valign="top" class="summary">
 
117
      <span class="summary-type">&nbsp;</span>
 
118
    </td><td class="summary">
 
119
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
120
        <tr>
 
121
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
122
      repr(x)</td>
 
123
          <td align="right" valign="top">
 
124
            
 
125
            
 
126
          </td>
 
127
        </tr>
 
128
      </table>
 
129
      
 
130
    </td>
 
131
  </tr>
 
132
<tr>
 
133
    <td width="15%" align="right" valign="top" class="summary">
 
134
      <span class="summary-type">&nbsp;</span>
 
135
    </td><td class="summary">
 
136
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
137
        <tr>
 
138
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__contains__" class="summary-sig-name">__contains__</a>(<span class="summary-sig-arg">self</span>,
 
139
        <span class="summary-sig-arg">key</span>)</span><br />
 
140
      Return whether a variable exists in any of the scopes.</td>
 
141
          <td align="right" valign="top">
 
142
            
 
143
            
 
144
          </td>
 
145
        </tr>
 
146
      </table>
 
147
      
 
148
    </td>
 
149
  </tr>
 
150
<tr>
 
151
    <td width="15%" align="right" valign="top" class="summary">
 
152
      <span class="summary-type">&nbsp;</span>
 
153
    </td><td class="summary">
 
154
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
155
        <tr>
 
156
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__delitem__" class="summary-sig-name">__delitem__</a>(<span class="summary-sig-arg">self</span>,
 
157
        <span class="summary-sig-arg">key</span>)</span><br />
 
158
      Remove a variable from all scopes.</td>
 
159
          <td align="right" valign="top">
 
160
            
 
161
            
 
162
          </td>
 
163
        </tr>
 
164
      </table>
 
165
      
 
166
    </td>
 
167
  </tr>
 
168
<tr>
 
169
    <td width="15%" align="right" valign="top" class="summary">
 
170
      <span class="summary-type">&nbsp;</span>
 
171
    </td><td class="summary">
 
172
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
173
        <tr>
 
174
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
 
175
        <span class="summary-sig-arg">key</span>)</span><br />
 
176
      Get a variables's value, starting at the current scope and going
 
177
upward.</td>
 
178
          <td align="right" valign="top">
 
179
            
 
180
            
 
181
          </td>
 
182
        </tr>
 
183
      </table>
 
184
      
 
185
    </td>
 
186
  </tr>
 
187
<tr>
 
188
    <td width="15%" align="right" valign="top" class="summary">
 
189
      <span class="summary-type">&nbsp;</span>
 
190
    </td><td class="summary">
 
191
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
192
        <tr>
 
193
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__len__" class="summary-sig-name">__len__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
194
      Return the number of distinctly named variables in the context.</td>
 
195
          <td align="right" valign="top">
 
196
            
 
197
            
 
198
          </td>
 
199
        </tr>
 
200
      </table>
 
201
      
 
202
    </td>
 
203
  </tr>
 
204
<tr>
 
205
    <td width="15%" align="right" valign="top" class="summary">
 
206
      <span class="summary-type">&nbsp;</span>
 
207
    </td><td class="summary">
 
208
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
209
        <tr>
 
210
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#__setitem__" class="summary-sig-name">__setitem__</a>(<span class="summary-sig-arg">self</span>,
 
211
        <span class="summary-sig-arg">key</span>,
 
212
        <span class="summary-sig-arg">value</span>)</span><br />
 
213
      Set a variable in the current scope.</td>
 
214
          <td align="right" valign="top">
 
215
            
 
216
            
 
217
          </td>
 
218
        </tr>
 
219
      </table>
 
220
      
 
221
    </td>
 
222
  </tr>
 
223
<tr>
 
224
    <td width="15%" align="right" valign="top" class="summary">
 
225
      <span class="summary-type">&nbsp;</span>
 
226
    </td><td class="summary">
 
227
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
228
        <tr>
 
229
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
 
230
        <span class="summary-sig-arg">key</span>,
 
231
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
 
232
      Get a variable's value, starting at the current scope and going
 
233
upward.</td>
 
234
          <td align="right" valign="top">
 
235
            
 
236
            
 
237
          </td>
 
238
        </tr>
 
239
      </table>
 
240
      
 
241
    </td>
 
242
  </tr>
 
243
<tr>
 
244
    <td width="15%" align="right" valign="top" class="summary">
 
245
      <span class="summary-type">&nbsp;</span>
 
246
    </td><td class="summary">
 
247
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
248
        <tr>
 
249
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#keys" class="summary-sig-name">keys</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
250
      Return the name of all variables in the context.</td>
 
251
          <td align="right" valign="top">
 
252
            
 
253
            
 
254
          </td>
 
255
        </tr>
 
256
      </table>
 
257
      
 
258
    </td>
 
259
  </tr>
 
260
<tr>
 
261
    <td width="15%" align="right" valign="top" class="summary">
 
262
      <span class="summary-type">&nbsp;</span>
 
263
    </td><td class="summary">
 
264
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
265
        <tr>
 
266
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#items" class="summary-sig-name">items</a>(<span class="summary-sig-arg">self</span>)</span><br />
 
267
      Return a list of <tt class="rst-docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> tuples for all variables in the
 
268
context.</td>
 
269
          <td align="right" valign="top">
 
270
            
 
271
            
 
272
          </td>
 
273
        </tr>
 
274
      </table>
 
275
      
 
276
    </td>
 
277
  </tr>
 
278
<tr>
 
279
    <td width="15%" align="right" valign="top" class="summary">
 
280
      <span class="summary-type">&nbsp;</span>
 
281
    </td><td class="summary">
 
282
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
283
        <tr>
 
284
          <td><span class="summary-sig"><a href="genshi.template.base.Context-class.html#push" class="summary-sig-name">push</a>(<span class="summary-sig-arg">self</span>,
 
285
        <span class="summary-sig-arg">data</span>)</span><br />
 
286
      Push a new scope on the stack.</td>
 
287
          <td align="right" valign="top">
 
288
            
 
289
            
 
290
          </td>
 
291
        </tr>
 
292
      </table>
 
293
      
 
294
    </td>
 
295
  </tr>
 
296
<tr>
 
297
    <td width="15%" align="right" valign="top" class="summary">
 
298
      <span class="summary-type">&nbsp;</span>
 
299
    </td><td class="summary">
 
300
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
301
        <tr>
 
302
          <td><span class="summary-sig"><a name="pop"></a><span class="summary-sig-name">pop</span>(<span class="summary-sig-arg">self</span>)</span><br />
 
303
      Pop the top-most scope from the stack.</td>
 
304
          <td align="right" valign="top">
 
305
            
 
306
            
 
307
          </td>
 
308
        </tr>
 
309
      </table>
 
310
      
 
311
    </td>
 
312
  </tr>
 
313
  <tr>
 
314
    <td colspan="2" class="summary">
 
315
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
316
      <code>__delattr__</code>,
 
317
      <code>__getattribute__</code>,
 
318
      <code>__hash__</code>,
 
319
      <code>__new__</code>,
 
320
      <code>__reduce__</code>,
 
321
      <code>__reduce_ex__</code>,
 
322
      <code>__setattr__</code>,
 
323
      <code>__str__</code>
 
324
      </p>
 
325
    </td>
 
326
  </tr>
 
327
</table>
 
328
<!-- ==================== PROPERTIES ==================== -->
 
329
<a name="section-Properties"></a>
 
330
<table class="summary" border="1" cellpadding="3"
 
331
       cellspacing="0" width="100%" bgcolor="white">
 
332
<tr bgcolor="#70b0f0" class="table-header">
 
333
  <td align="left" colspan="2" class="table-header">
 
334
    <span class="table-header">Properties</span></td>
 
335
</tr>
 
336
  <tr>
 
337
    <td colspan="2" class="summary">
 
338
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
339
      <code>__class__</code>
 
340
      </p>
 
341
    </td>
 
342
  </tr>
 
343
</table>
 
344
<!-- ==================== METHOD DETAILS ==================== -->
 
345
<a name="section-MethodDetails"></a>
 
346
<table class="details" border="1" cellpadding="3"
 
347
       cellspacing="0" width="100%" bgcolor="white">
 
348
<tr bgcolor="#70b0f0" class="table-header">
 
349
  <td align="left" colspan="2" class="table-header">
 
350
    <span class="table-header">Method Details</span></td>
 
351
</tr>
 
352
</table>
 
353
<a name="__init__"></a>
 
354
<div>
 
355
<table class="details" border="1" cellpadding="3"
 
356
       cellspacing="0" width="100%" bgcolor="white">
 
357
<tr><td>
 
358
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
359
  <tr valign="top"><td>
 
360
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
361
        <span class="sig-arg">**data</span>)</span>
 
362
    <br /><em class="fname">(Constructor)</em>
 
363
  </h3>
 
364
  </td><td align="right" valign="top"
 
365
    >&nbsp;
 
366
    </td>
 
367
  </table>
 
368
  
 
369
  Initialize the template context with the given keyword arguments as
 
370
data.
 
371
  <dl class="fields">
 
372
    <dt>Overrides:
 
373
      object.__init__
 
374
    </dt>
 
375
  </dl>
 
376
</td></tr></table>
 
377
</div>
 
378
<a name="__repr__"></a>
 
379
<div>
 
380
<table class="details" border="1" cellpadding="3"
 
381
       cellspacing="0" width="100%" bgcolor="white">
 
382
<tr><td>
 
383
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
384
  <tr valign="top"><td>
 
385
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 
386
    <br /><em class="fname">(Representation operator)</em>
 
387
  </h3>
 
388
  </td><td align="right" valign="top"
 
389
    >&nbsp;
 
390
    </td>
 
391
  </table>
 
392
  
 
393
  repr(x)
 
394
  <dl class="fields">
 
395
    <dt>Overrides:
 
396
      object.__repr__
 
397
        <dd><em class="note">(inherited documentation)</em></dd>
 
398
    </dt>
 
399
  </dl>
 
400
</td></tr></table>
 
401
</div>
 
402
<a name="__contains__"></a>
 
403
<div>
 
404
<table class="details" border="1" cellpadding="3"
 
405
       cellspacing="0" width="100%" bgcolor="white">
 
406
<tr><td>
 
407
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
408
  <tr valign="top"><td>
 
409
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__contains__</span>(<span class="sig-arg">self</span>,
 
410
        <span class="sig-arg">key</span>)</span>
 
411
    <br /><em class="fname">(In operator)</em>
 
412
  </h3>
 
413
  </td><td align="right" valign="top"
 
414
    >&nbsp;
 
415
    </td>
 
416
  </table>
 
417
  
 
418
  Return whether a variable exists in any of the scopes.
 
419
  <dl class="fields">
 
420
    <dt>Parameters:</dt>
 
421
    <dd><ul class="nomargin-top">
 
422
        <li><strong class="pname"><code>key</code></strong> - the name of the variable</li>
 
423
    </ul></dd>
 
424
  </dl>
 
425
</td></tr></table>
 
426
</div>
 
427
<a name="__delitem__"></a>
 
428
<div>
 
429
<table class="details" border="1" cellpadding="3"
 
430
       cellspacing="0" width="100%" bgcolor="white">
 
431
<tr><td>
 
432
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
433
  <tr valign="top"><td>
 
434
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__delitem__</span>(<span class="sig-arg">self</span>,
 
435
        <span class="sig-arg">key</span>)</span>
 
436
    <br /><em class="fname">(Index deletion operator)</em>
 
437
  </h3>
 
438
  </td><td align="right" valign="top"
 
439
    >&nbsp;
 
440
    </td>
 
441
  </table>
 
442
  
 
443
  Remove a variable from all scopes.
 
444
  <dl class="fields">
 
445
    <dt>Parameters:</dt>
 
446
    <dd><ul class="nomargin-top">
 
447
        <li><strong class="pname"><code>key</code></strong> - the name of the variable</li>
 
448
    </ul></dd>
 
449
  </dl>
 
450
</td></tr></table>
 
451
</div>
 
452
<a name="__getitem__"></a>
 
453
<div>
 
454
<table class="details" border="1" cellpadding="3"
 
455
       cellspacing="0" width="100%" bgcolor="white">
 
456
<tr><td>
 
457
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
458
  <tr valign="top"><td>
 
459
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
 
460
        <span class="sig-arg">key</span>)</span>
 
461
    <br /><em class="fname">(Indexing operator)</em>
 
462
  </h3>
 
463
  </td><td align="right" valign="top"
 
464
    >&nbsp;
 
465
    </td>
 
466
  </table>
 
467
  
 
468
  Get a variables's value, starting at the current scope and going
 
469
upward.
 
470
  <dl class="fields">
 
471
    <dt>Parameters:</dt>
 
472
    <dd><ul class="nomargin-top">
 
473
        <li><strong class="pname"><code>key</code></strong> - the name of the variable</li>
 
474
    </ul></dd>
 
475
    <dt>Returns:</dt>
 
476
        <dd>the variable value</dd>
 
477
    <dt>Raises:</dt>
 
478
    <dd><ul class="nomargin-top">
 
479
        <li><code><strong class='fraise'>KeyError</strong></code> - if the requested variable wasn't found in any scope</li>
 
480
    </ul></dd>
 
481
  </dl>
 
482
</td></tr></table>
 
483
</div>
 
484
<a name="__len__"></a>
 
485
<div>
 
486
<table class="details" border="1" cellpadding="3"
 
487
       cellspacing="0" width="100%" bgcolor="white">
 
488
<tr><td>
 
489
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
490
  <tr valign="top"><td>
 
491
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__len__</span>(<span class="sig-arg">self</span>)</span>
 
492
    <br /><em class="fname">(Length operator)</em>
 
493
  </h3>
 
494
  </td><td align="right" valign="top"
 
495
    >&nbsp;
 
496
    </td>
 
497
  </table>
 
498
  
 
499
  Return the number of distinctly named variables in the context.
 
500
  <dl class="fields">
 
501
    <dt>Returns:</dt>
 
502
        <dd>the number of variables in the context</dd>
 
503
  </dl>
 
504
</td></tr></table>
 
505
</div>
 
506
<a name="__setitem__"></a>
 
507
<div>
 
508
<table class="details" border="1" cellpadding="3"
 
509
       cellspacing="0" width="100%" bgcolor="white">
 
510
<tr><td>
 
511
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
512
  <tr valign="top"><td>
 
513
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__setitem__</span>(<span class="sig-arg">self</span>,
 
514
        <span class="sig-arg">key</span>,
 
515
        <span class="sig-arg">value</span>)</span>
 
516
    <br /><em class="fname">(Index assignment operator)</em>
 
517
  </h3>
 
518
  </td><td align="right" valign="top"
 
519
    >&nbsp;
 
520
    </td>
 
521
  </table>
 
522
  
 
523
  Set a variable in the current scope.
 
524
  <dl class="fields">
 
525
    <dt>Parameters:</dt>
 
526
    <dd><ul class="nomargin-top">
 
527
        <li><strong class="pname"><code>key</code></strong> - the name of the variable</li>
 
528
        <li><strong class="pname"><code>value</code></strong> - the variable value</li>
 
529
    </ul></dd>
 
530
  </dl>
 
531
</td></tr></table>
 
532
</div>
 
533
<a name="get"></a>
 
534
<div>
 
535
<table class="details" border="1" cellpadding="3"
 
536
       cellspacing="0" width="100%" bgcolor="white">
 
537
<tr><td>
 
538
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
539
  <tr valign="top"><td>
 
540
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
 
541
        <span class="sig-arg">key</span>,
 
542
        <span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>
 
543
  </h3>
 
544
  </td><td align="right" valign="top"
 
545
    >&nbsp;
 
546
    </td>
 
547
  </table>
 
548
  
 
549
  Get a variable's value, starting at the current scope and going
 
550
upward.
 
551
  <dl class="fields">
 
552
    <dt>Parameters:</dt>
 
553
    <dd><ul class="nomargin-top">
 
554
        <li><strong class="pname"><code>key</code></strong> - the name of the variable</li>
 
555
        <li><strong class="pname"><code>default</code></strong> - the default value to return when the variable is not
 
556
found</li>
 
557
    </ul></dd>
 
558
  </dl>
 
559
</td></tr></table>
 
560
</div>
 
561
<a name="keys"></a>
 
562
<div>
 
563
<table class="details" border="1" cellpadding="3"
 
564
       cellspacing="0" width="100%" bgcolor="white">
 
565
<tr><td>
 
566
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
567
  <tr valign="top"><td>
 
568
  <h3 class="epydoc"><span class="sig"><span class="sig-name">keys</span>(<span class="sig-arg">self</span>)</span>
 
569
  </h3>
 
570
  </td><td align="right" valign="top"
 
571
    >&nbsp;
 
572
    </td>
 
573
  </table>
 
574
  
 
575
  Return the name of all variables in the context.
 
576
  <dl class="fields">
 
577
    <dt>Returns:</dt>
 
578
        <dd>a list of variable names</dd>
 
579
  </dl>
 
580
</td></tr></table>
 
581
</div>
 
582
<a name="items"></a>
 
583
<div>
 
584
<table class="details" border="1" cellpadding="3"
 
585
       cellspacing="0" width="100%" bgcolor="white">
 
586
<tr><td>
 
587
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
588
  <tr valign="top"><td>
 
589
  <h3 class="epydoc"><span class="sig"><span class="sig-name">items</span>(<span class="sig-arg">self</span>)</span>
 
590
  </h3>
 
591
  </td><td align="right" valign="top"
 
592
    >&nbsp;
 
593
    </td>
 
594
  </table>
 
595
  
 
596
  Return a list of <tt class="rst-rst-docutils literal rst-docutils literal"><span class="pre">(name,</span> <span class="pre">value)</span></tt> tuples for all variables in the
 
597
context.
 
598
  <dl class="fields">
 
599
    <dt>Returns:</dt>
 
600
        <dd>a list of variables</dd>
 
601
  </dl>
 
602
</td></tr></table>
 
603
</div>
 
604
<a name="push"></a>
 
605
<div>
 
606
<table class="details" border="1" cellpadding="3"
 
607
       cellspacing="0" width="100%" bgcolor="white">
 
608
<tr><td>
 
609
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
610
  <tr valign="top"><td>
 
611
  <h3 class="epydoc"><span class="sig"><span class="sig-name">push</span>(<span class="sig-arg">self</span>,
 
612
        <span class="sig-arg">data</span>)</span>
 
613
  </h3>
 
614
  </td><td align="right" valign="top"
 
615
    >&nbsp;
 
616
    </td>
 
617
  </table>
 
618
  
 
619
  Push a new scope on the stack.
 
620
  <dl class="fields">
 
621
    <dt>Parameters:</dt>
 
622
    <dd><ul class="nomargin-top">
 
623
        <li><strong class="pname"><code>data</code></strong> - the data dictionary to push on the context stack.</li>
 
624
    </ul></dd>
 
625
  </dl>
 
626
</td></tr></table>
 
627
</div>
 
628
<br />
 
629
<!-- ==================== NAVIGATION BAR ==================== -->
 
630
<table class="navbar" border="0" width="100%" cellpadding="0"
 
631
       bgcolor="#a0c0ff" cellspacing="0">
 
632
  <tr valign="middle">
 
633
  <!-- Home link -->
 
634
      <th>&nbsp;&nbsp;&nbsp;<a
 
635
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
636
 
 
637
  <!-- Tree link -->
 
638
      <th>&nbsp;&nbsp;&nbsp;<a
 
639
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
640
 
 
641
  <!-- Index link -->
 
642
      <th>&nbsp;&nbsp;&nbsp;<a
 
643
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
644
 
 
645
  <!-- Help link -->
 
646
      <th>&nbsp;&nbsp;&nbsp;<a
 
647
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
648
 
 
649
  <!-- Project homepage -->
 
650
      <th class="navbar" align="right" width="100%">
 
651
        <table border="0" cellpadding="0" cellspacing="0">
 
652
          <tr><th class="navbar" align="center"
 
653
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
654
          </tr></table></th>
 
655
  </tr>
 
656
</table>
 
657
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
658
  <tr>
 
659
    <td align="left" class="footer">
 
660
    Generated by Epydoc 3.0beta1 on Mon Apr 16 16:02:14 2007
 
661
    </td>
 
662
    <td align="right" class="footer">
 
663
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
664
    </td>
 
665
  </tr>
 
666
</table>
 
667
 
 
668
<script type="text/javascript">
 
669
  <!--
 
670
  // Private objects are initially displayed (because if
 
671
  // javascript is turned off then we want them to be
 
672
  // visible); but by default, we want to hide them.  So hide
 
673
  // them unless we have a cookie that says to show them.
 
674
  checkCookie()
 
675
  // -->
 
676
</script>
 
677
  
 
678
</body>
 
679
</html>