Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f0edebc7e6c6077cfed0404ae7e73bb0e6ef1776 / . / docs / epy / apiclient.schema._SchemaToStruct-class.html
blob: c092e7f9809e645804a6f920f26d9a393beee787 [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 Gregorio1b425aa2012-08-24 12:04:34 -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">*args</span>,
94 <span class="summary-sig-arg">**kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]95 Constructor.</td>
96 <td align="right" valign="top">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]97 <span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]98
99 </td>
100 </tr>
101 </table>
102
103 </td>
104 </tr>
105<tr>
106 <td width="15%" align="right" valign="top" class="summary">
107 <span class="summary-type">&nbsp;</span>
108 </td><td class="summary">
109 <table width="100%" cellpadding="0" cellspacing="0" border="0">
110 <tr>
111 <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>,
112 <span class="summary-sig-arg">text</span>)</span><br />
113 Add text as a line to the output.</td>
114 <td align="right" valign="top">
115 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emit">source&nbsp;code</a></span>
116
117 </td>
118 </tr>
119 </table>
120
121 </td>
122 </tr>
123<tr>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type">&nbsp;</span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
128 <tr>
129 <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>,
130 <span class="summary-sig-arg">text</span>)</span><br />
131 Add text to the output, but with no line terminator.</td>
132 <td align="right" valign="top">
133 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitBegin">source&nbsp;code</a></span>
134
135 </td>
136 </tr>
137 </table>
138
139 </td>
140 </tr>
141<tr>
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type">&nbsp;</span>
144 </td><td class="summary">
145 <table width="100%" cellpadding="0" cellspacing="0" border="0">
146 <tr>
147 <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>,
148 <span class="summary-sig-arg">text</span>,
149 <span class="summary-sig-arg">comment</span>)</span><br />
150 Add text and comment to the output with line terminator.</td>
151 <td align="right" valign="top">
152 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitEnd">source&nbsp;code</a></span>
153
154 </td>
155 </tr>
156 </table>
157
158 </td>
159 </tr>
160<tr>
161 <td width="15%" align="right" valign="top" class="summary">
162 <span class="summary-type">&nbsp;</span>
163 </td><td class="summary">
164 <table width="100%" cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <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 />
167 Increase indentation level.</td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.indent">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a name="undent"></a><span class="summary-sig-name">undent</span>(<span class="summary-sig-arg">self</span>)</span><br />
184 Decrease indentation level.</td>
185 <td align="right" valign="top">
186 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.undent">source&nbsp;code</a></span>
187
188 </td>
189 </tr>
190 </table>
191
192 </td>
193 </tr>
194<tr class="private">
195 <td width="15%" align="right" valign="top" class="summary">
196 <span class="summary-type">&nbsp;</span>
197 </td><td class="summary">
198 <table width="100%" cellpadding="0" cellspacing="0" border="0">
199 <tr>
200 <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>,
201 <span class="summary-sig-arg">schema</span>)</span><br />
202 Prototype object based on the schema, in Python code with comments.</td>
203 <td align="right" valign="top">
204 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct._to_str_impl">source&nbsp;code</a></span>
205
206 </td>
207 </tr>
208 </table>
209
210 </td>
211 </tr>
212<tr>
213 <td width="15%" align="right" valign="top" class="summary">
214 <span class="summary-type">&nbsp;</span>
215 </td><td class="summary">
216 <table width="100%" cellpadding="0" cellspacing="0" border="0">
217 <tr>
218 <td><span class="summary-sig"><a href="apiclient.schema._SchemaToStruct-class.html#to_str" class="summary-sig-name">to_str</a>(<span class="summary-sig-arg">self</span>,
219 <span class="summary-sig-arg">from_cache</span>)</span><br />
220 Prototype object based on the schema, in Python code with comments.</td>
221 <td align="right" valign="top">
222 <span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.to_str">source&nbsp;code</a></span>
223
224 </td>
225 </tr>
226 </table>
227
228 </td>
229 </tr>
230 <tr>
231 <td colspan="2" class="summary">
232 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
233 <code>__delattr__</code>,
234 <code>__format__</code>,
235 <code>__getattribute__</code>,
236 <code>__hash__</code>,
237 <code>__new__</code>,
238 <code>__reduce__</code>,
239 <code>__reduce_ex__</code>,
240 <code>__repr__</code>,
241 <code>__setattr__</code>,
242 <code>__sizeof__</code>,
243 <code>__str__</code>,
244 <code>__subclasshook__</code>
245 </p>
246 </td>
247 </tr>
248</table>
249<!-- ==================== PROPERTIES ==================== -->
250<a name="section-Properties"></a>
251<table class="summary" border="1" cellpadding="3"
252 cellspacing="0" width="100%" bgcolor="white">
253<tr bgcolor="#70b0f0" class="table-header">
254 <td colspan="2" class="table-header">
255 <table border="0" cellpadding="0" cellspacing="0" width="100%">
256 <tr valign="top">
257 <td align="left"><span class="table-header">Properties</span></td>
258 <td align="right" valign="top"
259 ><span class="options">[<a href="#section-Properties"
260 class="privatelink" onclick="toggle_private();"
261 >hide private</a>]</span></td>
262 </tr>
263 </table>
264 </td>
265</tr>
266 <tr>
267 <td colspan="2" class="summary">
268 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
269 <code>__class__</code>
270 </p>
271 </td>
272 </tr>
273</table>
274<!-- ==================== METHOD DETAILS ==================== -->
275<a name="section-MethodDetails"></a>
276<table class="details" border="1" cellpadding="3"
277 cellspacing="0" width="100%" bgcolor="white">
278<tr bgcolor="#70b0f0" class="table-header">
279 <td colspan="2" class="table-header">
280 <table border="0" cellpadding="0" cellspacing="0" width="100%">
281 <tr valign="top">
282 <td align="left"><span class="table-header">Method Details</span></td>
283 <td align="right" valign="top"
284 ><span class="options">[<a href="#section-MethodDetails"
285 class="privatelink" onclick="toggle_private();"
286 >hide private</a>]</span></td>
287 </tr>
288 </table>
289 </td>
290</tr>
291</table>
292<a name="__init__"></a>
293<div>
294<table class="details" border="1" cellpadding="3"
295 cellspacing="0" width="100%" bgcolor="white">
296<tr><td>
297 <table width="100%" cellpadding="0" cellspacing="0" border="0">
298 <tr valign="top"><td>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]299 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
300 <span class="sig-arg">**kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]301 <br /><em class="fname">(Constructor)</em>
302 </h3>
303 </td><td align="right" valign="top"
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]304 ><span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]305 </td>
306 </tr></table>
307
308 <pre class="literalblock">
309Constructor.
310
311Args:
312 schema: object, Parsed JSON schema.
313 seen: list, List of names of schema already seen while parsing. Used to
314 handle recursive definitions.
315 dent: int, Initial indentation depth.
316
317</pre>
318 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]319 <dt>Decorators:</dt>
320 <dd><ul class="nomargin-top">
321 <li><code>@util.positional(3)</code></li>
322 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]323 <dt>Overrides:
324 object.__init__
325 </dt>
326 </dl>
327</td></tr></table>
328</div>
329<a name="emit"></a>
330<div>
331<table class="details" border="1" cellpadding="3"
332 cellspacing="0" width="100%" bgcolor="white">
333<tr><td>
334 <table width="100%" cellpadding="0" cellspacing="0" border="0">
335 <tr valign="top"><td>
336 <h3 class="epydoc"><span class="sig"><span class="sig-name">emit</span>(<span class="sig-arg">self</span>,
337 <span class="sig-arg">text</span>)</span>
338 </h3>
339 </td><td align="right" valign="top"
340 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emit">source&nbsp;code</a></span>&nbsp;
341 </td>
342 </tr></table>
343
344 <pre class="literalblock">
345Add text as a line to the output.
346
347Args:
348 text: string, Text to output.
349
350</pre>
351 <dl class="fields">
352 </dl>
353</td></tr></table>
354</div>
355<a name="emitBegin"></a>
356<div>
357<table class="details" border="1" cellpadding="3"
358 cellspacing="0" width="100%" bgcolor="white">
359<tr><td>
360 <table width="100%" cellpadding="0" cellspacing="0" border="0">
361 <tr valign="top"><td>
362 <h3 class="epydoc"><span class="sig"><span class="sig-name">emitBegin</span>(<span class="sig-arg">self</span>,
363 <span class="sig-arg">text</span>)</span>
364 </h3>
365 </td><td align="right" valign="top"
366 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitBegin">source&nbsp;code</a></span>&nbsp;
367 </td>
368 </tr></table>
369
370 <pre class="literalblock">
371Add text to the output, but with no line terminator.
372
373Args:
374 text: string, Text to output.
375
376
377</pre>
378 <dl class="fields">
379 </dl>
380</td></tr></table>
381</div>
382<a name="emitEnd"></a>
383<div>
384<table class="details" border="1" cellpadding="3"
385 cellspacing="0" width="100%" bgcolor="white">
386<tr><td>
387 <table width="100%" cellpadding="0" cellspacing="0" border="0">
388 <tr valign="top"><td>
389 <h3 class="epydoc"><span class="sig"><span class="sig-name">emitEnd</span>(<span class="sig-arg">self</span>,
390 <span class="sig-arg">text</span>,
391 <span class="sig-arg">comment</span>)</span>
392 </h3>
393 </td><td align="right" valign="top"
394 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.emitEnd">source&nbsp;code</a></span>&nbsp;
395 </td>
396 </tr></table>
397
398 <pre class="literalblock">
399Add text and comment to the output with line terminator.
400
401Args:
402 text: string, Text to output.
403 comment: string, Python comment.
404
405</pre>
406 <dl class="fields">
407 </dl>
408</td></tr></table>
409</div>
410<a name="_to_str_impl"></a>
411<div class="private">
412<table class="details" border="1" cellpadding="3"
413 cellspacing="0" width="100%" bgcolor="white">
414<tr><td>
415 <table width="100%" cellpadding="0" cellspacing="0" border="0">
416 <tr valign="top"><td>
417 <h3 class="epydoc"><span class="sig"><span class="sig-name">_to_str_impl</span>(<span class="sig-arg">self</span>,
418 <span class="sig-arg">schema</span>)</span>
419 </h3>
420 </td><td align="right" valign="top"
421 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct._to_str_impl">source&nbsp;code</a></span>&nbsp;
422 </td>
423 </tr></table>
424
425 <pre class="literalblock">
426Prototype object based on the schema, in Python code with comments.
427
428Args:
429 schema: object, Parsed JSON schema file.
430
431Returns:
432 Prototype object based on the schema, in Python code with comments.
433
434</pre>
435 <dl class="fields">
436 </dl>
437</td></tr></table>
438</div>
439<a name="to_str"></a>
440<div>
441<table class="details" border="1" cellpadding="3"
442 cellspacing="0" width="100%" bgcolor="white">
443<tr><td>
444 <table width="100%" cellpadding="0" cellspacing="0" border="0">
445 <tr valign="top"><td>
446 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_str</span>(<span class="sig-arg">self</span>,
447 <span class="sig-arg">from_cache</span>)</span>
448 </h3>
449 </td><td align="right" valign="top"
450 ><span class="codelink"><a href="apiclient.schema-pysrc.html#_SchemaToStruct.to_str">source&nbsp;code</a></span>&nbsp;
451 </td>
452 </tr></table>
453
454 <pre class="literalblock">
455Prototype object based on the schema, in Python code with comments.
456
457Args:
458 from_cache: callable(name, seen), Callable that retrieves an object
459 prototype for a schema with the given name. Seen is a list of schema
460 names already seen as we recursively descend the schema definition.
461
462Returns:
463 Prototype object based on the schema, in Python code with comments.
464 The lines of the code will all be properly indented.
465
466</pre>
467 <dl class="fields">
468 </dl>
469</td></tr></table>
470</div>
471<br />
472<!-- ==================== NAVIGATION BAR ==================== -->
473<table class="navbar" border="0" width="100%" cellpadding="0"
474 bgcolor="#a0c0ff" cellspacing="0">
475 <tr valign="middle">
476
477 <!-- Tree link -->
478 <th>&nbsp;&nbsp;&nbsp;<a
479 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
480
481 <!-- Index link -->
482 <th>&nbsp;&nbsp;&nbsp;<a
483 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
484
485 <!-- Help link -->
486 <th>&nbsp;&nbsp;&nbsp;<a
487 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
488
489 <th class="navbar" width="100%"></th>
490 </tr>
491</table>
492<table border="0" cellpadding="0" cellspacing="0" width="100%%">
493 <tr>
494 <td align="left" class="footer">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]495 Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]496 </td>
497 <td align="right" class="footer">
498 <a target="mainFrame" href="http://epydoc.sourceforge.net"
499 >http://epydoc.sourceforge.net</a>
500 </td>
501 </tr>
502</table>
503
504<script type="text/javascript">
505 <!--
506 // Private objects are initially displayed (because if
507 // javascript is turned off then we want them to be
508 // visible); but by default, we want to hide them. So hide
509 // them unless we have a cookie that says to show them.
510 checkCookie();
511 // -->
512</script>
513</body>
514</html>