23 <p> |
23 <p> |
24 Module implementing classes and functions to dump variable contents. |
24 Module implementing classes and functions to dump variable contents. |
25 </p> |
25 </p> |
26 <h3>Global Attributes</h3> |
26 <h3>Global Attributes</h3> |
27 <table> |
27 <table> |
28 <tr><td>MaxItemsToHandle</td></tr><tr><td>TooLargeAttribute</td></tr><tr><td>TooLargeMessage</td></tr><tr><td>_TypeMap</td></tr><tr><td>arrayResolver</td></tr><tr><td>defaultResolver</td></tr><tr><td>dictResolver</td></tr><tr><td>listResolver</td></tr><tr><td>multiValueDictResolver</td></tr><tr><td>ndarrayResolver</td></tr><tr><td>setResolver</td></tr> |
28 <tr><td>_TypeMap</td></tr><tr><td>arrayResolver</td></tr><tr><td>defaultResolver</td></tr><tr><td>dictResolver</td></tr><tr><td>dictViewResolver</td></tr><tr><td>listResolver</td></tr><tr><td>multiValueDictResolver</td></tr><tr><td>ndarrayResolver</td></tr><tr><td>setResolver</td></tr> |
29 </table> |
29 </table> |
30 <h3>Classes</h3> |
30 <h3>Classes</h3> |
31 <table> |
31 <table> |
32 <tr> |
32 <tr> |
33 <td><a href="#ArrayItemsContainer">ArrayItemsContainer</a></td> |
|
34 <td>Class to store array.array items.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#ArrayResolver">ArrayResolver</a></td> |
33 <td><a href="#ArrayResolver">ArrayResolver</a></td> |
37 <td>Class used to resolve from array.array including some meta data.</td> |
34 <td>Class used to resolve from array.array including some meta data.</td> |
38 </tr><tr> |
35 </tr><tr> |
39 <td><a href="#BaseResolver">BaseResolver</a></td> |
36 <td><a href="#BaseResolver">BaseResolver</a></td> |
40 <td>Base class of the resolver class tree.</td> |
37 <td>Base class of the resolver class tree.</td> |
43 <td>Class used to resolve the default way.</td> |
40 <td>Class used to resolve the default way.</td> |
44 </tr><tr> |
41 </tr><tr> |
45 <td><a href="#DictResolver">DictResolver</a></td> |
42 <td><a href="#DictResolver">DictResolver</a></td> |
46 <td>Class used to resolve from a dictionary.</td> |
43 <td>Class used to resolve from a dictionary.</td> |
47 </tr><tr> |
44 </tr><tr> |
|
45 <td><a href="#DictViewResolver">DictViewResolver</a></td> |
|
46 <td>Class used to resolve from dict views.</td> |
|
47 </tr><tr> |
48 <td><a href="#ListResolver">ListResolver</a></td> |
48 <td><a href="#ListResolver">ListResolver</a></td> |
49 <td>Class used to resolve from a tuple or list.</td> |
49 <td>Class used to resolve from a tuple or list.</td> |
50 </tr><tr> |
50 </tr><tr> |
51 <td><a href="#MultiValueDictResolver">MultiValueDictResolver</a></td> |
51 <td><a href="#MultiValueDictResolver">MultiValueDictResolver</a></td> |
52 <td>Class used to resolve from Django multi value dictionaries.</td> |
52 <td>Class used to resolve from Django multi value dictionaries.</td> |
53 </tr><tr> |
53 </tr><tr> |
54 <td><a href="#NdArrayItemsContainer">NdArrayItemsContainer</a></td> |
|
55 <td>Class to store ndarray items.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#NdArrayResolver">NdArrayResolver</a></td> |
54 <td><a href="#NdArrayResolver">NdArrayResolver</a></td> |
58 <td>Class used to resolve from numpy ndarray including some meta data.</td> |
55 <td>Class used to resolve from numpy ndarray including some meta data.</td> |
59 </tr><tr> |
56 </tr><tr> |
60 <td><a href="#SetResolver">SetResolver</a></td> |
57 <td><a href="#SetResolver">SetResolver</a></td> |
61 <td>Class used to resolve from a set or frozenset.</td> |
58 <td>Class used to resolve from a set or frozenset.</td> |
69 </tr><tr> |
66 </tr><tr> |
70 <td><a href="#getType">getType</a></td> |
67 <td><a href="#getType">getType</a></td> |
71 <td>Public method to get the type information for an object.</td> |
68 <td>Public method to get the type information for an object.</td> |
72 </tr> |
69 </tr> |
73 </table> |
70 </table> |
74 <hr /><hr /> |
|
75 <a NAME="ArrayItemsContainer" ID="ArrayItemsContainer"></a> |
|
76 <h2>ArrayItemsContainer</h2> |
|
77 <p> |
|
78 Class to store array.array items. |
|
79 </p> |
|
80 <h3>Derived from</h3> |
|
81 None |
|
82 <h3>Class Attributes</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <h3>Class Methods</h3> |
|
87 <table> |
|
88 <tr><td>None</td></tr> |
|
89 </table> |
|
90 <h3>Methods</h3> |
|
91 <table> |
|
92 <tr><td>None</td></tr> |
|
93 </table> |
|
94 <h3>Static Methods</h3> |
|
95 <table> |
|
96 <tr><td>None</td></tr> |
|
97 </table> |
|
98 |
|
99 <div align="right"><a href="#top">Up</a></div> |
|
100 <hr /><hr /> |
71 <hr /><hr /> |
101 <a NAME="ArrayResolver" ID="ArrayResolver"></a> |
72 <a NAME="ArrayResolver" ID="ArrayResolver"></a> |
102 <h2>ArrayResolver</h2> |
73 <h2>ArrayResolver</h2> |
103 <p> |
74 <p> |
104 Class used to resolve from array.array including some meta data. |
75 Class used to resolve from array.array including some meta data. |
220 </dl><dl> |
191 </dl><dl> |
221 <dt>Return Type:</dt> |
192 <dt>Return Type:</dt> |
222 <dd> |
193 <dd> |
223 dict |
194 dict |
224 </dd> |
195 </dd> |
225 </dl><dl> |
|
226 <dt>Raises <b>NotImplementedError</b>:</dt> |
|
227 <dd> |
|
228 raised to indicate a missing |
|
229 implementation |
|
230 </dd> |
|
231 </dl><a NAME="BaseResolver.resolve" ID="BaseResolver.resolve"></a> |
196 </dl><a NAME="BaseResolver.resolve" ID="BaseResolver.resolve"></a> |
232 <h4>BaseResolver.resolve</h4> |
197 <h4>BaseResolver.resolve</h4> |
233 <b>resolve</b>(<i>var, attribute</i>) |
198 <b>resolve</b>(<i>var, attribute</i>) |
234 <p> |
199 <p> |
235 Public method to get an attribute from a variable. |
200 Public method to get an attribute from a variable. |
249 </dl><dl> |
214 </dl><dl> |
250 <dt>Return Type:</dt> |
215 <dt>Return Type:</dt> |
251 <dd> |
216 <dd> |
252 any |
217 any |
253 </dd> |
218 </dd> |
254 </dl><dl> |
|
255 <dt>Raises <b>NotImplementedError</b>:</dt> |
|
256 <dd> |
|
257 raised to indicate a missing |
|
258 implementation |
|
259 </dd> |
|
260 </dl> |
219 </dl> |
261 <div align="right"><a href="#top">Up</a></div> |
220 <div align="right"><a href="#top">Up</a></div> |
262 <hr /><hr /> |
221 <hr /><hr /> |
263 <a NAME="DefaultResolver" ID="DefaultResolver"></a> |
222 <a NAME="DefaultResolver" ID="DefaultResolver"></a> |
264 <h2>DefaultResolver</h2> |
223 <h2>DefaultResolver</h2> |
278 <h3>Methods</h3> |
237 <h3>Methods</h3> |
279 <table> |
238 <table> |
280 <tr> |
239 <tr> |
281 <td><a href="#DefaultResolver.getDictionary">getDictionary</a></td> |
240 <td><a href="#DefaultResolver.getDictionary">getDictionary</a></td> |
282 <td>Public method to get the attributes of a variable as a dictionary.</td> |
241 <td>Public method to get the attributes of a variable as a dictionary.</td> |
283 </tr><tr> |
|
284 <td><a href="#DefaultResolver.resolve">resolve</a></td> |
|
285 <td>Public method to get an attribute from a variable.</td> |
|
286 </tr> |
242 </tr> |
287 </table> |
243 </table> |
288 <h3>Static Methods</h3> |
244 <h3>Static Methods</h3> |
289 <table> |
245 <table> |
290 <tr><td>None</td></tr> |
246 <tr><td>None</td></tr> |
306 </dd> |
262 </dd> |
307 </dl><dl> |
263 </dl><dl> |
308 <dt>Return Type:</dt> |
264 <dt>Return Type:</dt> |
309 <dd> |
265 <dd> |
310 dict |
266 dict |
311 </dd> |
|
312 </dl><a NAME="DefaultResolver.resolve" ID="DefaultResolver.resolve"></a> |
|
313 <h4>DefaultResolver.resolve</h4> |
|
314 <b>resolve</b>(<i>var, attribute</i>) |
|
315 <p> |
|
316 Public method to get an attribute from a variable. |
|
317 </p><dl> |
|
318 <dt><i>var</i> (any)</dt> |
|
319 <dd> |
|
320 variable to extract an attribute or value from |
|
321 </dd><dt><i>attribute</i> (str)</dt> |
|
322 <dd> |
|
323 name of the attribute to extract |
|
324 </dd> |
|
325 </dl><dl> |
|
326 <dt>Returns:</dt> |
|
327 <dd> |
|
328 value of the attribute |
|
329 </dd> |
|
330 </dl><dl> |
|
331 <dt>Return Type:</dt> |
|
332 <dd> |
|
333 any |
|
334 </dd> |
267 </dd> |
335 </dl> |
268 </dl> |
336 <div align="right"><a href="#top">Up</a></div> |
269 <div align="right"><a href="#top">Up</a></div> |
337 <hr /><hr /> |
270 <hr /><hr /> |
338 <a NAME="DictResolver" ID="DictResolver"></a> |
271 <a NAME="DictResolver" ID="DictResolver"></a> |
431 any |
364 any |
432 </dd> |
365 </dd> |
433 </dl> |
366 </dl> |
434 <div align="right"><a href="#top">Up</a></div> |
367 <div align="right"><a href="#top">Up</a></div> |
435 <hr /><hr /> |
368 <hr /><hr /> |
|
369 <a NAME="DictViewResolver" ID="DictViewResolver"></a> |
|
370 <h2>DictViewResolver</h2> |
|
371 <p> |
|
372 Class used to resolve from dict views. |
|
373 </p> |
|
374 <h3>Derived from</h3> |
|
375 ListResolver |
|
376 <h3>Class Attributes</h3> |
|
377 <table> |
|
378 <tr><td>None</td></tr> |
|
379 </table> |
|
380 <h3>Class Methods</h3> |
|
381 <table> |
|
382 <tr><td>None</td></tr> |
|
383 </table> |
|
384 <h3>Methods</h3> |
|
385 <table> |
|
386 <tr> |
|
387 <td><a href="#DictViewResolver.getDictionary">getDictionary</a></td> |
|
388 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
389 </tr><tr> |
|
390 <td><a href="#DictViewResolver.resolve">resolve</a></td> |
|
391 <td>Public method to get an attribute from a variable.</td> |
|
392 </tr> |
|
393 </table> |
|
394 <h3>Static Methods</h3> |
|
395 <table> |
|
396 <tr><td>None</td></tr> |
|
397 </table> |
|
398 <a NAME="DictViewResolver.getDictionary" ID="DictViewResolver.getDictionary"></a> |
|
399 <h4>DictViewResolver.getDictionary</h4> |
|
400 <b>getDictionary</b>(<i>var</i>) |
|
401 <p> |
|
402 Public method to get the attributes of a variable as a dictionary. |
|
403 </p><dl> |
|
404 <dt><i>var</i> (any)</dt> |
|
405 <dd> |
|
406 variable to be converted |
|
407 </dd> |
|
408 </dl><dl> |
|
409 <dt>Returns:</dt> |
|
410 <dd> |
|
411 dictionary containing the variable attributes |
|
412 </dd> |
|
413 </dl><dl> |
|
414 <dt>Return Type:</dt> |
|
415 <dd> |
|
416 dict |
|
417 </dd> |
|
418 </dl><a NAME="DictViewResolver.resolve" ID="DictViewResolver.resolve"></a> |
|
419 <h4>DictViewResolver.resolve</h4> |
|
420 <b>resolve</b>(<i>var, attribute</i>) |
|
421 <p> |
|
422 Public method to get an attribute from a variable. |
|
423 </p><dl> |
|
424 <dt><i>var</i> (tuple or list)</dt> |
|
425 <dd> |
|
426 variable to extract an attribute or value from |
|
427 </dd><dt><i>attribute</i> (str)</dt> |
|
428 <dd> |
|
429 id of the value to extract |
|
430 </dd> |
|
431 </dl><dl> |
|
432 <dt>Returns:</dt> |
|
433 <dd> |
|
434 value of the attribute |
|
435 </dd> |
|
436 </dl><dl> |
|
437 <dt>Return Type:</dt> |
|
438 <dd> |
|
439 any |
|
440 </dd> |
|
441 </dl> |
|
442 <div align="right"><a href="#top">Up</a></div> |
|
443 <hr /><hr /> |
436 <a NAME="ListResolver" ID="ListResolver"></a> |
444 <a NAME="ListResolver" ID="ListResolver"></a> |
437 <h2>ListResolver</h2> |
445 <h2>ListResolver</h2> |
438 <p> |
446 <p> |
439 Class used to resolve from a tuple or list. |
447 Class used to resolve from a tuple or list. |
440 </p> |
448 </p> |
581 any |
589 any |
582 </dd> |
590 </dd> |
583 </dl> |
591 </dl> |
584 <div align="right"><a href="#top">Up</a></div> |
592 <div align="right"><a href="#top">Up</a></div> |
585 <hr /><hr /> |
593 <hr /><hr /> |
586 <a NAME="NdArrayItemsContainer" ID="NdArrayItemsContainer"></a> |
|
587 <h2>NdArrayItemsContainer</h2> |
|
588 <p> |
|
589 Class to store ndarray items. |
|
590 </p> |
|
591 <h3>Derived from</h3> |
|
592 None |
|
593 <h3>Class Attributes</h3> |
|
594 <table> |
|
595 <tr><td>None</td></tr> |
|
596 </table> |
|
597 <h3>Class Methods</h3> |
|
598 <table> |
|
599 <tr><td>None</td></tr> |
|
600 </table> |
|
601 <h3>Methods</h3> |
|
602 <table> |
|
603 <tr><td>None</td></tr> |
|
604 </table> |
|
605 <h3>Static Methods</h3> |
|
606 <table> |
|
607 <tr><td>None</td></tr> |
|
608 </table> |
|
609 |
|
610 <div align="right"><a href="#top">Up</a></div> |
|
611 <hr /><hr /> |
|
612 <a NAME="NdArrayResolver" ID="NdArrayResolver"></a> |
594 <a NAME="NdArrayResolver" ID="NdArrayResolver"></a> |
613 <h2>NdArrayResolver</h2> |
595 <h2>NdArrayResolver</h2> |
614 <p> |
596 <p> |
615 Class used to resolve from numpy ndarray including some meta data. |
597 Class used to resolve from numpy ndarray including some meta data. |
616 </p> |
598 </p> |
801 object to get type information for |
783 object to get type information for |
802 </dd> |
784 </dd> |
803 </dl><dl> |
785 </dl><dl> |
804 <dt>Returns:</dt> |
786 <dt>Returns:</dt> |
805 <dd> |
787 <dd> |
806 tuple containing the type, type name, type string and resolver |
788 tuple containing the type name, type string and resolver |
807 </dd> |
789 </dd> |
808 </dl><dl> |
790 </dl><dl> |
809 <dt>Return Type:</dt> |
791 <dt>Return Type:</dt> |
810 <dd> |
792 <dd> |
811 tuple of type, str, str, BaseResolver |
793 tuple of str, str, BaseResolver |
812 </dd> |
794 </dd> |
813 </dl> |
795 </dl> |
814 <div align="right"><a href="#top">Up</a></div> |
796 <div align="right"><a href="#top">Up</a></div> |
815 <hr /> |
797 <hr /> |
816 </body></html> |
798 </body></html> |