blob: 852dee511bcd362cbb128e358d17986d073dc678 [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.discovery</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 Module&nbsp;discovery
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="apiclient.discovery-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Client for discovery based APIs
58
59A client library for Google's discovery based APIs.
60
61</pre>
62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 jcgregorio@google.com (Joe Gregorio)
66 </p>
Joe Gregorio52a5c532013-01-24 16:19:07 -050067</div><!-- ==================== CLASSES ==================== -->
68<a name="section-Classes"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Classes</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Classes"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <a href="apiclient.discovery.Resource-class.html" class="summary-name">Resource</a><br />
89 A class for interacting with a resource.
90 </td>
91 </tr>
92</table>
93<!-- ==================== FUNCTIONS ==================== -->
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040094<a name="section-Functions"></a>
95<table class="summary" border="1" cellpadding="3"
96 cellspacing="0" width="100%" bgcolor="white">
97<tr bgcolor="#70b0f0" class="table-header">
98 <td colspan="2" class="table-header">
99 <table border="0" cellpadding="0" cellspacing="0" width="100%">
100 <tr valign="top">
101 <td align="left"><span class="table-header">Functions</span></td>
102 <td align="right" valign="top"
103 ><span class="options">[<a href="#section-Functions"
104 class="privatelink" onclick="toggle_private();"
105 >hide private</a>]</span></td>
106 </tr>
107 </table>
108 </td>
109</tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400110<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400111 <td width="15%" align="right" valign="top" class="summary">
112 <span class="summary-type">&nbsp;</span>
113 </td><td class="summary">
114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
115 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400116 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
Joe Gregorio66212032012-06-14 09:10:14 -0400117 Fix method names to avoid reserved word conflicts.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400118 <td align="right" valign="top">
Joe Gregorio66212032012-06-14 09:10:14 -0400119 <span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400120
121 </td>
122 </tr>
123 </table>
124
125 </td>
126 </tr>
127<tr class="private">
128 <td width="15%" align="right" valign="top" class="summary">
129 <span class="summary-type">&nbsp;</span>
130 </td><td class="summary">
131 <table width="100%" cellpadding="0" cellspacing="0" border="0">
132 <tr>
133 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_add_query_parameter" class="summary-sig-name" onclick="show_private();">_add_query_parameter</a>(<span class="summary-sig-arg">url</span>,
134 <span class="summary-sig-arg">name</span>,
135 <span class="summary-sig-arg">value</span>)</span><br />
136 Adds a query parameter to a url.</td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400146<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400152 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400153 Converts key names into parameter names.</td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">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>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400169 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
170 <span class="summary-sig-arg">version</span>,
171 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
172 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
173 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
174 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
175 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400176 Construct a Resource for interacting with an API.</td>
177 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400178 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
179
180 </td>
181 </tr>
182 </table>
183
184 </td>
185 </tr>
186<tr>
187 <td width="15%" align="right" valign="top" class="summary">
188 <span class="summary-type">&nbsp;</span>
189 </td><td class="summary">
190 <table width="100%" cellpadding="0" cellspacing="0" border="0">
191 <tr>
192 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
193 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
194 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
195 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
196 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
197 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
198 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
199 Create a Resource for interacting with an API.</td>
200 <td align="right" valign="top">
201 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400202
203 </td>
204 </tr>
205 </table>
206
207 </td>
208 </tr>
209<tr class="private">
210 <td width="15%" align="right" valign="top" class="summary">
211 <span class="summary-type">&nbsp;</span>
212 </td><td class="summary">
213 <table width="100%" cellpadding="0" cellspacing="0" border="0">
214 <tr>
215 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>,
216 <span class="summary-sig-arg">schema_type</span>)</span><br />
217 Convert value to a string based on JSON Schema type.</td>
218 <td align="right" valign="top">
219 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
220
221 </td>
222 </tr>
223 </table>
224
225 </td>
226 </tr>
227<tr class="private">
228 <td width="15%" align="right" valign="top" class="summary">
229 <span class="summary-type">&nbsp;</span>
230 </td><td class="summary">
231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
232 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400233 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_media_size_to_long" class="summary-sig-name" onclick="show_private();">_media_size_to_long</a>(<span class="summary-sig-arg">maxSize</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400234 Convert a string media size, such as 10GB or 3TB into an integer.</td>
235 <td align="right" valign="top">
236 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
237
238 </td>
239 </tr>
240 </table>
241
242 </td>
243 </tr>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500244<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400245 <td width="15%" align="right" valign="top" class="summary">
246 <span class="summary-type">&nbsp;</span>
247 </td><td class="summary">
248 <table width="100%" cellpadding="0" cellspacing="0" border="0">
249 <tr>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500250 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#createMethod" class="summary-sig-name">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
251 <span class="summary-sig-arg">methodDesc</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400252 <span class="summary-sig-arg">rootDesc</span>,
253 <span class="summary-sig-arg">schema</span>)</span><br />
Joe Gregorio52a5c532013-01-24 16:19:07 -0500254 Creates a method for attaching to a Resource.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400255 <td align="right" valign="top">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500256 <span class="codelink"><a href="apiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>
257
258 </td>
259 </tr>
260 </table>
261
262 </td>
263 </tr>
264<tr>
265 <td width="15%" align="right" valign="top" class="summary">
266 <span class="summary-type">&nbsp;</span>
267 </td><td class="summary">
268 <table width="100%" cellpadding="0" cellspacing="0" border="0">
269 <tr>
270 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#createNextMethod" class="summary-sig-name">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
271 Creates any _next methods for attaching to a Resource.</td>
272 <td align="right" valign="top">
273 <span class="codelink"><a href="apiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400274
275 </td>
276 </tr>
277 </table>
278
279 </td>
280 </tr>
281</table>
282<!-- ==================== VARIABLES ==================== -->
283<a name="section-Variables"></a>
284<table class="summary" border="1" cellpadding="3"
285 cellspacing="0" width="100%" bgcolor="white">
286<tr bgcolor="#70b0f0" class="table-header">
287 <td colspan="2" class="table-header">
288 <table border="0" cellpadding="0" cellspacing="0" width="100%">
289 <tr valign="top">
290 <td align="left"><span class="table-header">Variables</span></td>
291 <td align="right" valign="top"
292 ><span class="options">[<a href="#section-Variables"
293 class="privatelink" onclick="toggle_private();"
294 >hide private</a>]</span></td>
295 </tr>
296 </table>
297 </td>
298</tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400299<tr>
300 <td width="15%" align="right" valign="top" class="summary">
301 <span class="summary-type">&nbsp;</span>
302 </td><td class="summary">
303 <a name="copy"></a><span class="summary-name">copy</span>
304 </td>
305 </tr>
306<tr>
307 <td width="15%" align="right" valign="top" class="summary">
308 <span class="summary-type">&nbsp;</span>
309 </td><td class="summary">
310 <a name="httplib2"></a><span class="summary-name">httplib2</span>
311 </td>
312 </tr>
313<tr>
314 <td width="15%" align="right" valign="top" class="summary">
315 <span class="summary-type">&nbsp;</span>
316 </td><td class="summary">
317 <a name="logging"></a><span class="summary-name">logging</span>
318 </td>
319 </tr>
320<tr>
321 <td width="15%" align="right" valign="top" class="summary">
322 <span class="summary-type">&nbsp;</span>
323 </td><td class="summary">
324 <a name="os"></a><span class="summary-name">os</span>
325 </td>
326 </tr>
327<tr>
328 <td width="15%" align="right" valign="top" class="summary">
329 <span class="summary-type">&nbsp;</span>
330 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400331 <a name="re"></a><span class="summary-name">re</span>
332 </td>
333 </tr>
334<tr>
335 <td width="15%" align="right" valign="top" class="summary">
336 <span class="summary-type">&nbsp;</span>
337 </td><td class="summary">
338 <a name="uritemplate"></a><span class="summary-name">uritemplate</span>
339 </td>
340 </tr>
341<tr>
342 <td width="15%" align="right" valign="top" class="summary">
343 <span class="summary-type">&nbsp;</span>
344 </td><td class="summary">
345 <a name="urllib"></a><span class="summary-name">urllib</span>
346 </td>
347 </tr>
348<tr>
349 <td width="15%" align="right" valign="top" class="summary">
350 <span class="summary-type">&nbsp;</span>
351 </td><td class="summary">
352 <a name="urlparse"></a><span class="summary-name">urlparse</span>
353 </td>
354 </tr>
355<tr>
356 <td width="15%" align="right" valign="top" class="summary">
357 <span class="summary-type">&nbsp;</span>
358 </td><td class="summary">
359 <a name="mimeparse"></a><span class="summary-name">mimeparse</span>
360 </td>
361 </tr>
362<tr>
363 <td width="15%" align="right" valign="top" class="summary">
364 <span class="summary-type">&nbsp;</span>
365 </td><td class="summary">
366 <a name="mimetypes"></a><span class="summary-name">mimetypes</span>
367 </td>
368 </tr>
369<tr>
370 <td width="15%" align="right" valign="top" class="summary">
371 <span class="summary-type">&nbsp;</span>
372 </td><td class="summary">
373 <a name="parse_qsl"></a><span class="summary-name">parse_qsl</span>
374 </td>
375 </tr>
376<tr>
377 <td width="15%" align="right" valign="top" class="summary">
378 <span class="summary-type">&nbsp;</span>
379 </td><td class="summary">
380 <a name="HttpError"></a><span class="summary-name">HttpError</span>
381 </td>
382 </tr>
383<tr>
384 <td width="15%" align="right" valign="top" class="summary">
385 <span class="summary-type">&nbsp;</span>
386 </td><td class="summary">
387 <a name="InvalidJsonError"></a><span class="summary-name">InvalidJsonError</span>
388 </td>
389 </tr>
390<tr>
391 <td width="15%" align="right" valign="top" class="summary">
392 <span class="summary-type">&nbsp;</span>
393 </td><td class="summary">
394 <a name="MediaUploadSizeError"></a><span class="summary-name">MediaUploadSizeError</span>
395 </td>
396 </tr>
397<tr>
398 <td width="15%" align="right" valign="top" class="summary">
399 <span class="summary-type">&nbsp;</span>
400 </td><td class="summary">
401 <a name="UnacceptableMimeTypeError"></a><span class="summary-name">UnacceptableMimeTypeError</span>
402 </td>
403 </tr>
404<tr>
405 <td width="15%" align="right" valign="top" class="summary">
406 <span class="summary-type">&nbsp;</span>
407 </td><td class="summary">
408 <a name="UnknownApiNameOrVersion"></a><span class="summary-name">UnknownApiNameOrVersion</span>
409 </td>
410 </tr>
411<tr>
412 <td width="15%" align="right" valign="top" class="summary">
413 <span class="summary-type">&nbsp;</span>
414 </td><td class="summary">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500415 <a name="UnknownFileType"></a><span class="summary-name">UnknownFileType</span>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400416 </td>
417 </tr>
418<tr>
419 <td width="15%" align="right" valign="top" class="summary">
420 <span class="summary-type">&nbsp;</span>
421 </td><td class="summary">
422 <a name="HttpRequest"></a><span class="summary-name">HttpRequest</span>
423 </td>
424 </tr>
425<tr>
426 <td width="15%" align="right" valign="top" class="summary">
427 <span class="summary-type">&nbsp;</span>
428 </td><td class="summary">
429 <a name="MediaFileUpload"></a><span class="summary-name">MediaFileUpload</span>
430 </td>
431 </tr>
432<tr>
433 <td width="15%" align="right" valign="top" class="summary">
434 <span class="summary-type">&nbsp;</span>
435 </td><td class="summary">
436 <a name="MediaUpload"></a><span class="summary-name">MediaUpload</span>
437 </td>
438 </tr>
439<tr>
440 <td width="15%" align="right" valign="top" class="summary">
441 <span class="summary-type">&nbsp;</span>
442 </td><td class="summary">
443 <a name="JsonModel"></a><span class="summary-name">JsonModel</span>
444 </td>
445 </tr>
446<tr>
447 <td width="15%" align="right" valign="top" class="summary">
448 <span class="summary-type">&nbsp;</span>
449 </td><td class="summary">
450 <a name="MediaModel"></a><span class="summary-name">MediaModel</span>
451 </td>
452 </tr>
453<tr>
454 <td width="15%" align="right" valign="top" class="summary">
455 <span class="summary-type">&nbsp;</span>
456 </td><td class="summary">
457 <a name="RawModel"></a><span class="summary-name">RawModel</span>
458 </td>
459 </tr>
460<tr>
461 <td width="15%" align="right" valign="top" class="summary">
462 <span class="summary-type">&nbsp;</span>
463 </td><td class="summary">
464 <a name="Schemas"></a><span class="summary-name">Schemas</span>
465 </td>
466 </tr>
467<tr>
468 <td width="15%" align="right" valign="top" class="summary">
469 <span class="summary-type">&nbsp;</span>
470 </td><td class="summary">
471 <a name="MIMEMultipart"></a><span class="summary-name">MIMEMultipart</span>
472 </td>
473 </tr>
474<tr>
475 <td width="15%" align="right" valign="top" class="summary">
476 <span class="summary-type">&nbsp;</span>
477 </td><td class="summary">
478 <a name="MIMENonMultipart"></a><span class="summary-name">MIMENonMultipart</span>
479 </td>
480 </tr>
481<tr>
482 <td width="15%" align="right" valign="top" class="summary">
483 <span class="summary-type">&nbsp;</span>
484 </td><td class="summary">
485 <a name="positional"></a><span class="summary-name">positional</span>
486 </td>
487 </tr>
488<tr>
489 <td width="15%" align="right" valign="top" class="summary">
490 <span class="summary-type">&nbsp;</span>
491 </td><td class="summary">
492 <a name="simplejson"></a><span class="summary-name">simplejson</span>
493 </td>
494 </tr>
495<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400496 <td width="15%" align="right" valign="top" class="summary">
497 <span class="summary-type">&nbsp;</span>
498 </td><td class="summary">
499 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
500 </td>
501 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400502<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400503 <td width="15%" align="right" valign="top" class="summary">
504 <span class="summary-type">&nbsp;</span>
505 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400506 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400507 </td>
508 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400509<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400510 <td width="15%" align="right" valign="top" class="summary">
511 <span class="summary-type">&nbsp;</span>
512 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400513 <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400514 </td>
515 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400516<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400517 <td width="15%" align="right" valign="top" class="summary">
518 <span class="summary-type">&nbsp;</span>
519 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400520 <a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
521st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400522 </td>
523 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400524<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400525 <td width="15%" align="right" valign="top" class="summary">
526 <span class="summary-type">&nbsp;</span>
527 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400528 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400529 </td>
530 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400531<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400532 <td width="15%" align="right" valign="top" class="summary">
533 <span class="summary-type">&nbsp;</span>
534 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400535 <a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']">['trace', 'pp', 'userip', 'strict']</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400536 </td>
537 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400538<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400539 <td width="15%" align="right" valign="top" class="summary">
540 <span class="summary-type">&nbsp;</span>
541 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400542 <a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name">RESERVED_WORDS</a> = <code title="['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', \
543'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i\
544mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '\
545return', 'try', 'while', 'body']">['and', 'assert', 'break', 'class', 'continue<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400546 </td>
547 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400548<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400549 <td width="15%" align="right" valign="top" class="summary">
550 <span class="summary-type">&nbsp;</span>
551 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400552 <a href="apiclient.discovery-module.html#MULTIPLIERS" class="summary-name">MULTIPLIERS</a> = <code title="{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;: 2** 40,}">{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;:<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400553 </td>
554 </tr>
555</table>
556<!-- ==================== FUNCTION DETAILS ==================== -->
557<a name="section-FunctionDetails"></a>
558<table class="details" border="1" cellpadding="3"
559 cellspacing="0" width="100%" bgcolor="white">
560<tr bgcolor="#70b0f0" class="table-header">
561 <td colspan="2" class="table-header">
562 <table border="0" cellpadding="0" cellspacing="0" width="100%">
563 <tr valign="top">
564 <td align="left"><span class="table-header">Function Details</span></td>
565 <td align="right" valign="top"
566 ><span class="options">[<a href="#section-FunctionDetails"
567 class="privatelink" onclick="toggle_private();"
568 >hide private</a>]</span></td>
569 </tr>
570 </table>
571 </td>
572</tr>
573</table>
Joe Gregorio66212032012-06-14 09:10:14 -0400574<a name="fix_method_name"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400575<div>
Joe Gregorio66212032012-06-14 09:10:14 -0400576<table class="details" border="1" cellpadding="3"
577 cellspacing="0" width="100%" bgcolor="white">
578<tr><td>
579 <table width="100%" cellpadding="0" cellspacing="0" border="0">
580 <tr valign="top"><td>
581 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
582 </h3>
583 </td><td align="right" valign="top"
584 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
585 </td>
586 </tr></table>
587
588 <pre class="literalblock">
589Fix method names to avoid reserved word conflicts.
590
591Args:
592 name: string, method name.
593
594Returns:
595 The name with a '_' prefixed if the name is a reserved word.
596
597</pre>
598 <dl class="fields">
599 </dl>
600</td></tr></table>
601</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400602<a name="_add_query_parameter"></a>
603<div class="private">
604<table class="details" border="1" cellpadding="3"
605 cellspacing="0" width="100%" bgcolor="white">
606<tr><td>
607 <table width="100%" cellpadding="0" cellspacing="0" border="0">
608 <tr valign="top"><td>
609 <h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>,
610 <span class="sig-arg">name</span>,
611 <span class="sig-arg">value</span>)</span>
612 </h3>
613 </td><td align="right" valign="top"
614 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>&nbsp;
615 </td>
616 </tr></table>
617
618 <pre class="literalblock">
619Adds a query parameter to a url.
620
621Replaces the current value if it already exists in the URL.
622
623Args:
624 url: string, url to add the query parameter to.
625 name: string, query parameter name.
626 value: string, query parameter value.
627
628Returns:
629 Updated query parameter. Does not update the url if value is None.
630
631</pre>
632 <dl class="fields">
633 </dl>
634</td></tr></table>
635</div>
636<a name="key2param"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400637<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400638<table class="details" border="1" cellpadding="3"
639 cellspacing="0" width="100%" bgcolor="white">
640<tr><td>
641 <table width="100%" cellpadding="0" cellspacing="0" border="0">
642 <tr valign="top"><td>
643 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
644 </h3>
645 </td><td align="right" valign="top"
646 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
647 </td>
648 </tr></table>
649
650 <pre class="literalblock">
651Converts key names into parameter names.
652
653For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
654
Joe Gregorio66212032012-06-14 09:10:14 -0400655Args:
656 key: string, the method key name.
657
658Returns:
659 A safe method name based on the key name.
660
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400661</pre>
662 <dl class="fields">
663 </dl>
664</td></tr></table>
665</div>
666<a name="build"></a>
667<div>
668<table class="details" border="1" cellpadding="3"
669 cellspacing="0" width="100%" bgcolor="white">
670<tr><td>
671 <table width="100%" cellpadding="0" cellspacing="0" border="0">
672 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400673 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
674 <span class="sig-arg">version</span>,
675 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
676 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
677 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
678 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
679 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400680 </h3>
681 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400682 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400683 </td>
684 </tr></table>
685
686 <pre class="literalblock">
687Construct a Resource for interacting with an API.
688
Joe Gregorio66212032012-06-14 09:10:14 -0400689Construct a Resource object for interacting with an API. The serviceName and
690version are the names from the Discovery service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400691
692Args:
Joe Gregorio66212032012-06-14 09:10:14 -0400693 serviceName: string, name of the service.
694 version: string, the version of the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400695 http: httplib2.Http, An instance of httplib2.Http or something that acts
696 like it that HTTP requests will be made through.
Joe Gregorio66212032012-06-14 09:10:14 -0400697 discoveryServiceUrl: string, a URI Template that points to the location of
698 the discovery service. It should have two parameters {api} and
699 {apiVersion} that when filled in produce an absolute URI to the discovery
700 document for that service.
701 developerKey: string, key obtained from
702 https://code.google.com/apis/console.
703 model: apiclient.Model, converts to and from the wire format.
704 requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
705 request.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400706
707Returns:
Joe Gregorio66212032012-06-14 09:10:14 -0400708 A Resource object with methods for interacting with the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400709
710</pre>
711 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400712 <dt>Decorators:</dt>
713 <dd><ul class="nomargin-top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400714 <li><code>@positional(2)</code></li>
715 </ul></dd>
716 </dl>
717</td></tr></table>
718</div>
719<a name="build_from_document"></a>
720<div>
721<table class="details" border="1" cellpadding="3"
722 cellspacing="0" width="100%" bgcolor="white">
723<tr><td>
724 <table width="100%" cellpadding="0" cellspacing="0" border="0">
725 <tr valign="top"><td>
726 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
727 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
728 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
729 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
730 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
731 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
732 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
733 </h3>
734 </td><td align="right" valign="top"
735 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
736 </td>
737 </tr></table>
738
739 <pre class="literalblock">
740Create a Resource for interacting with an API.
741
742Same as `build()`, but constructs the Resource object from a discovery
743document that is it given, as opposed to retrieving one over HTTP.
744
745Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500746 service: string or object, the JSON discovery document describing the API.
747 The value passed in may either be the JSON string or the deserialized
748 JSON.
Joe Gregoriof4839b02012-09-06 13:47:24 -0400749 base: string, base URI for all HTTP requests, usually the discovery URI.
750 This parameter is no longer used as rootUrl and servicePath are included
751 within the discovery document. (deprecated)
752 future: string, discovery document with future capabilities (deprecated).
753 http: httplib2.Http, An instance of httplib2.Http or something that acts
754 like it that HTTP requests will be made through.
755 developerKey: string, Key for controlling API usage, generated
756 from the API Console.
757 model: Model class instance that serializes and de-serializes requests and
758 responses.
759 requestBuilder: Takes an http request and packages it up to be executed.
760
761Returns:
762 A Resource object with methods for interacting with the service.
763
764</pre>
765 <dl class="fields">
766 <dt>Decorators:</dt>
767 <dd><ul class="nomargin-top">
768 <li><code>@positional(1)</code></li>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400769 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400770 </dl>
771</td></tr></table>
772</div>
773<a name="_cast"></a>
774<div class="private">
775<table class="details" border="1" cellpadding="3"
776 cellspacing="0" width="100%" bgcolor="white">
777<tr><td>
778 <table width="100%" cellpadding="0" cellspacing="0" border="0">
779 <tr valign="top"><td>
780 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
781 <span class="sig-arg">schema_type</span>)</span>
782 </h3>
783 </td><td align="right" valign="top"
784 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
785 </td>
786 </tr></table>
787
788 <pre class="literalblock">
789Convert value to a string based on JSON Schema type.
790
791See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
792JSON Schema.
793
794Args:
795 value: any, the value to convert
796 schema_type: string, the type that value should be interpreted as
797
798Returns:
799 A string representation of 'value' based on the schema_type.
800
801</pre>
802 <dl class="fields">
803 </dl>
804</td></tr></table>
805</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400806<a name="_media_size_to_long"></a>
807<div class="private">
808<table class="details" border="1" cellpadding="3"
809 cellspacing="0" width="100%" bgcolor="white">
810<tr><td>
811 <table width="100%" cellpadding="0" cellspacing="0" border="0">
812 <tr valign="top"><td>
813 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
814 </h3>
815 </td><td align="right" valign="top"
816 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
817 </td>
818 </tr></table>
819
820 <pre class="literalblock">
821Convert a string media size, such as 10GB or 3TB into an integer.
822
823Args:
824 maxSize: string, size as a string, such as 2MB or 7GB.
825
826Returns:
827 The size as an integer value.
828
829</pre>
830 <dl class="fields">
831 </dl>
832</td></tr></table>
833</div>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500834<a name="createMethod"></a>
835<div>
Joe Gregorio66212032012-06-14 09:10:14 -0400836<table class="details" border="1" cellpadding="3"
837 cellspacing="0" width="100%" bgcolor="white">
838<tr><td>
839 <table width="100%" cellpadding="0" cellspacing="0" border="0">
840 <tr valign="top"><td>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500841 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
842 <span class="sig-arg">methodDesc</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400843 <span class="sig-arg">rootDesc</span>,
844 <span class="sig-arg">schema</span>)</span>
845 </h3>
846 </td><td align="right" valign="top"
Joe Gregorio52a5c532013-01-24 16:19:07 -0500847 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
Joe Gregorio66212032012-06-14 09:10:14 -0400848 </td>
849 </tr></table>
850
851 <pre class="literalblock">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500852Creates a method for attaching to a Resource.
Joe Gregorio66212032012-06-14 09:10:14 -0400853
854Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500855 methodName: string, name of the method to use.
856 methodDesc: object, fragment of deserialized discovery document that
857 describes the method.
Joe Gregorio66212032012-06-14 09:10:14 -0400858 rootDesc: object, the entire deserialized discovery document.
859 schema: object, mapping of schema names to schema descriptions.
860
Joe Gregorio52a5c532013-01-24 16:19:07 -0500861</pre>
862 <dl class="fields">
863 </dl>
864</td></tr></table>
865</div>
866<a name="createNextMethod"></a>
867<div>
868<table class="details" border="1" cellpadding="3"
869 cellspacing="0" width="100%" bgcolor="white">
870<tr><td>
871 <table width="100%" cellpadding="0" cellspacing="0" border="0">
872 <tr valign="top"><td>
873 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>)</span>
874 </h3>
875 </td><td align="right" valign="top"
876 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
877 </td>
878 </tr></table>
879
880 <pre class="literalblock">
881Creates any _next methods for attaching to a Resource.
882
883The _next methods allow for easy iteration through list() responses.
884
885Args:
886 methodName: string, name of the method to use.
Joe Gregorio66212032012-06-14 09:10:14 -0400887
888</pre>
889 <dl class="fields">
890 </dl>
891</td></tr></table>
892</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400893<br />
894<!-- ==================== VARIABLES DETAILS ==================== -->
895<a name="section-VariablesDetails"></a>
896<table class="details" border="1" cellpadding="3"
897 cellspacing="0" width="100%" bgcolor="white">
898<tr bgcolor="#70b0f0" class="table-header">
899 <td colspan="2" class="table-header">
900 <table border="0" cellpadding="0" cellspacing="0" width="100%">
901 <tr valign="top">
902 <td align="left"><span class="table-header">Variables Details</span></td>
903 <td align="right" valign="top"
904 ><span class="options">[<a href="#section-VariablesDetails"
905 class="privatelink" onclick="toggle_private();"
906 >hide private</a>]</span></td>
907 </tr>
908 </table>
909 </td>
910</tr>
911</table>
912<a name="DISCOVERY_URI"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400913<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400914<table class="details" border="1" cellpadding="3"
915 cellspacing="0" width="100%" bgcolor="white">
916<tr><td>
917 <h3 class="epydoc">DISCOVERY_URI</h3>
918
919 <dl class="fields">
920 </dl>
921 <dl class="fields">
922 <dt>Value:</dt>
923 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400924'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
925st'
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400926</pre></td></tr></table>
927</dd>
928 </dl>
929</td></tr></table>
930</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400931<a name="RESERVED_WORDS"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400932<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400933<table class="details" border="1" cellpadding="3"
934 cellspacing="0" width="100%" bgcolor="white">
935<tr><td>
936 <h3 class="epydoc">RESERVED_WORDS</h3>
937
938 <dl class="fields">
939 </dl>
940 <dl class="fields">
941 <dt>Value:</dt>
942 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400943['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
944'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
945mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
946return', 'try', 'while', 'body']
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400947</pre></td></tr></table>
948</dd>
949 </dl>
950</td></tr></table>
951</div>
952<a name="MULTIPLIERS"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400953<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400954<table class="details" border="1" cellpadding="3"
955 cellspacing="0" width="100%" bgcolor="white">
956<tr><td>
957 <h3 class="epydoc">MULTIPLIERS</h3>
958
959 <dl class="fields">
960 </dl>
961 <dl class="fields">
962 <dt>Value:</dt>
963 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400964{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;: 2** 40,}
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400965</pre></td></tr></table>
966</dd>
967 </dl>
968</td></tr></table>
969</div>
970<br />
971<!-- ==================== NAVIGATION BAR ==================== -->
972<table class="navbar" border="0" width="100%" cellpadding="0"
973 bgcolor="#a0c0ff" cellspacing="0">
974 <tr valign="middle">
975
976 <!-- Tree link -->
977 <th>&nbsp;&nbsp;&nbsp;<a
978 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
979
980 <!-- Index link -->
981 <th>&nbsp;&nbsp;&nbsp;<a
982 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
983
984 <!-- Help link -->
985 <th>&nbsp;&nbsp;&nbsp;<a
986 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
987
988 <th class="navbar" width="100%"></th>
989 </tr>
990</table>
991<table border="0" cellpadding="0" cellspacing="0" width="100%%">
992 <tr>
993 <td align="left" class="footer">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500994 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400995 </td>
996 <td align="right" class="footer">
997 <a target="mainFrame" href="http://epydoc.sourceforge.net"
998 >http://epydoc.sourceforge.net</a>
999 </td>
1000 </tr>
1001</table>
1002
1003<script type="text/javascript">
1004 <!--
1005 // Private objects are initially displayed (because if
1006 // javascript is turned off then we want them to be
1007 // visible); but by default, we want to hide them. So hide
1008 // them unless we have a cookie that says to show them.
1009 checkCookie();
1010 // -->
1011</script>
1012</body>
1013</html>