blob: d8d623c589607f04fbd5bf2edda9f9ba2e0781ef [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -04001<?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>apiclient.http.MediaFileUpload</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
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 <a href="apiclient.http-module.html">Module&nbsp;http</a> ::
39 Class&nbsp;MediaFileUpload
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.http.MediaFileUpload-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_17" name="uml_class_diagram_for_apiclien_17">
59<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#__init__" title="Constructor." alt="" coords="17,111,481,129"/>
60<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#mimetype" title="apiclient.http.MediaFileUpload.mimetype" alt="" coords="17,129,481,148"/>
61<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#size" title="apiclient.http.MediaFileUpload.size" alt="" coords="17,148,481,167"/>
62<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#chunksize" title="apiclient.http.MediaFileUpload.chunksize" alt="" coords="17,167,481,185"/>
63<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#resumable" title="apiclient.http.MediaFileUpload.resumable" alt="" coords="17,185,481,204"/>
64<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,204,481,223"/>
65<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="17,223,481,241"/>
66<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#from_json" title="apiclient.http.MediaFileUpload.from_json" alt="" coords="17,241,481,260"/>
67<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="16,85,483,261"/>
68<area shape="rect" href="apiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="183,36,316,55"/>
69<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="181,11,317,56"/>
70</map>
71 <img src="uml_class_diagram_for_apiclien_17.gif" alt='' usemap="#uml_class_diagram_for_apiclien_17" ismap="ismap" class="graph-without-title" />
72</center>
73</center>
74<hr />
75<pre class="literalblock">
76A MediaUpload for a file.
77
78Construct a MediaFileUpload and pass as the media_body parameter of the
79method. For example, if we had a service that allowed uploading images:
80
81
82 media = MediaFileUpload('smiley.png', mimetype='image/png', chunksize=1000,
83 resumable=True)
84 service.objects().insert(
85 bucket=buckets['items'][0]['id'],
86 name='smiley.png',
87 media_body=media).execute()
88
89</pre>
90
91<!-- ==================== INSTANCE METHODS ==================== -->
92<a name="section-InstanceMethods"></a>
93<table class="summary" border="1" cellpadding="3"
94 cellspacing="0" width="100%" bgcolor="white">
95<tr bgcolor="#70b0f0" class="table-header">
96 <td colspan="2" class="table-header">
97 <table border="0" cellpadding="0" cellspacing="0" width="100%">
98 <tr valign="top">
99 <td align="left"><span class="table-header">Instance Methods</span></td>
100 <td align="right" valign="top"
101 ><span class="options">[<a href="#section-InstanceMethods"
102 class="privatelink" onclick="toggle_private();"
103 >hide private</a>]</span></td>
104 </tr>
105 </table>
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="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">filename</span>,
116 <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>,
117 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">262144</span>,
118 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
119 Constructor.</td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>
122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
129<tr>
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">&nbsp;</span>
132 </td><td class="summary">
133 <table width="100%" cellpadding="0" cellspacing="0" border="0">
134 <tr>
135 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span></td>
136 <td align="right" valign="top">
137 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source&nbsp;code</a></span>
138
139 </td>
140 </tr>
141 </table>
142
143 </td>
144 </tr>
145<tr>
146 <td width="15%" align="right" valign="top" class="summary">
147 <span class="summary-type">&nbsp;</span>
148 </td><td class="summary">
149 <table width="100%" cellpadding="0" cellspacing="0" border="0">
150 <tr>
151 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span></td>
152 <td align="right" valign="top">
153 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source&nbsp;code</a></span>
154
155 </td>
156 </tr>
157 </table>
158
159 </td>
160 </tr>
161<tr>
162 <td width="15%" align="right" valign="top" class="summary">
163 <span class="summary-type">&nbsp;</span>
164 </td><td class="summary">
165 <table width="100%" cellpadding="0" cellspacing="0" border="0">
166 <tr>
167 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span></td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span></td>
184 <td align="right" valign="top">
185 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source&nbsp;code</a></span>
186
187 </td>
188 </tr>
189 </table>
190
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 <table width="100%" cellpadding="0" cellspacing="0" border="0">
198 <tr>
199 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
200 <span class="summary-sig-arg">begin</span>,
201 <span class="summary-sig-arg">length</span>)</span><br />
202 Get bytes from the media.</td>
203 <td align="right" valign="top">
204 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source&nbsp;code</a></span>
205
206 </td>
207 </tr>
208 </table>
209
210 </td>
211 </tr>
212<tr>
213 <td width="15%" align="right" valign="top" class="summary">
214 <span class="summary-type">&nbsp;</span>
215 </td><td class="summary">
216 <table width="100%" cellpadding="0" cellspacing="0" border="0">
217 <tr>
218 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
219 Creating a JSON representation of an instance of Credentials.</td>
220 <td align="right" valign="top">
221 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>
222
223 </td>
224 </tr>
225 </table>
226
227 </td>
228 </tr>
229 <tr>
230 <td colspan="2" class="summary">
231 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
232 <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
233 </p></div>
234 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
235 <code>__delattr__</code>,
236 <code>__format__</code>,
237 <code>__getattribute__</code>,
238 <code>__hash__</code>,
239 <code>__new__</code>,
240 <code>__reduce__</code>,
241 <code>__reduce_ex__</code>,
242 <code>__repr__</code>,
243 <code>__setattr__</code>,
244 <code>__sizeof__</code>,
245 <code>__str__</code>,
246 <code>__subclasshook__</code>
247 </p>
248 </td>
249 </tr>
250</table>
251<!-- ==================== CLASS METHODS ==================== -->
252<a name="section-ClassMethods"></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 Methods</span></td>
260 <td align="right" valign="top"
261 ><span class="options">[<a href="#section-ClassMethods"
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><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
271 <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
272 </p>
273 </td>
274 </tr>
275</table>
276<!-- ==================== STATIC METHODS ==================== -->
277<a name="section-StaticMethods"></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">Static Methods</span></td>
285 <td align="right" valign="top"
286 ><span class="options">[<a href="#section-StaticMethods"
287 class="privatelink" onclick="toggle_private();"
288 >hide private</a>]</span></td>
289 </tr>
290 </table>
291 </td>
292</tr>
293<tr>
294 <td width="15%" align="right" valign="top" class="summary">
295 <span class="summary-type">&nbsp;</span>
296 </td><td class="summary">
297 <table width="100%" cellpadding="0" cellspacing="0" border="0">
298 <tr>
299 <td><span class="summary-sig"><a name="from_json"></a><span class="summary-sig-name">from_json</span>(<span class="summary-sig-arg">s</span>)</span></td>
300 <td align="right" valign="top">
301 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.from_json">source&nbsp;code</a></span>
302
303 </td>
304 </tr>
305 </table>
306
307 </td>
308 </tr>
309</table>
310<!-- ==================== PROPERTIES ==================== -->
311<a name="section-Properties"></a>
312<table class="summary" border="1" cellpadding="3"
313 cellspacing="0" width="100%" bgcolor="white">
314<tr bgcolor="#70b0f0" class="table-header">
315 <td colspan="2" class="table-header">
316 <table border="0" cellpadding="0" cellspacing="0" width="100%">
317 <tr valign="top">
318 <td align="left"><span class="table-header">Properties</span></td>
319 <td align="right" valign="top"
320 ><span class="options">[<a href="#section-Properties"
321 class="privatelink" onclick="toggle_private();"
322 >hide private</a>]</span></td>
323 </tr>
324 </table>
325 </td>
326</tr>
327 <tr>
328 <td colspan="2" class="summary">
329 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
330 <code>__class__</code>
331 </p>
332 </td>
333 </tr>
334</table>
335<!-- ==================== METHOD DETAILS ==================== -->
336<a name="section-MethodDetails"></a>
337<table class="details" border="1" cellpadding="3"
338 cellspacing="0" width="100%" bgcolor="white">
339<tr bgcolor="#70b0f0" class="table-header">
340 <td colspan="2" class="table-header">
341 <table border="0" cellpadding="0" cellspacing="0" width="100%">
342 <tr valign="top">
343 <td align="left"><span class="table-header">Method Details</span></td>
344 <td align="right" valign="top"
345 ><span class="options">[<a href="#section-MethodDetails"
346 class="privatelink" onclick="toggle_private();"
347 >hide private</a>]</span></td>
348 </tr>
349 </table>
350 </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">filename</span>,
362 <span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>,
363 <span class="sig-arg">chunksize</span>=<span class="sig-default">262144</span>,
364 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
365 <br /><em class="fname">(Constructor)</em>
366 </h3>
367 </td><td align="right" valign="top"
368 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>&nbsp;
369 </td>
370 </tr></table>
371
372 <pre class="literalblock">
373Constructor.
374
375Args:
376 filename: string, Name of the file.
377 mimetype: string, Mime-type of the file. If None then a mime-type will be
378 guessed from the file extension.
379 chunksize: int, File will be uploaded in chunks of this many bytes. Only
380 used if resumable=True.
381 resumable: bool, True if this is a resumable upload. False means upload
382 in a single request.
383
384</pre>
385 <dl class="fields">
386 <dt>Overrides:
387 object.__init__
388 </dt>
389 </dl>
390</td></tr></table>
391</div>
392<a name="mimetype"></a>
393<div>
394<table class="details" border="1" cellpadding="3"
395 cellspacing="0" width="100%" bgcolor="white">
396<tr><td>
397 <table width="100%" cellpadding="0" cellspacing="0" border="0">
398 <tr valign="top"><td>
399 <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
400 </h3>
401 </td><td align="right" valign="top"
402 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source&nbsp;code</a></span>&nbsp;
403 </td>
404 </tr></table>
405
406
407 <dl class="fields">
408 <dt>Overrides:
409 <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
410 </dt>
411 </dl>
412</td></tr></table>
413</div>
414<a name="size"></a>
415<div>
416<table class="details" border="1" cellpadding="3"
417 cellspacing="0" width="100%" bgcolor="white">
418<tr><td>
419 <table width="100%" cellpadding="0" cellspacing="0" border="0">
420 <tr valign="top"><td>
421 <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
422 </h3>
423 </td><td align="right" valign="top"
424 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source&nbsp;code</a></span>&nbsp;
425 </td>
426 </tr></table>
427
428
429 <dl class="fields">
430 <dt>Overrides:
431 <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
432 </dt>
433 </dl>
434</td></tr></table>
435</div>
436<a name="chunksize"></a>
437<div>
438<table class="details" border="1" cellpadding="3"
439 cellspacing="0" width="100%" bgcolor="white">
440<tr><td>
441 <table width="100%" cellpadding="0" cellspacing="0" border="0">
442 <tr valign="top"><td>
443 <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
444 </h3>
445 </td><td align="right" valign="top"
446 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source&nbsp;code</a></span>&nbsp;
447 </td>
448 </tr></table>
449
450
451 <dl class="fields">
452 <dt>Overrides:
453 <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
454 </dt>
455 </dl>
456</td></tr></table>
457</div>
458<a name="resumable"></a>
459<div>
460<table class="details" border="1" cellpadding="3"
461 cellspacing="0" width="100%" bgcolor="white">
462<tr><td>
463 <table width="100%" cellpadding="0" cellspacing="0" border="0">
464 <tr valign="top"><td>
465 <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
466 </h3>
467 </td><td align="right" valign="top"
468 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source&nbsp;code</a></span>&nbsp;
469 </td>
470 </tr></table>
471
472
473 <dl class="fields">
474 <dt>Overrides:
475 <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
476 </dt>
477 </dl>
478</td></tr></table>
479</div>
480<a name="getbytes"></a>
481<div>
482<table class="details" border="1" cellpadding="3"
483 cellspacing="0" width="100%" bgcolor="white">
484<tr><td>
485 <table width="100%" cellpadding="0" cellspacing="0" border="0">
486 <tr valign="top"><td>
487 <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
488 <span class="sig-arg">begin</span>,
489 <span class="sig-arg">length</span>)</span>
490 </h3>
491 </td><td align="right" valign="top"
492 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source&nbsp;code</a></span>&nbsp;
493 </td>
494 </tr></table>
495
496 <pre class="literalblock">
497Get bytes from the media.
498
499Args:
500 begin: int, offset from beginning of file.
501 length: int, number of bytes to read, starting at begin.
502
503Returns:
504 A string of bytes read. May be shorted than length if EOF was reached
505 first.
506
507</pre>
508 <dl class="fields">
509 <dt>Overrides:
510 <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
511 </dt>
512 </dl>
513</td></tr></table>
514</div>
515<a name="to_json"></a>
516<div>
517<table class="details" border="1" cellpadding="3"
518 cellspacing="0" width="100%" bgcolor="white">
519<tr><td>
520 <table width="100%" cellpadding="0" cellspacing="0" border="0">
521 <tr valign="top"><td>
522 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
523 </h3>
524 </td><td align="right" valign="top"
525 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>&nbsp;
526 </td>
527 </tr></table>
528
529 <pre class="literalblock">
530Creating a JSON representation of an instance of Credentials.
531
532Returns:
533 string, a JSON representation of this instance, suitable to pass to
534 from_json().
535
536</pre>
537 <dl class="fields">
538 <dt>Overrides:
539 <a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
540 </dt>
541 </dl>
542</td></tr></table>
543</div>
544<br />
545<!-- ==================== NAVIGATION BAR ==================== -->
546<table class="navbar" border="0" width="100%" cellpadding="0"
547 bgcolor="#a0c0ff" cellspacing="0">
548 <tr valign="middle">
549
550 <!-- Tree link -->
551 <th>&nbsp;&nbsp;&nbsp;<a
552 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
553
554 <!-- Index link -->
555 <th>&nbsp;&nbsp;&nbsp;<a
556 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
557
558 <!-- Help link -->
559 <th>&nbsp;&nbsp;&nbsp;<a
560 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
561
562 <th class="navbar" width="100%"></th>
563 </tr>
564</table>
565<table border="0" cellpadding="0" cellspacing="0" width="100%%">
566 <tr>
567 <td align="left" class="footer">
568 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:06 2012
569 </td>
570 <td align="right" class="footer">
571 <a target="mainFrame" href="http://epydoc.sourceforge.net"
572 >http://epydoc.sourceforge.net</a>
573 </td>
574 </tr>
575</table>
576
577<script type="text/javascript">
578 <!--
579 // Private objects are initially displayed (because if
580 // javascript is turned off then we want them to be
581 // visible); but by default, we want to hide them. So hide
582 // them unless we have a cookie that says to show them.
583 checkCookie();
584 // -->
585</script>
586</body>
587</html>