Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / epy / googleapiclient.discovery-module.html
blob: 70680b42d99259d0156bc4908b8990bba859edf3 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>googleapiclient.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 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-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 <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
41 Module&nbsp;discovery
42 </span>
43 </td>
44 <td>
45 <table cellpadding="0" cellspacing="0">
46 <!-- hide/show private -->
47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="googleapiclient.discovery-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== MODULE DESCRIPTION ==================== -->
58<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
59<pre class="literalblock">
60Client for discovery based APIs.
61
62A client library for Google's discovery based APIs.
63
64</pre>
65
66<hr />
67<div class="fields"> <p><strong>Author:</strong>
68 jcgregorio@google.com (Joe Gregorio)
69 </p>
70</div><!-- ==================== CLASSES ==================== -->
71<a name="section-Classes"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-Classes"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr class="private">
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br />
92 Represents the parameters associated with a method.
93 </td>
94 </tr>
95<tr class="private">
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <a href="googleapiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br />
100 A class for interacting with a resource.
101 </td>
102 </tr>
103</table>
104<!-- ==================== FUNCTIONS ==================== -->
105<a name="section-Functions"></a>
106<table class="summary" border="1" cellpadding="3"
107 cellspacing="0" width="100%" bgcolor="white">
108<tr bgcolor="#70b0f0" class="table-header">
109 <td colspan="2" class="table-header">
110 <table border="0" cellpadding="0" cellspacing="0" width="100%">
111 <tr valign="top">
112 <td align="left"><span class="table-header">Functions</span></td>
113 <td align="right" valign="top"
114 ><span class="options">[<a href="#section-Functions"
115 class="privatelink" onclick="toggle_private();"
116 >hide private</a>]</span></td>
117 </tr>
118 </table>
119 </td>
120</tr>
121<tr>
122 <td width="15%" align="right" valign="top" class="summary">
123 <span class="summary-type">&nbsp;</span>
124 </td><td class="summary">
125 <table width="100%" cellpadding="0" cellspacing="0" border="0">
126 <tr>
127 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
128 Fix method names to avoid reserved word conflicts.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
145 Converts key names into parameter names.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
162 <span class="summary-sig-arg">version</span>,
163 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
164 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
165 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
166 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]167 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
168 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 Construct a Resource for interacting with an API.</td>
170 <td align="right" valign="top">
171 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
172
173 </td>
174 </tr>
175 </table>
176
177 </td>
178 </tr>
179<tr>
180 <td width="15%" align="right" valign="top" class="summary">
181 <span class="summary-type">&nbsp;</span>
182 </td><td class="summary">
183 <table width="100%" cellpadding="0" cellspacing="0" border="0">
184 <tr>
185 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
186 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
187 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
188 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
189 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
190 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
192 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193 Create a Resource for interacting with an API.</td>
194 <td align="right" valign="top">
195 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
196
197 </td>
198 </tr>
199 </table>
200
201 </td>
202 </tr>
203<tr class="private">
204 <td width="15%" align="right" valign="top" class="summary">
205 <span class="summary-type">&nbsp;</span>
206 </td><td class="summary">
207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
208 <tr>
209 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>,
210 <span class="summary-sig-arg">schema_type</span>)</span><br />
211 Convert value to a string based on JSON Schema type.</td>
212 <td align="right" valign="top">
213 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
214
215 </td>
216 </tr>
217 </table>
218
219 </td>
220 </tr>
221<tr class="private">
222 <td width="15%" align="right" valign="top" class="summary">
223 <span class="summary-type">&nbsp;</span>
224 </td><td class="summary">
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr>
227 <td><span class="summary-sig"><a href="googleapiclient.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 />
228 Convert a string media size, such as 10GB or 3TB into an integer.</td>
229 <td align="right" valign="top">
230 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
231
232 </td>
233 </tr>
234 </table>
235
236 </td>
237 </tr>
238<tr class="private">
239 <td width="15%" align="right" valign="top" class="summary">
240 <span class="summary-type">&nbsp;</span>
241 </td><td class="summary">
242 <table width="100%" cellpadding="0" cellspacing="0" border="0">
243 <tr>
244 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_path_url_from_info" class="summary-sig-name" onclick="show_private();">_media_path_url_from_info</a>(<span class="summary-sig-arg">root_desc</span>,
245 <span class="summary-sig-arg">path_url</span>)</span><br />
246 Creates an absolute media path URL.</td>
247 <td align="right" valign="top">
248 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>
249
250 </td>
251 </tr>
252 </table>
253
254 </td>
255 </tr>
256<tr class="private">
257 <td width="15%" align="right" valign="top" class="summary">
258 <span class="summary-type">&nbsp;</span>
259 </td><td class="summary">
260 <table width="100%" cellpadding="0" cellspacing="0" border="0">
261 <tr>
262 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>,
263 <span class="summary-sig-arg">root_desc</span>,
264 <span class="summary-sig-arg">http_method</span>)</span><br />
265 Updates parameters of an API method with values specific to this library.</td>
266 <td align="right" valign="top">
267 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>
268
269 </td>
270 </tr>
271 </table>
272
273 </td>
274 </tr>
275<tr class="private">
276 <td width="15%" align="right" valign="top" class="summary">
277 <span class="summary-type">&nbsp;</span>
278 </td><td class="summary">
279 <table width="100%" cellpadding="0" cellspacing="0" border="0">
280 <tr>
281 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>,
282 <span class="summary-sig-arg">root_desc</span>,
283 <span class="summary-sig-arg">path_url</span>,
284 <span class="summary-sig-arg">parameters</span>)</span><br />
285 Updates parameters of API by adding 'media_body' if supported by method.</td>
286 <td align="right" valign="top">
287 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>
288
289 </td>
290 </tr>
291 </table>
292
293 </td>
294 </tr>
295<tr class="private">
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
300 <tr>
301 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_method_description" class="summary-sig-name" onclick="show_private();">_fix_up_method_description</a>(<span class="summary-sig-arg">method_desc</span>,
302 <span class="summary-sig-arg">root_desc</span>)</span><br />
303 Updates a method description in a discovery document.</td>
304 <td align="right" valign="top">
305 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>
306
307 </td>
308 </tr>
309 </table>
310
311 </td>
312 </tr>
313<tr class="private">
314 <td width="15%" align="right" valign="top" class="summary">
315 <span class="summary-type">&nbsp;</span>
316 </td><td class="summary">
317 <table width="100%" cellpadding="0" cellspacing="0" border="0">
318 <tr>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]319 <td><span class="summary-sig"><a name="_urljoin"></a><span class="summary-sig-name">_urljoin</span>(<span class="summary-sig-arg">base</span>,
320 <span class="summary-sig-arg">url</span>)</span><br />
321 Custom urljoin replacement supporting : before / in url.</td>
322 <td align="right" valign="top">
323 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_urljoin">source&nbsp;code</a></span>
324
325 </td>
326 </tr>
327 </table>
328
329 </td>
330 </tr>
331<tr class="private">
332 <td width="15%" align="right" valign="top" class="summary">
333 <span class="summary-type">&nbsp;</span>
334 </td><td class="summary">
335 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]337 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createMethod" class="summary-sig-name" onclick="show_private();">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
338 <span class="summary-sig-arg">methodDesc</span>,
339 <span class="summary-sig-arg">rootDesc</span>,
340 <span class="summary-sig-arg">schema</span>)</span><br />
341 Creates a method for attaching to a Resource.</td>
342 <td align="right" valign="top">
343 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>
344
345 </td>
346 </tr>
347 </table>
348
349 </td>
350 </tr>
351<tr class="private">
352 <td width="15%" align="right" valign="top" class="summary">
353 <span class="summary-type">&nbsp;</span>
354 </td><td class="summary">
355 <table width="100%" cellpadding="0" cellspacing="0" border="0">
356 <tr>
357 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createNextMethod" class="summary-sig-name" onclick="show_private();">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
358 Creates any _next methods for attaching to a Resource.</td>
359 <td align="right" valign="top">
360 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>
361
362 </td>
363 </tr>
364 </table>
365
366 </td>
367 </tr>
368</table>
369<!-- ==================== VARIABLES ==================== -->
370<a name="section-Variables"></a>
371<table class="summary" border="1" cellpadding="3"
372 cellspacing="0" width="100%" bgcolor="white">
373<tr bgcolor="#70b0f0" class="table-header">
374 <td colspan="2" class="table-header">
375 <table border="0" cellpadding="0" cellspacing="0" width="100%">
376 <tr valign="top">
377 <td align="left"><span class="table-header">Variables</span></td>
378 <td align="right" valign="top"
379 ><span class="options">[<a href="#section-Variables"
380 class="privatelink" onclick="toggle_private();"
381 >hide private</a>]</span></td>
382 </tr>
383 </table>
384 </td>
385</tr>
386<tr class="private">
387 <td width="15%" align="right" valign="top" class="summary">
388 <span class="summary-type">&nbsp;</span>
389 </td><td class="summary">
390 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
391 </td>
392 </tr>
393<tr class="private">
394 <td width="15%" align="right" valign="top" class="summary">
395 <span class="summary-type">&nbsp;</span>
396 </td><td class="summary">
397 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
398 </td>
399 </tr>
400<tr class="private">
401 <td width="15%" align="right" valign="top" class="summary">
402 <span class="summary-type">&nbsp;</span>
403 </td><td class="summary">
404 <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>
405 </td>
406 </tr>
407<tr class="private">
408 <td width="15%" align="right" valign="top" class="summary">
409 <span class="summary-type">&nbsp;</span>
410 </td><td class="summary">
411 <a href="googleapiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
412st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
413 </td>
414 </tr>
415<tr class="private">
416 <td width="15%" align="right" valign="top" class="summary">
417 <span class="summary-type">&nbsp;</span>
418 </td><td class="summary">
419 <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>
420 </td>
421 </tr>
422<tr class="private">
423 <td width="15%" align="right" valign="top" class="summary">
424 <span class="summary-type">&nbsp;</span>
425 </td><td class="summary">
426 <a name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</code>
427 </td>
428 </tr>
429<tr class="private">
430 <td width="15%" align="right" valign="top" class="summary">
431 <span class="summary-type">&nbsp;</span>
432 </td><td class="summary">
433 <a name="_MEDIA_SIZE_BIT_SHIFTS"></a><span class="summary-name">_MEDIA_SIZE_BIT_SHIFTS</span> = <code title="{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}">{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}</code>
434 </td>
435 </tr>
436<tr class="private">
437 <td width="15%" align="right" valign="top" class="summary">
438 <span class="summary-type">&nbsp;</span>
439 </td><td class="summary">
440 <a href="googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description': 'The request body.', 'type': 'object', 'required': Tru\
441e,}">{'description': 'The request bo<code class="variable-ellipsis">...</code></code>
442 </td>
443 </tr>
444<tr class="private">
445 <td width="15%" align="right" valign="top" class="summary">
446 <span class="summary-type">&nbsp;</span>
447 </td><td class="summary">
448 <a href="googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The filename of the media request body, or an instanc\
449e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code>
450 </td>
451 </tr>
452<tr class="private">
453 <td width="15%" align="right" valign="top" class="summary">
454 <span class="summary-type">&nbsp;</span>
455 </td><td class="summary">
456 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(['trace', 'pp', 'userip', 'strict'])">frozenset(['trace', 'pp', 'userip', '<code class="variable-ellipsis">...</code></code>
457 </td>
458 </tr>
459<tr class="private">
460 <td width="15%" align="right" valign="top" class="summary">
461 <span class="summary-type">&nbsp;</span>
462 </td><td class="summary">
463 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'type': 'string', 'location': 'query'}">{'type': 'string', 'loca<code class="variable-ellipsis">...</code></code>
464 </td>
465 </tr>
466<tr class="private">
467 <td width="15%" align="right" valign="top" class="summary">
468 <span class="summary-type">&nbsp;</span>
469 </td><td class="summary">
470 <a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code>
471 </td>
472 </tr>
473</table>
474<!-- ==================== FUNCTION DETAILS ==================== -->
475<a name="section-FunctionDetails"></a>
476<table class="details" border="1" cellpadding="3"
477 cellspacing="0" width="100%" bgcolor="white">
478<tr bgcolor="#70b0f0" class="table-header">
479 <td colspan="2" class="table-header">
480 <table border="0" cellpadding="0" cellspacing="0" width="100%">
481 <tr valign="top">
482 <td align="left"><span class="table-header">Function Details</span></td>
483 <td align="right" valign="top"
484 ><span class="options">[<a href="#section-FunctionDetails"
485 class="privatelink" onclick="toggle_private();"
486 >hide private</a>]</span></td>
487 </tr>
488 </table>
489 </td>
490</tr>
491</table>
492<a name="fix_method_name"></a>
493<div>
494<table class="details" border="1" cellpadding="3"
495 cellspacing="0" width="100%" bgcolor="white">
496<tr><td>
497 <table width="100%" cellpadding="0" cellspacing="0" border="0">
498 <tr valign="top"><td>
499 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
500 </h3>
501 </td><td align="right" valign="top"
502 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
503 </td>
504 </tr></table>
505
506 <pre class="literalblock">
507Fix method names to avoid reserved word conflicts.
508
509Args:
510 name: string, method name.
511
512Returns:
513 The name with a '_' prefixed if the name is a reserved word.
514
515</pre>
516 <dl class="fields">
517 </dl>
518</td></tr></table>
519</div>
520<a name="key2param"></a>
521<div>
522<table class="details" border="1" cellpadding="3"
523 cellspacing="0" width="100%" bgcolor="white">
524<tr><td>
525 <table width="100%" cellpadding="0" cellspacing="0" border="0">
526 <tr valign="top"><td>
527 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
528 </h3>
529 </td><td align="right" valign="top"
530 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
531 </td>
532 </tr></table>
533
534 <pre class="literalblock">
535Converts key names into parameter names.
536
537For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
538
539Args:
540 key: string, the method key name.
541
542Returns:
543 A safe method name based on the key name.
544
545</pre>
546 <dl class="fields">
547 </dl>
548</td></tr></table>
549</div>
550<a name="build"></a>
551<div>
552<table class="details" border="1" cellpadding="3"
553 cellspacing="0" width="100%" bgcolor="white">
554<tr><td>
555 <table width="100%" cellpadding="0" cellspacing="0" border="0">
556 <tr valign="top"><td>
557 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
558 <span class="sig-arg">version</span>,
559 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
560 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
561 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
562 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]563 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
564 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]565 </h3>
566 </td><td align="right" valign="top"
567 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
568 </td>
569 </tr></table>
570
571 <pre class="literalblock">
572Construct a Resource for interacting with an API.
573
574Construct a Resource object for interacting with an API. The serviceName and
575version are the names from the Discovery service.
576
577Args:
578 serviceName: string, name of the service.
579 version: string, the version of the service.
580 http: httplib2.Http, An instance of httplib2.Http or something that acts
581 like it that HTTP requests will be made through.
582 discoveryServiceUrl: string, a URI Template that points to the location of
583 the discovery service. It should have two parameters {api} and
584 {apiVersion} that when filled in produce an absolute URI to the discovery
585 document for that service.
586 developerKey: string, key obtained from
587 https://code.google.com/apis/console.
588 model: googleapiclient.Model, converts to and from the wire format.
589 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
590 request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]591 credentials: oauth2client.Credentials, credentials to be used for
592 authentication.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]593
594Returns:
595 A Resource object with methods for interacting with the service.
596
597</pre>
598 <dl class="fields">
599 <dt>Decorators:</dt>
600 <dd><ul class="nomargin-top">
601 <li><code>@positional(2)</code></li>
602 </ul></dd>
603 </dl>
604</td></tr></table>
605</div>
606<a name="build_from_document"></a>
607<div>
608<table class="details" border="1" cellpadding="3"
609 cellspacing="0" width="100%" bgcolor="white">
610<tr><td>
611 <table width="100%" cellpadding="0" cellspacing="0" border="0">
612 <tr valign="top"><td>
613 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
614 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
615 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
616 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
617 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
618 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]619 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
620 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]621 </h3>
622 </td><td align="right" valign="top"
623 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
624 </td>
625 </tr></table>
626
627 <pre class="literalblock">
628Create a Resource for interacting with an API.
629
630Same as `build()`, but constructs the Resource object from a discovery
631document that is it given, as opposed to retrieving one over HTTP.
632
633Args:
634 service: string or object, the JSON discovery document describing the API.
635 The value passed in may either be the JSON string or the deserialized
636 JSON.
637 base: string, base URI for all HTTP requests, usually the discovery URI.
638 This parameter is no longer used as rootUrl and servicePath are included
639 within the discovery document. (deprecated)
640 future: string, discovery document with future capabilities (deprecated).
641 http: httplib2.Http, An instance of httplib2.Http or something that acts
642 like it that HTTP requests will be made through.
643 developerKey: string, Key for controlling API usage, generated
644 from the API Console.
645 model: Model class instance that serializes and de-serializes requests and
646 responses.
647 requestBuilder: Takes an http request and packages it up to be executed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]648 credentials: object, credentials to be used for authentication.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]649
650Returns:
651 A Resource object with methods for interacting with the service.
652
653</pre>
654 <dl class="fields">
655 <dt>Decorators:</dt>
656 <dd><ul class="nomargin-top">
657 <li><code>@positional(1)</code></li>
658 </ul></dd>
659 </dl>
660</td></tr></table>
661</div>
662<a name="_cast"></a>
663<div class="private">
664<table class="details" border="1" cellpadding="3"
665 cellspacing="0" width="100%" bgcolor="white">
666<tr><td>
667 <table width="100%" cellpadding="0" cellspacing="0" border="0">
668 <tr valign="top"><td>
669 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
670 <span class="sig-arg">schema_type</span>)</span>
671 </h3>
672 </td><td align="right" valign="top"
673 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
674 </td>
675 </tr></table>
676
677 <pre class="literalblock">
678Convert value to a string based on JSON Schema type.
679
680See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
681JSON Schema.
682
683Args:
684 value: any, the value to convert
685 schema_type: string, the type that value should be interpreted as
686
687Returns:
688 A string representation of 'value' based on the schema_type.
689
690</pre>
691 <dl class="fields">
692 </dl>
693</td></tr></table>
694</div>
695<a name="_media_size_to_long"></a>
696<div class="private">
697<table class="details" border="1" cellpadding="3"
698 cellspacing="0" width="100%" bgcolor="white">
699<tr><td>
700 <table width="100%" cellpadding="0" cellspacing="0" border="0">
701 <tr valign="top"><td>
702 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
703 </h3>
704 </td><td align="right" valign="top"
705 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
706 </td>
707 </tr></table>
708
709 <pre class="literalblock">
710Convert a string media size, such as 10GB or 3TB into an integer.
711
712Args:
713 maxSize: string, size as a string, such as 2MB or 7GB.
714
715Returns:
716 The size as an integer value.
717
718</pre>
719 <dl class="fields">
720 </dl>
721</td></tr></table>
722</div>
723<a name="_media_path_url_from_info"></a>
724<div class="private">
725<table class="details" border="1" cellpadding="3"
726 cellspacing="0" width="100%" bgcolor="white">
727<tr><td>
728 <table width="100%" cellpadding="0" cellspacing="0" border="0">
729 <tr valign="top"><td>
730 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
731 <span class="sig-arg">path_url</span>)</span>
732 </h3>
733 </td><td align="right" valign="top"
734 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>&nbsp;
735 </td>
736 </tr></table>
737
738 <pre class="literalblock">
739Creates an absolute media path URL.
740
741Constructed using the API root URI and service path from the discovery
742document and the relative path for the API method.
743
744Args:
745 root_desc: Dictionary; the entire original deserialized discovery document.
746 path_url: String; the relative URL for the API method. Relative to the API
747 root, which is specified in the discovery document.
748
749Returns:
750 String; the absolute URI for media upload for the API method.
751
752</pre>
753 <dl class="fields">
754 </dl>
755</td></tr></table>
756</div>
757<a name="_fix_up_parameters"></a>
758<div class="private">
759<table class="details" border="1" cellpadding="3"
760 cellspacing="0" width="100%" bgcolor="white">
761<tr><td>
762 <table width="100%" cellpadding="0" cellspacing="0" border="0">
763 <tr valign="top"><td>
764 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
765 <span class="sig-arg">root_desc</span>,
766 <span class="sig-arg">http_method</span>)</span>
767 </h3>
768 </td><td align="right" valign="top"
769 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>&nbsp;
770 </td>
771 </tr></table>
772
773 <pre class="literalblock">
774Updates parameters of an API method with values specific to this library.
775
776Specifically, adds whatever global parameters are specified by the API to the
777parameters for the individual method. Also adds parameters which don't
778appear in the discovery document, but are available to all discovery based
779APIs (these are listed in STACK_QUERY_PARAMETERS).
780
781SIDE EFFECTS: This updates the parameters dictionary object in the method
782description.
783
784Args:
785 method_desc: Dictionary with metadata describing an API method. Value comes
786 from the dictionary of methods stored in the 'methods' key in the
787 deserialized discovery document.
788 root_desc: Dictionary; the entire original deserialized discovery document.
789 http_method: String; the HTTP method used to call the API method described
790 in method_desc.
791
792Returns:
793 The updated Dictionary stored in the 'parameters' key of the method
794 description dictionary.
795
796</pre>
797 <dl class="fields">
798 </dl>
799</td></tr></table>
800</div>
801<a name="_fix_up_media_upload"></a>
802<div class="private">
803<table class="details" border="1" cellpadding="3"
804 cellspacing="0" width="100%" bgcolor="white">
805<tr><td>
806 <table width="100%" cellpadding="0" cellspacing="0" border="0">
807 <tr valign="top"><td>
808 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
809 <span class="sig-arg">root_desc</span>,
810 <span class="sig-arg">path_url</span>,
811 <span class="sig-arg">parameters</span>)</span>
812 </h3>
813 </td><td align="right" valign="top"
814 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>&nbsp;
815 </td>
816 </tr></table>
817
818 <pre class="literalblock">
819Updates parameters of API by adding 'media_body' if supported by method.
820
821SIDE EFFECTS: If the method supports media upload and has a required body,
822sets body to be optional (required=False) instead. Also, if there is a
823'mediaUpload' in the method description, adds 'media_upload' key to
824parameters.
825
826Args:
827 method_desc: Dictionary with metadata describing an API method. Value comes
828 from the dictionary of methods stored in the 'methods' key in the
829 deserialized discovery document.
830 root_desc: Dictionary; the entire original deserialized discovery document.
831 path_url: String; the relative URL for the API method. Relative to the API
832 root, which is specified in the discovery document.
833 parameters: A dictionary describing method parameters for method described
834 in method_desc.
835
836Returns:
837 Triple (accept, max_size, media_path_url) where:
838 - accept is a list of strings representing what content types are
839 accepted for media upload. Defaults to empty list if not in the
840 discovery document.
841 - max_size is a long representing the max size in bytes allowed for a
842 media upload. Defaults to 0L if not in the discovery document.
843 - media_path_url is a String; the absolute URI for media upload for the
844 API method. Constructed using the API root URI and service path from
845 the discovery document and the relative path for the API method. If
846 media upload is not supported, this is None.
847
848</pre>
849 <dl class="fields">
850 </dl>
851</td></tr></table>
852</div>
853<a name="_fix_up_method_description"></a>
854<div class="private">
855<table class="details" border="1" cellpadding="3"
856 cellspacing="0" width="100%" bgcolor="white">
857<tr><td>
858 <table width="100%" cellpadding="0" cellspacing="0" border="0">
859 <tr valign="top"><td>
860 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>,
861 <span class="sig-arg">root_desc</span>)</span>
862 </h3>
863 </td><td align="right" valign="top"
864 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>&nbsp;
865 </td>
866 </tr></table>
867
868 <pre class="literalblock">
869Updates a method description in a discovery document.
870
871SIDE EFFECTS: Changes the parameters dictionary in the method description with
872extra parameters which are used locally.
873
874Args:
875 method_desc: Dictionary with metadata describing an API method. Value comes
876 from the dictionary of methods stored in the 'methods' key in the
877 deserialized discovery document.
878 root_desc: Dictionary; the entire original deserialized discovery document.
879
880Returns:
881 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
882 where:
883 - path_url is a String; the relative URL for the API method. Relative to
884 the API root, which is specified in the discovery document.
885 - http_method is a String; the HTTP method used to call the API method
886 described in the method description.
887 - method_id is a String; the name of the RPC method associated with the
888 API method, and is in the method description in the 'id' key.
889 - accept is a list of strings representing what content types are
890 accepted for media upload. Defaults to empty list if not in the
891 discovery document.
892 - max_size is a long representing the max size in bytes allowed for a
893 media upload. Defaults to 0L if not in the discovery document.
894 - media_path_url is a String; the absolute URI for media upload for the
895 API method. Constructed using the API root URI and service path from
896 the discovery document and the relative path for the API method. If
897 media upload is not supported, this is None.
898
899</pre>
900 <dl class="fields">
901 </dl>
902</td></tr></table>
903</div>
904<a name="createMethod"></a>
905<div class="private">
906<table class="details" border="1" cellpadding="3"
907 cellspacing="0" width="100%" bgcolor="white">
908<tr><td>
909 <table width="100%" cellpadding="0" cellspacing="0" border="0">
910 <tr valign="top"><td>
911 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
912 <span class="sig-arg">methodDesc</span>,
913 <span class="sig-arg">rootDesc</span>,
914 <span class="sig-arg">schema</span>)</span>
915 </h3>
916 </td><td align="right" valign="top"
917 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
918 </td>
919 </tr></table>
920
921 <pre class="literalblock">
922Creates a method for attaching to a Resource.
923
924Args:
925 methodName: string, name of the method to use.
926 methodDesc: object, fragment of deserialized discovery document that
927 describes the method.
928 rootDesc: object, the entire deserialized discovery document.
929 schema: object, mapping of schema names to schema descriptions.
930
931</pre>
932 <dl class="fields">
933 </dl>
934</td></tr></table>
935</div>
936<a name="createNextMethod"></a>
937<div class="private">
938<table class="details" border="1" cellpadding="3"
939 cellspacing="0" width="100%" bgcolor="white">
940<tr><td>
941 <table width="100%" cellpadding="0" cellspacing="0" border="0">
942 <tr valign="top"><td>
943 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>)</span>
944 </h3>
945 </td><td align="right" valign="top"
946 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
947 </td>
948 </tr></table>
949
950 <pre class="literalblock">
951Creates any _next methods for attaching to a Resource.
952
953The _next methods allow for easy iteration through list() responses.
954
955Args:
956 methodName: string, name of the method to use.
957
958</pre>
959 <dl class="fields">
960 </dl>
961</td></tr></table>
962</div>
963<br />
964<!-- ==================== VARIABLES DETAILS ==================== -->
965<a name="section-VariablesDetails"></a>
966<table class="details" border="1" cellpadding="3"
967 cellspacing="0" width="100%" bgcolor="white">
968<tr bgcolor="#70b0f0" class="table-header">
969 <td colspan="2" class="table-header">
970 <table border="0" cellpadding="0" cellspacing="0" width="100%">
971 <tr valign="top">
972 <td align="left"><span class="table-header">Variables Details</span></td>
973 <td align="right" valign="top"
974 ><span class="options">[<a href="#section-VariablesDetails"
975 class="privatelink" onclick="toggle_private();"
976 >hide private</a>]</span></td>
977 </tr>
978 </table>
979 </td>
980</tr>
981</table>
982<a name="DISCOVERY_URI"></a>
983<div class="private">
984<table class="details" border="1" cellpadding="3"
985 cellspacing="0" width="100%" bgcolor="white">
986<tr><td>
987 <h3 class="epydoc">DISCOVERY_URI</h3>
988
989 <dl class="fields">
990 </dl>
991 <dl class="fields">
992 <dt>Value:</dt>
993 <dd><table><tr><td><pre class="variable">
994'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
995st'
996</pre></td></tr></table>
997</dd>
998 </dl>
999</td></tr></table>
1000</div>
1001<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
1002<div class="private">
1003<table class="details" border="1" cellpadding="3"
1004 cellspacing="0" width="100%" bgcolor="white">
1005<tr><td>
1006 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
1007
1008 <dl class="fields">
1009 </dl>
1010 <dl class="fields">
1011 <dt>Value:</dt>
1012 <dd><table><tr><td><pre class="variable">
1013{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1014e,}
1015</pre></td></tr></table>
1016</dd>
1017 </dl>
1018</td></tr></table>
1019</div>
1020<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
1021<div class="private">
1022<table class="details" border="1" cellpadding="3"
1023 cellspacing="0" width="100%" bgcolor="white">
1024<tr><td>
1025 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
1026
1027 <dl class="fields">
1028 </dl>
1029 <dl class="fields">
1030 <dt>Value:</dt>
1031 <dd><table><tr><td><pre class="variable">
1032{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1033e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}
1034</pre></td></tr></table>
1035</dd>
1036 </dl>
1037</td></tr></table>
1038</div>
1039<a name="STACK_QUERY_PARAMETERS"></a>
1040<div class="private">
1041<table class="details" border="1" cellpadding="3"
1042 cellspacing="0" width="100%" bgcolor="white">
1043<tr><td>
1044 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
1045
1046 <dl class="fields">
1047 </dl>
1048 <dl class="fields">
1049 <dt>Value:</dt>
1050 <dd><table><tr><td><pre class="variable">
1051frozenset(['trace', 'pp', 'userip', 'strict'])
1052</pre></td></tr></table>
1053</dd>
1054 </dl>
1055</td></tr></table>
1056</div>
1057<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
1058<div class="private">
1059<table class="details" border="1" cellpadding="3"
1060 cellspacing="0" width="100%" bgcolor="white">
1061<tr><td>
1062 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
1063
1064 <dl class="fields">
1065 </dl>
1066 <dl class="fields">
1067 <dt>Value:</dt>
1068 <dd><table><tr><td><pre class="variable">
1069{'type': 'string', 'location': 'query'}
1070</pre></td></tr></table>
1071</dd>
1072 </dl>
1073</td></tr></table>
1074</div>
1075<br />
1076<!-- ==================== NAVIGATION BAR ==================== -->
1077<table class="navbar" border="0" width="100%" cellpadding="0"
1078 bgcolor="#a0c0ff" cellspacing="0">
1079 <tr valign="middle">
1080 <!-- Home link -->
1081 <th>&nbsp;&nbsp;&nbsp;<a
1082 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1083
1084 <!-- Tree link -->
1085 <th>&nbsp;&nbsp;&nbsp;<a
1086 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1087
1088 <!-- Index link -->
1089 <th>&nbsp;&nbsp;&nbsp;<a
1090 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1091
1092 <!-- Help link -->
1093 <th>&nbsp;&nbsp;&nbsp;<a
1094 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1095
1096 <th class="navbar" width="100%"></th>
1097 </tr>
1098</table>
1099<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1100 <tr>
1101 <td align="left" class="footer">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]1102 Generated by Epydoc 3.0.1 on Mon Mar 2 13:38:41 2015
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1103 </td>
1104 <td align="right" class="footer">
1105 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1106 >http://epydoc.sourceforge.net</a>
1107 </td>
1108 </tr>
1109</table>
1110
1111<script type="text/javascript">
1112 <!--
1113 // Private objects are initially displayed (because if
1114 // javascript is turned off then we want them to be
1115 // visible); but by default, we want to hide them. So hide
1116 // them unless we have a cookie that says to show them.
1117 checkCookie();
1118 // -->
1119</script>
1120</body>
1121</html>