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