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>defaultResolver</td></tr><tr><td>dictResolver</td></tr><tr><td>listResolver</td></tr><tr><td>setResolver</td></tr> |
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> |
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> |
|
37 <td>Class used to resolve from array.array including some meta data.</td> |
|
38 </tr><tr> |
33 <td><a href="#BaseResolver">BaseResolver</a></td> |
39 <td><a href="#BaseResolver">BaseResolver</a></td> |
34 <td>Base class of the resolver class tree.</td> |
40 <td>Base class of the resolver class tree.</td> |
35 </tr><tr> |
41 </tr><tr> |
36 <td><a href="#DefaultResolver">DefaultResolver</a></td> |
42 <td><a href="#DefaultResolver">DefaultResolver</a></td> |
37 <td>Class used to resolve the default way.</td> |
43 <td>Class used to resolve the default way.</td> |
54 </tr><tr> |
69 </tr><tr> |
55 <td><a href="#getType">getType</a></td> |
70 <td><a href="#getType">getType</a></td> |
56 <td>Public method to get the type information for an object.</td> |
71 <td>Public method to get the type information for an object.</td> |
57 </tr> |
72 </tr> |
58 </table> |
73 </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 /> |
|
101 <a NAME="ArrayResolver" ID="ArrayResolver"></a> |
|
102 <h2>ArrayResolver</h2> |
|
103 <p> |
|
104 Class used to resolve from array.array including some meta data. |
|
105 </p> |
|
106 <h3>Derived from</h3> |
|
107 BaseResolver |
|
108 <h3>Class Attributes</h3> |
|
109 <table> |
|
110 <tr><td>TypeCodeMap</td></tr> |
|
111 </table> |
|
112 <h3>Class Methods</h3> |
|
113 <table> |
|
114 <tr><td>None</td></tr> |
|
115 </table> |
|
116 <h3>Methods</h3> |
|
117 <table> |
|
118 <tr> |
|
119 <td><a href="#ArrayResolver.getDictionary">getDictionary</a></td> |
|
120 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
121 </tr><tr> |
|
122 <td><a href="#ArrayResolver.resolve">resolve</a></td> |
|
123 <td>Public method to get an attribute from a variable.</td> |
|
124 </tr> |
|
125 </table> |
|
126 <h3>Static Methods</h3> |
|
127 <table> |
|
128 <tr><td>None</td></tr> |
|
129 </table> |
|
130 <a NAME="ArrayResolver.getDictionary" ID="ArrayResolver.getDictionary"></a> |
|
131 <h4>ArrayResolver.getDictionary</h4> |
|
132 <b>getDictionary</b>(<i>var</i>) |
|
133 <p> |
|
134 Public method to get the attributes of a variable as a dictionary. |
|
135 </p><dl> |
|
136 <dt><i>var</i> (any)</dt> |
|
137 <dd> |
|
138 variable to be converted |
|
139 </dd> |
|
140 </dl><dl> |
|
141 <dt>Returns:</dt> |
|
142 <dd> |
|
143 dictionary containing the variable attributes |
|
144 </dd> |
|
145 </dl><dl> |
|
146 <dt>Return Type:</dt> |
|
147 <dd> |
|
148 dict |
|
149 </dd> |
|
150 </dl><a NAME="ArrayResolver.resolve" ID="ArrayResolver.resolve"></a> |
|
151 <h4>ArrayResolver.resolve</h4> |
|
152 <b>resolve</b>(<i>var, attribute</i>) |
|
153 <p> |
|
154 Public method to get an attribute from a variable. |
|
155 </p><dl> |
|
156 <dt><i>var</i> (tuple or list)</dt> |
|
157 <dd> |
|
158 variable to extract an attribute or value from |
|
159 </dd><dt><i>attribute</i> (str)</dt> |
|
160 <dd> |
|
161 id of the value to extract |
|
162 </dd> |
|
163 </dl><dl> |
|
164 <dt>Returns:</dt> |
|
165 <dd> |
|
166 value of the attribute |
|
167 </dd> |
|
168 </dl><dl> |
|
169 <dt>Return Type:</dt> |
|
170 <dd> |
|
171 any |
|
172 </dd> |
|
173 </dl> |
|
174 <div align="right"><a href="#top">Up</a></div> |
59 <hr /><hr /> |
175 <hr /><hr /> |
60 <a NAME="BaseResolver" ID="BaseResolver"></a> |
176 <a NAME="BaseResolver" ID="BaseResolver"></a> |
61 <h2>BaseResolver</h2> |
177 <h2>BaseResolver</h2> |
62 <p> |
178 <p> |
63 Base class of the resolver class tree. |
179 Base class of the resolver class tree. |
235 <tr><td>None</td></tr> |
351 <tr><td>None</td></tr> |
236 </table> |
352 </table> |
237 <h3>Methods</h3> |
353 <h3>Methods</h3> |
238 <table> |
354 <table> |
239 <tr> |
355 <tr> |
240 <td><a href="#DictResolver.__keyToStr">__keyToStr</a></td> |
|
241 <td>Private method to get a string representation for a key.</td> |
|
242 </tr><tr> |
|
243 <td><a href="#DictResolver.getDictionary">getDictionary</a></td> |
356 <td><a href="#DictResolver.getDictionary">getDictionary</a></td> |
244 <td>Public method to get the attributes of a variable as a dictionary.</td> |
357 <td>Public method to get the attributes of a variable as a dictionary.</td> |
245 </tr><tr> |
358 </tr><tr> |
|
359 <td><a href="#DictResolver.keyToStr">keyToStr</a></td> |
|
360 <td>Public method to get a string representation for a key.</td> |
|
361 </tr><tr> |
246 <td><a href="#DictResolver.resolve">resolve</a></td> |
362 <td><a href="#DictResolver.resolve">resolve</a></td> |
247 <td>Public method to get an attribute from a variable.</td> |
363 <td>Public method to get an attribute from a variable.</td> |
248 </tr> |
364 </tr> |
249 </table> |
365 </table> |
250 <h3>Static Methods</h3> |
366 <h3>Static Methods</h3> |
251 <table> |
367 <table> |
252 <tr><td>None</td></tr> |
368 <tr><td>None</td></tr> |
253 </table> |
369 </table> |
254 <a NAME="DictResolver.__keyToStr" ID="DictResolver.__keyToStr"></a> |
370 <a NAME="DictResolver.getDictionary" ID="DictResolver.getDictionary"></a> |
255 <h4>DictResolver.__keyToStr</h4> |
|
256 <b>__keyToStr</b>(<i>key</i>) |
|
257 <p> |
|
258 Private method to get a string representation for a key. |
|
259 </p><dl> |
|
260 <dt><i>key</i> (any)</dt> |
|
261 <dd> |
|
262 key to be converted |
|
263 </dd> |
|
264 </dl><dl> |
|
265 <dt>Returns:</dt> |
|
266 <dd> |
|
267 string representation of the given key |
|
268 </dd> |
|
269 </dl><dl> |
|
270 <dt>Return Type:</dt> |
|
271 <dd> |
|
272 str |
|
273 </dd> |
|
274 </dl><a NAME="DictResolver.getDictionary" ID="DictResolver.getDictionary"></a> |
|
275 <h4>DictResolver.getDictionary</h4> |
371 <h4>DictResolver.getDictionary</h4> |
276 <b>getDictionary</b>(<i>var</i>) |
372 <b>getDictionary</b>(<i>var</i>) |
277 <p> |
373 <p> |
278 Public method to get the attributes of a variable as a dictionary. |
374 Public method to get the attributes of a variable as a dictionary. |
279 </p><dl> |
375 </p><dl> |
390 any |
506 any |
391 </dd> |
507 </dd> |
392 </dl> |
508 </dl> |
393 <div align="right"><a href="#top">Up</a></div> |
509 <div align="right"><a href="#top">Up</a></div> |
394 <hr /><hr /> |
510 <hr /><hr /> |
|
511 <a NAME="MultiValueDictResolver" ID="MultiValueDictResolver"></a> |
|
512 <h2>MultiValueDictResolver</h2> |
|
513 <p> |
|
514 Class used to resolve from Django multi value dictionaries. |
|
515 </p> |
|
516 <h3>Derived from</h3> |
|
517 DictResolver |
|
518 <h3>Class Attributes</h3> |
|
519 <table> |
|
520 <tr><td>None</td></tr> |
|
521 </table> |
|
522 <h3>Class Methods</h3> |
|
523 <table> |
|
524 <tr><td>None</td></tr> |
|
525 </table> |
|
526 <h3>Methods</h3> |
|
527 <table> |
|
528 <tr> |
|
529 <td><a href="#MultiValueDictResolver.getDictionary">getDictionary</a></td> |
|
530 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
531 </tr><tr> |
|
532 <td><a href="#MultiValueDictResolver.resolve">resolve</a></td> |
|
533 <td>Public method to get an attribute from a variable.</td> |
|
534 </tr> |
|
535 </table> |
|
536 <h3>Static Methods</h3> |
|
537 <table> |
|
538 <tr><td>None</td></tr> |
|
539 </table> |
|
540 <a NAME="MultiValueDictResolver.getDictionary" ID="MultiValueDictResolver.getDictionary"></a> |
|
541 <h4>MultiValueDictResolver.getDictionary</h4> |
|
542 <b>getDictionary</b>(<i>var</i>) |
|
543 <p> |
|
544 Public method to get the attributes of a variable as a dictionary. |
|
545 </p><dl> |
|
546 <dt><i>var</i> (any)</dt> |
|
547 <dd> |
|
548 variable to be converted |
|
549 </dd> |
|
550 </dl><dl> |
|
551 <dt>Returns:</dt> |
|
552 <dd> |
|
553 dictionary containing the variable attributes |
|
554 </dd> |
|
555 </dl><dl> |
|
556 <dt>Return Type:</dt> |
|
557 <dd> |
|
558 dict |
|
559 </dd> |
|
560 </dl><a NAME="MultiValueDictResolver.resolve" ID="MultiValueDictResolver.resolve"></a> |
|
561 <h4>MultiValueDictResolver.resolve</h4> |
|
562 <b>resolve</b>(<i>var, attribute</i>) |
|
563 <p> |
|
564 Public method to get an attribute from a variable. |
|
565 </p><dl> |
|
566 <dt><i>var</i> (dict)</dt> |
|
567 <dd> |
|
568 variable to extract an attribute or value from |
|
569 </dd><dt><i>attribute</i> (str)</dt> |
|
570 <dd> |
|
571 name of the attribute to extract |
|
572 </dd> |
|
573 </dl><dl> |
|
574 <dt>Returns:</dt> |
|
575 <dd> |
|
576 value of the attribute |
|
577 </dd> |
|
578 </dl><dl> |
|
579 <dt>Return Type:</dt> |
|
580 <dd> |
|
581 any |
|
582 </dd> |
|
583 </dl> |
|
584 <div align="right"><a href="#top">Up</a></div> |
|
585 <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> |
|
613 <h2>NdArrayResolver</h2> |
|
614 <p> |
|
615 Class used to resolve from numpy ndarray including some meta data. |
|
616 </p> |
|
617 <h3>Derived from</h3> |
|
618 BaseResolver |
|
619 <h3>Class Attributes</h3> |
|
620 <table> |
|
621 <tr><td>None</td></tr> |
|
622 </table> |
|
623 <h3>Class Methods</h3> |
|
624 <table> |
|
625 <tr><td>None</td></tr> |
|
626 </table> |
|
627 <h3>Methods</h3> |
|
628 <table> |
|
629 <tr> |
|
630 <td><a href="#NdArrayResolver.__isNumeric">__isNumeric</a></td> |
|
631 <td>Private method to check, if an array is of a numeric type.</td> |
|
632 </tr><tr> |
|
633 <td><a href="#NdArrayResolver.getDictionary">getDictionary</a></td> |
|
634 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
635 </tr><tr> |
|
636 <td><a href="#NdArrayResolver.resolve">resolve</a></td> |
|
637 <td>Public method to get an attribute from a variable.</td> |
|
638 </tr> |
|
639 </table> |
|
640 <h3>Static Methods</h3> |
|
641 <table> |
|
642 <tr><td>None</td></tr> |
|
643 </table> |
|
644 <a NAME="NdArrayResolver.__isNumeric" ID="NdArrayResolver.__isNumeric"></a> |
|
645 <h4>NdArrayResolver.__isNumeric</h4> |
|
646 <b>__isNumeric</b>(<i>arr</i>) |
|
647 <p> |
|
648 Private method to check, if an array is of a numeric type. |
|
649 </p><dl> |
|
650 <dt><i>arr</i> (ndarray)</dt> |
|
651 <dd> |
|
652 array to check |
|
653 </dd> |
|
654 </dl><dl> |
|
655 <dt>Returns:</dt> |
|
656 <dd> |
|
657 flag indicating a numeric array |
|
658 </dd> |
|
659 </dl><dl> |
|
660 <dt>Return Type:</dt> |
|
661 <dd> |
|
662 bool |
|
663 </dd> |
|
664 </dl><a NAME="NdArrayResolver.getDictionary" ID="NdArrayResolver.getDictionary"></a> |
|
665 <h4>NdArrayResolver.getDictionary</h4> |
|
666 <b>getDictionary</b>(<i>var</i>) |
|
667 <p> |
|
668 Public method to get the attributes of a variable as a dictionary. |
|
669 </p><dl> |
|
670 <dt><i>var</i> (any)</dt> |
|
671 <dd> |
|
672 variable to be converted |
|
673 </dd> |
|
674 </dl><dl> |
|
675 <dt>Returns:</dt> |
|
676 <dd> |
|
677 dictionary containing the variable attributes |
|
678 </dd> |
|
679 </dl><dl> |
|
680 <dt>Return Type:</dt> |
|
681 <dd> |
|
682 dict |
|
683 </dd> |
|
684 </dl><a NAME="NdArrayResolver.resolve" ID="NdArrayResolver.resolve"></a> |
|
685 <h4>NdArrayResolver.resolve</h4> |
|
686 <b>resolve</b>(<i>var, attribute</i>) |
|
687 <p> |
|
688 Public method to get an attribute from a variable. |
|
689 </p><dl> |
|
690 <dt><i>var</i> (tuple or list)</dt> |
|
691 <dd> |
|
692 variable to extract an attribute or value from |
|
693 </dd><dt><i>attribute</i> (str)</dt> |
|
694 <dd> |
|
695 id of the value to extract |
|
696 </dd> |
|
697 </dl><dl> |
|
698 <dt>Returns:</dt> |
|
699 <dd> |
|
700 value of the attribute |
|
701 </dd> |
|
702 </dl><dl> |
|
703 <dt>Return Type:</dt> |
|
704 <dd> |
|
705 any |
|
706 </dd> |
|
707 </dl> |
|
708 <div align="right"><a href="#top">Up</a></div> |
|
709 <hr /><hr /> |
395 <a NAME="SetResolver" ID="SetResolver"></a> |
710 <a NAME="SetResolver" ID="SetResolver"></a> |
396 <h2>SetResolver</h2> |
711 <h2>SetResolver</h2> |
397 <p> |
712 <p> |
398 Class used to resolve from a set or frozenset. |
713 Class used to resolve from a set or frozenset. |
399 </p> |
714 </p> |