Debian Codegraph @

doc/scripting/lib.scripting.Store-class.html

raw
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>lib.scripting.Store</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="lib.scripting-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 <th class="navbar" width="100%"></th>
34 </tr>
35 </table>
36 <table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 Package&nbsp;lib ::
41 <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
42 Class&nbsp;Store
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="lib.scripting.Store-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57 </table>
58 <!-- ==================== CLASS DESCRIPTION ==================== -->
59 <h1 class="epydoc">Class Store</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Store">source&nbsp;code</a></span></p>
60 <pre class="base-tree">
61 object --+
62 |
63 dict --+
64 |
65 <strong class="uidshort">Store</strong>
66 </pre>
67
68 <hr />
69 <p>Allows persistent storage of values between invocations of the
70 script.</p>
71
72 <!-- ==================== INSTANCE METHODS ==================== -->
73 <a name="section-InstanceMethods"></a>
74 <table class="summary" border="1" cellpadding="3"
75 cellspacing="0" width="100%" bgcolor="white">
76 <tr bgcolor="#70b0f0" class="table-header">
77 <td colspan="2" class="table-header">
78 <table border="0" cellpadding="0" cellspacing="0" width="100%">
79 <tr valign="top">
80 <td align="left"><span class="table-header">Instance Methods</span></td>
81 <td align="right" valign="top"
82 ><span class="options">[<a href="#section-InstanceMethods"
83 class="privatelink" onclick="toggle_private();"
84 >hide private</a>]</span></td>
85 </tr>
86 </table>
87 </td>
88 </tr>
89 <tr>
90 <td width="15%" align="right" valign="top" class="summary">
91 <span class="summary-type">&nbsp;</span>
92 </td><td class="summary">
93 <table width="100%" cellpadding="0" cellspacing="0" border="0">
94 <tr>
95 <td><span class="summary-sig"><a href="lib.scripting.Store-class.html#set_value" class="summary-sig-name">set_value</a>(<span class="summary-sig-arg">self</span>,
96 <span class="summary-sig-arg">key</span>,
97 <span class="summary-sig-arg">value</span>)</span><br />
98 Store a value</td>
99 <td align="right" valign="top">
100 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.set_value">source&nbsp;code</a></span>
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108 <tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <td><span class="summary-sig"><a href="lib.scripting.Store-class.html#get_value" class="summary-sig-name">get_value</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">key</span>)</span><br />
116 Get a value</td>
117 <td align="right" valign="top">
118 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.get_value">source&nbsp;code</a></span>
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="lib.scripting.Store-class.html#remove_value" class="summary-sig-name">remove_value</a>(<span class="summary-sig-arg">self</span>,
133 <span class="summary-sig-arg">key</span>)</span><br />
134 Remove a value</td>
135 <td align="right" valign="top">
136 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.remove_value">source&nbsp;code</a></span>
137
138 </td>
139 </tr>
140 </table>
141
142 </td>
143 </tr>
144 <tr>
145 <td width="15%" align="right" valign="top" class="summary">
146 <span class="summary-type">&nbsp;</span>
147 </td><td class="summary">
148 <table width="100%" cellpadding="0" cellspacing="0" border="0">
149 <tr>
150 <td><span class="summary-sig"><a href="lib.scripting.Store-class.html#set_global_value" class="summary-sig-name">set_global_value</a>(<span class="summary-sig-arg">self</span>,
151 <span class="summary-sig-arg">key</span>,
152 <span class="summary-sig-arg">value</span>)</span><br />
153 Store a global value</td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.set_global_value">source&nbsp;code</a></span>
156
157 </td>
158 </tr>
159 </table>
160
161 </td>
162 </tr>
163 <tr>
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type">&nbsp;</span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
168 <tr>
169 <td><span class="summary-sig"><a href="lib.scripting.Store-class.html#get_global_value" class="summary-sig-name">get_global_value</a>(<span class="summary-sig-arg">self</span>,
170 <span class="summary-sig-arg">key</span>)</span><br />
171 Get a global value</td>
172 <td align="right" valign="top">
173 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.get_global_value">source&nbsp;code</a></span>
174
175 </td>
176 </tr>
177 </table>
178
179 </td>
180 </tr>
181 <tr>
182 <td width="15%" align="right" valign="top" class="summary">
183 <span class="summary-type">&nbsp;</span>
184 </td><td class="summary">
185 <table width="100%" cellpadding="0" cellspacing="0" border="0">
186 <tr>
187 <td><span class="summary-sig"><a href="lib.scripting.Store-class.html#remove_global_value" class="summary-sig-name">remove_global_value</a>(<span class="summary-sig-arg">self</span>,
188 <span class="summary-sig-arg">key</span>)</span><br />
189 Remove a global value</td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="lib.scripting-pysrc.html#Store.remove_global_value">source&nbsp;code</a></span>
192
193 </td>
194 </tr>
195 </table>
196
197 </td>
198 </tr>
199 <tr>
200 <td colspan="2" class="summary">
201 <p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
202 <code>__cmp__</code>,
203 <code>__contains__</code>,
204 <code>__delitem__</code>,
205 <code>__eq__</code>,
206 <code>__ge__</code>,
207 <code>__getattribute__</code>,
208 <code>__getitem__</code>,
209 <code>__gt__</code>,
210 <code>__init__</code>,
211 <code>__iter__</code>,
212 <code>__le__</code>,
213 <code>__len__</code>,
214 <code>__lt__</code>,
215 <code>__ne__</code>,
216 <code>__new__</code>,
217 <code>__repr__</code>,
218 <code>__setitem__</code>,
219 <code>__sizeof__</code>,
220 <code>clear</code>,
221 <code>copy</code>,
222 <code>fromkeys</code>,
223 <code>get</code>,
224 <code>has_key</code>,
225 <code>items</code>,
226 <code>iteritems</code>,
227 <code>iterkeys</code>,
228 <code>itervalues</code>,
229 <code>keys</code>,
230 <code>pop</code>,
231 <code>popitem</code>,
232 <code>setdefault</code>,
233 <code>update</code>,
234 <code>values</code>,
235 <code>viewitems</code>,
236 <code>viewkeys</code>,
237 <code>viewvalues</code>
238 </p>
239 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
240 <code>__delattr__</code>,
241 <code>__format__</code>,
242 <code>__reduce__</code>,
243 <code>__reduce_ex__</code>,
244 <code>__setattr__</code>,
245 <code>__str__</code>,
246 <code>__subclasshook__</code>
247 </p>
248 </td>
249 </tr>
250 </table>
251 <!-- ==================== CLASS VARIABLES ==================== -->
252 <a name="section-ClassVariables"></a>
253 <table class="summary" border="1" cellpadding="3"
254 cellspacing="0" width="100%" bgcolor="white">
255 <tr bgcolor="#70b0f0" class="table-header">
256 <td colspan="2" class="table-header">
257 <table border="0" cellpadding="0" cellspacing="0" width="100%">
258 <tr valign="top">
259 <td align="left"><span class="table-header">Class Variables</span></td>
260 <td align="right" valign="top"
261 ><span class="options">[<a href="#section-ClassVariables"
262 class="privatelink" onclick="toggle_private();"
263 >hide private</a>]</span></td>
264 </tr>
265 </table>
266 </td>
267 </tr>
268 <tr>
269 <td colspan="2" class="summary">
270 <p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
271 <code>__hash__</code>
272 </p>
273 </td>
274 </tr>
275 </table>
276 <!-- ==================== PROPERTIES ==================== -->
277 <a name="section-Properties"></a>
278 <table class="summary" border="1" cellpadding="3"
279 cellspacing="0" width="100%" bgcolor="white">
280 <tr bgcolor="#70b0f0" class="table-header">
281 <td colspan="2" class="table-header">
282 <table border="0" cellpadding="0" cellspacing="0" width="100%">
283 <tr valign="top">
284 <td align="left"><span class="table-header">Properties</span></td>
285 <td align="right" valign="top"
286 ><span class="options">[<a href="#section-Properties"
287 class="privatelink" onclick="toggle_private();"
288 >hide private</a>]</span></td>
289 </tr>
290 </table>
291 </td>
292 </tr>
293 <tr>
294 <td colspan="2" class="summary">
295 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
296 <code>__class__</code>
297 </p>
298 </td>
299 </tr>
300 </table>
301 <!-- ==================== METHOD DETAILS ==================== -->
302 <a name="section-MethodDetails"></a>
303 <table class="details" border="1" cellpadding="3"
304 cellspacing="0" width="100%" bgcolor="white">
305 <tr bgcolor="#70b0f0" class="table-header">
306 <td colspan="2" class="table-header">
307 <table border="0" cellpadding="0" cellspacing="0" width="100%">
308 <tr valign="top">
309 <td align="left"><span class="table-header">Method Details</span></td>
310 <td align="right" valign="top"
311 ><span class="options">[<a href="#section-MethodDetails"
312 class="privatelink" onclick="toggle_private();"
313 >hide private</a>]</span></td>
314 </tr>
315 </table>
316 </td>
317 </tr>
318 </table>
319 <a name="set_value"></a>
320 <div>
321 <table class="details" border="1" cellpadding="3"
322 cellspacing="0" width="100%" bgcolor="white">
323 <tr><td>
324 <table width="100%" cellpadding="0" cellspacing="0" border="0">
325 <tr valign="top"><td>
326 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_value</span>(<span class="sig-arg">self</span>,
327 <span class="sig-arg">key</span>,
328 <span class="sig-arg">value</span>)</span>
329 </h3>
330 </td><td align="right" valign="top"
331 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.set_value">source&nbsp;code</a></span>&nbsp;
332 </td>
333 </tr></table>
334
335 <p>Store a value</p>
336 <p>Usage: <code>store.set_value(key, value)</code></p>
337 <dl class="fields">
338 </dl>
339 </td></tr></table>
340 </div>
341 <a name="get_value"></a>
342 <div>
343 <table class="details" border="1" cellpadding="3"
344 cellspacing="0" width="100%" bgcolor="white">
345 <tr><td>
346 <table width="100%" cellpadding="0" cellspacing="0" border="0">
347 <tr valign="top"><td>
348 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value</span>(<span class="sig-arg">self</span>,
349 <span class="sig-arg">key</span>)</span>
350 </h3>
351 </td><td align="right" valign="top"
352 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.get_value">source&nbsp;code</a></span>&nbsp;
353 </td>
354 </tr></table>
355
356 <p>Get a value</p>
357 <p>Usage: <code>store.get_value(key)</code></p>
358 <dl class="fields">
359 </dl>
360 </td></tr></table>
361 </div>
362 <a name="remove_value"></a>
363 <div>
364 <table class="details" border="1" cellpadding="3"
365 cellspacing="0" width="100%" bgcolor="white">
366 <tr><td>
367 <table width="100%" cellpadding="0" cellspacing="0" border="0">
368 <tr valign="top"><td>
369 <h3 class="epydoc"><span class="sig"><span class="sig-name">remove_value</span>(<span class="sig-arg">self</span>,
370 <span class="sig-arg">key</span>)</span>
371 </h3>
372 </td><td align="right" valign="top"
373 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.remove_value">source&nbsp;code</a></span>&nbsp;
374 </td>
375 </tr></table>
376
377 <p>Remove a value</p>
378 <p>Usage: <code>store.remove_value(key)</code></p>
379 <dl class="fields">
380 </dl>
381 </td></tr></table>
382 </div>
383 <a name="set_global_value"></a>
384 <div>
385 <table class="details" border="1" cellpadding="3"
386 cellspacing="0" width="100%" bgcolor="white">
387 <tr><td>
388 <table width="100%" cellpadding="0" cellspacing="0" border="0">
389 <tr valign="top"><td>
390 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_global_value</span>(<span class="sig-arg">self</span>,
391 <span class="sig-arg">key</span>,
392 <span class="sig-arg">value</span>)</span>
393 </h3>
394 </td><td align="right" valign="top"
395 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.set_global_value">source&nbsp;code</a></span>&nbsp;
396 </td>
397 </tr></table>
398
399 <p>Store a global value</p>
400 <p>Usage: <code>store.set_global_value(key, value)</code></p>
401 <p>The value stored with this method will be available to all
402 scripts.</p>
403 <dl class="fields">
404 </dl>
405 </td></tr></table>
406 </div>
407 <a name="get_global_value"></a>
408 <div>
409 <table class="details" border="1" cellpadding="3"
410 cellspacing="0" width="100%" bgcolor="white">
411 <tr><td>
412 <table width="100%" cellpadding="0" cellspacing="0" border="0">
413 <tr valign="top"><td>
414 <h3 class="epydoc"><span class="sig"><span class="sig-name">get_global_value</span>(<span class="sig-arg">self</span>,
415 <span class="sig-arg">key</span>)</span>
416 </h3>
417 </td><td align="right" valign="top"
418 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.get_global_value">source&nbsp;code</a></span>&nbsp;
419 </td>
420 </tr></table>
421
422 <p>Get a global value</p>
423 <p>Usage: <code>store.get_global_value(key)</code></p>
424 <dl class="fields">
425 </dl>
426 </td></tr></table>
427 </div>
428 <a name="remove_global_value"></a>
429 <div>
430 <table class="details" border="1" cellpadding="3"
431 cellspacing="0" width="100%" bgcolor="white">
432 <tr><td>
433 <table width="100%" cellpadding="0" cellspacing="0" border="0">
434 <tr valign="top"><td>
435 <h3 class="epydoc"><span class="sig"><span class="sig-name">remove_global_value</span>(<span class="sig-arg">self</span>,
436 <span class="sig-arg">key</span>)</span>
437 </h3>
438 </td><td align="right" valign="top"
439 ><span class="codelink"><a href="lib.scripting-pysrc.html#Store.remove_global_value">source&nbsp;code</a></span>&nbsp;
440 </td>
441 </tr></table>
442
443 <p>Remove a global value</p>
444 <p>Usage: <code>store.remove_global_value(key)</code></p>
445 <dl class="fields">
446 </dl>
447 </td></tr></table>
448 </div>
449 <br />
450 <!-- ==================== NAVIGATION BAR ==================== -->
451 <table class="navbar" border="0" width="100%" cellpadding="0"
452 bgcolor="#a0c0ff" cellspacing="0">
453 <tr valign="middle">
454 <!-- Home link -->
455 <th>&nbsp;&nbsp;&nbsp;<a
456 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
457
458 <!-- Tree link -->
459 <th>&nbsp;&nbsp;&nbsp;<a
460 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
461
462 <!-- Index link -->
463 <th>&nbsp;&nbsp;&nbsp;<a
464 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
465
466 <!-- Help link -->
467 <th>&nbsp;&nbsp;&nbsp;<a
468 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
469
470 <th class="navbar" width="100%"></th>
471 </tr>
472 </table>
473 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
474 <tr>
475 <td align="left" class="footer">
476 Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
477 </td>
478 <td align="right" class="footer">
479 <a target="mainFrame" href="http://epydoc.sourceforge.net"
480 >http://epydoc.sourceforge.net</a>
481 </td>
482 </tr>
483 </table>
484
485 <script type="text/javascript">
486 <!--
487 // Private objects are initially displayed (because if
488 // javascript is turned off then we want them to be
489 // visible); but by default, we want to hide them. So hide
490 // them unless we have a cookie that says to show them.
491 checkCookie();
492 // -->
493 </script>
494 </body>
495 </html>