Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f4839b0d74d8678a8e08964ce3e5899a77d8375f / . / docs / epy / apiclient.schema._SchemaToStruct-class.html
blob: a813ccc43cdc55512b251ba12da2ed2e3fbdd42e [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -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>apiclient.schema._SchemaToStruct</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.schema-module.html">Module&nbsp;schema</a> ::
39 Class&nbsp;_SchemaToStruct
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.schema._SchemaToStruct-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 _SchemaToStruct</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for__schematos" name="class_hierarchy_for__schematos">
59<area shape="rect" href="apiclient.schema._SchemaToStruct-class.html" title="_SchemaToStruct" alt="" coords="5,5,128,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]60</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]61 <img src="class_hierarchy_for__schematos.gif" alt='' usemap="#class_hierarchy_for__schematos" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]62</center>
63</center>
64<hr />
65<pre class="literalblock">
66Convert schema to a prototype object.
67
68</pre>
69
70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></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">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]93 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">schema</span>,
95 <span class="summary-sig-arg">seen</span>,
96 <span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]97 Constructor.</td>
98 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]99 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.__init__">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]100
101 </td>
102 </tr>
103 </table>
104
105 </td>
106 </tr>
107<tr>
108 <td width="15%" align="right" valign="top" class="summary">
109 <span class="summary-type">&nbsp;</span>
110 </td><td class="summary">
111 <table width="100%" cellpadding="0" cellspacing="0" border="0">
112 <tr>
113 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#emit" class="summary-sig-name">emit</a>(<span class="summary-sig-arg">self</span>,
114 <span class="summary-sig-arg">text</span>)</span><br />
115 Add text as a line to the output.</td>
116 <td align="right" valign="top">
117 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emit">source&nbsp;code</a></span>
118
119 </td>
120 </tr>
121 </table>
122
123 </td>
124 </tr>
125<tr>
126 <td width="15%" align="right" valign="top" class="summary">
127 <span class="summary-type">&nbsp;</span>
128 </td><td class="summary">
129 <table width="100%" cellpadding="0" cellspacing="0" border="0">
130 <tr>
131 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#emitBegin" class="summary-sig-name">emitBegin</a>(<span class="summary-sig-arg">self</span>,
132 <span class="summary-sig-arg">text</span>)</span><br />
133 Add text to the output, but with no line terminator.</td>
134 <td align="right" valign="top">
135 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitBegin">source&nbsp;code</a></span>
136
137 </td>
138 </tr>
139 </table>
140
141 </td>
142 </tr>
143<tr>
144 <td width="15%" align="right" valign="top" class="summary">
145 <span class="summary-type">&nbsp;</span>
146 </td><td class="summary">
147 <table width="100%" cellpadding="0" cellspacing="0" border="0">
148 <tr>
149 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#emitEnd" class="summary-sig-name">emitEnd</a>(<span class="summary-sig-arg">self</span>,
150 <span class="summary-sig-arg">text</span>,
151 <span class="summary-sig-arg">comment</span>)</span><br />
152 Add text and comment to the output with line terminator.</td>
153 <td align="right" valign="top">
154 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitEnd">source&nbsp;code</a></span>
155
156 </td>
157 </tr>
158 </table>
159
160 </td>
161 </tr>
162<tr>
163 <td width="15%" align="right" valign="top" class="summary">
164 <span class="summary-type">&nbsp;</span>
165 </td><td class="summary">
166 <table width="100%" cellpadding="0" cellspacing="0" border="0">
167 <tr>
168 <td><span class="summary-sig"><a name="indent"></a><span class="summary-sig-name">indent</span>(<span class="summary-sig-arg">self</span>)</span><br />
169 Increase indentation level.</td>
170 <td align="right" valign="top">
171 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.indent">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 name="undent"></a><span class="summary-sig-name">undent</span>(<span class="summary-sig-arg">self</span>)</span><br />
186 Decrease indentation level.</td>
187 <td align="right" valign="top">
188 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.undent">source&nbsp;code</a></span>
189
190 </td>
191 </tr>
192 </table>
193
194 </td>
195 </tr>
196<tr class="private">
197 <td width="15%" align="right" valign="top" class="summary">
198 <span class="summary-type">&nbsp;</span>
199 </td><td class="summary">
200 <table width="100%" cellpadding="0" cellspacing="0" border="0">
201 <tr>
202 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#_to_str_impl" class="summary-sig-name" onclick="show_private();">_to_str_impl</a>(<span class="summary-sig-arg">self</span>,
203 <span class="summary-sig-arg">schema</span>)</span><br />
204 Prototype object based on the schema, in Python code with comments.</td>
205 <td align="right" valign="top">
206 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct._to_str_impl">source&nbsp;code</a></span>
207
208 </td>
209 </tr>
210 </table>
211
212 </td>
213 </tr>
214<tr>
215 <td width="15%" align="right" valign="top" class="summary">
216 <span class="summary-type">&nbsp;</span>
217 </td><td class="summary">
218 <table width="100%" cellpadding="0" cellspacing="0" border="0">
219 <tr>
220 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#to_str" class="summary-sig-name">to_str</a>(<span class="summary-sig-arg">self</span>,
221 <span class="summary-sig-arg">from_cache</span>)</span><br />
222 Prototype object based on the schema, in Python code with comments.</td>
223 <td align="right" valign="top">
224 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.to_str">source&nbsp;code</a></span>
225
226 </td>
227 </tr>
228 </table>
229
230 </td>
231 </tr>
232 <tr>
233 <td colspan="2" class="summary">
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<!-- ==================== PROPERTIES ==================== -->
252<a name="section-Properties"></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">Properties</span></td>
260 <td align="right" valign="top"
261 ><span class="options">[<a href="#section-Properties"
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>object</code></b>:
271 <code>__class__</code>
272 </p>
273 </td>
274 </tr>
275</table>
276<!-- ==================== METHOD DETAILS ==================== -->
277<a name="section-MethodDetails"></a>
278<table class="details" 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">Method Details</span></td>
285 <td align="right" valign="top"
286 ><span class="options">[<a href="#section-MethodDetails"
287 class="privatelink" onclick="toggle_private();"
288 >hide private</a>]</span></td>
289 </tr>
290 </table>
291 </td>
292</tr>
293</table>
294<a name="__init__"></a>
295<div>
296<table class="details" border="1" cellpadding="3"
297 cellspacing="0" width="100%" bgcolor="white">
298<tr><td>
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
300 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]301 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
302 <span class="sig-arg">schema</span>,
303 <span class="sig-arg">seen</span>,
304 <span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]305 <br /><em class="fname">(Constructor)</em>
306 </h3>
307 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]308 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]309 </td>
310 </tr></table>
311
312 <pre class="literalblock">
313Constructor.
314
315Args:
316 schema: object, Parsed JSON schema.
317 seen: list, List of names of schema already seen while parsing. Used to
318 handle recursive definitions.
319 dent: int, Initial indentation depth.
320
321</pre>
322 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]323 <dt>Decorators:</dt>
324 <dd><ul class="nomargin-top">
325 <li><code>@util.positional(3)</code></li>
326 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]327 <dt>Overrides:
328 object.__init__
329 </dt>
330 </dl>
331</td></tr></table>
332</div>
333<a name="emit"></a>
334<div>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr><td>
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr valign="top"><td>
340 <h3 class="epydoc"><span class="sig"><span class="sig-name">emit</span>(<span class="sig-arg">self</span>,
341 <span class="sig-arg">text</span>)</span>
342 </h3>
343 </td><td align="right" valign="top"
344 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emit">source&nbsp;code</a></span>&nbsp;
345 </td>
346 </tr></table>
347
348 <pre class="literalblock">
349Add text as a line to the output.
350
351Args:
352 text: string, Text to output.
353
354</pre>
355 <dl class="fields">
356 </dl>
357</td></tr></table>
358</div>
359<a name="emitBegin"></a>
360<div>
361<table class="details" border="1" cellpadding="3"
362 cellspacing="0" width="100%" bgcolor="white">
363<tr><td>
364 <table width="100%" cellpadding="0" cellspacing="0" border="0">
365 <tr valign="top"><td>
366 <h3 class="epydoc"><span class="sig"><span class="sig-name">emitBegin</span>(<span class="sig-arg">self</span>,
367 <span class="sig-arg">text</span>)</span>
368 </h3>
369 </td><td align="right" valign="top"
370 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitBegin">source&nbsp;code</a></span>&nbsp;
371 </td>
372 </tr></table>
373
374 <pre class="literalblock">
375Add text to the output, but with no line terminator.
376
377Args:
378 text: string, Text to output.
379
380
381</pre>
382 <dl class="fields">
383 </dl>
384</td></tr></table>
385</div>
386<a name="emitEnd"></a>
387<div>
388<table class="details" border="1" cellpadding="3"
389 cellspacing="0" width="100%" bgcolor="white">
390<tr><td>
391 <table width="100%" cellpadding="0" cellspacing="0" border="0">
392 <tr valign="top"><td>
393 <h3 class="epydoc"><span class="sig"><span class="sig-name">emitEnd</span>(<span class="sig-arg">self</span>,
394 <span class="sig-arg">text</span>,
395 <span class="sig-arg">comment</span>)</span>
396 </h3>
397 </td><td align="right" valign="top"
398 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitEnd">source&nbsp;code</a></span>&nbsp;
399 </td>
400 </tr></table>
401
402 <pre class="literalblock">
403Add text and comment to the output with line terminator.
404
405Args:
406 text: string, Text to output.
407 comment: string, Python comment.
408
409</pre>
410 <dl class="fields">
411 </dl>
412</td></tr></table>
413</div>
414<a name="_to_str_impl"></a>
415<div class="private">
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">_to_str_impl</span>(<span class="sig-arg">self</span>,
422 <span class="sig-arg">schema</span>)</span>
423 </h3>
424 </td><td align="right" valign="top"
425 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct._to_str_impl">source&nbsp;code</a></span>&nbsp;
426 </td>
427 </tr></table>
428
429 <pre class="literalblock">
430Prototype object based on the schema, in Python code with comments.
431
432Args:
433 schema: object, Parsed JSON schema file.
434
435Returns:
436 Prototype object based on the schema, in Python code with comments.
437
438</pre>
439 <dl class="fields">
440 </dl>
441</td></tr></table>
442</div>
443<a name="to_str"></a>
444<div>
445<table class="details" border="1" cellpadding="3"
446 cellspacing="0" width="100%" bgcolor="white">
447<tr><td>
448 <table width="100%" cellpadding="0" cellspacing="0" border="0">
449 <tr valign="top"><td>
450 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_str</span>(<span class="sig-arg">self</span>,
451 <span class="sig-arg">from_cache</span>)</span>
452 </h3>
453 </td><td align="right" valign="top"
454 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.to_str">source&nbsp;code</a></span>&nbsp;
455 </td>
456 </tr></table>
457
458 <pre class="literalblock">
459Prototype object based on the schema, in Python code with comments.
460
461Args:
462 from_cache: callable(name, seen), Callable that retrieves an object
463 prototype for a schema with the given name. Seen is a list of schema
464 names already seen as we recursively descend the schema definition.
465
466Returns:
467 Prototype object based on the schema, in Python code with comments.
468 The lines of the code will all be properly indented.
469
470</pre>
471 <dl class="fields">
472 </dl>
473</td></tr></table>
474</div>
475<br />
476<!-- ==================== NAVIGATION BAR ==================== -->
477<table class="navbar" border="0" width="100%" cellpadding="0"
478 bgcolor="#a0c0ff" cellspacing="0">
479 <tr valign="middle">
480
481 <!-- Tree link -->
482 <th>&nbsp;&nbsp;&nbsp;<a
483 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
484
485 <!-- Index link -->
486 <th>&nbsp;&nbsp;&nbsp;<a
487 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
488
489 <!-- Help link -->
490 <th>&nbsp;&nbsp;&nbsp;<a
491 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
492
493 <th class="navbar" width="100%"></th>
494 </tr>
495</table>
496<table border="0" cellpadding="0" cellspacing="0" width="100%%">
497 <tr>
498 <td align="left" class="footer">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]499 Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:13 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]500 </td>
501 <td align="right" class="footer">
502 <a target="mainFrame" href="http://epydoc.sourceforge.net"
503 >http://epydoc.sourceforge.net</a>
504 </td>
505 </tr>
506</table>
507
508<script type="text/javascript">
509 <!--
510 // Private objects are initially displayed (because if
511 // javascript is turned off then we want them to be
512 // visible); but by default, we want to hide them. So hide
513 // them unless we have a cookie that says to show them.
514 checkCookie();
515 // -->
516</script>
517</body>
518</html>