|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.DebugClients.Python.DebugVariables</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.DebugClients.Python.DebugVariables</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing classes and functions to dump variable contents. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <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> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#ArrayResolver">ArrayResolver</a></td> |
|
39 <td>Class used to resolve from array.array including some meta data.</td> |
|
40 </tr> |
|
41 <tr> |
|
42 <td><a href="#BaseResolver">BaseResolver</a></td> |
|
43 <td>Base class of the resolver class tree.</td> |
|
44 </tr> |
|
45 <tr> |
|
46 <td><a href="#DefaultResolver">DefaultResolver</a></td> |
|
47 <td>Class used to resolve the default way.</td> |
|
48 </tr> |
|
49 <tr> |
|
50 <td><a href="#DictResolver">DictResolver</a></td> |
|
51 <td>Class used to resolve from a dictionary.</td> |
|
52 </tr> |
|
53 <tr> |
|
54 <td><a href="#DictViewResolver">DictViewResolver</a></td> |
|
55 <td>Class used to resolve from dict views.</td> |
|
56 </tr> |
|
57 <tr> |
|
58 <td><a href="#ListResolver">ListResolver</a></td> |
|
59 <td>Class used to resolve from a tuple or list.</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#MultiValueDictResolver">MultiValueDictResolver</a></td> |
|
63 <td>Class used to resolve from Django multi value dictionaries.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#NdArrayResolver">NdArrayResolver</a></td> |
|
67 <td>Class used to resolve from numpy ndarray including some meta data.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#SetResolver">SetResolver</a></td> |
|
71 <td>Class used to resolve from a set or frozenset.</td> |
|
72 </tr> |
|
73 </table> |
|
74 <h3>Functions</h3> |
|
75 |
|
76 <table> |
|
77 |
|
78 <tr> |
|
79 <td><a href="#_initTypeMap">_initTypeMap</a></td> |
|
80 <td>Protected function to initialize the type map.</td> |
|
81 </tr> |
|
82 <tr> |
|
83 <td><a href="#getType">getType</a></td> |
|
84 <td>Public method to get the type information for an object.</td> |
|
85 </tr> |
|
86 </table> |
|
87 <hr /> |
|
88 <hr /> |
|
89 <a NAME="ArrayResolver" ID="ArrayResolver"></a> |
|
90 <h2>ArrayResolver</h2> |
|
91 |
|
92 <p> |
|
93 Class used to resolve from array.array including some meta data. |
|
94 </p> |
|
95 <h3>Derived from</h3> |
|
96 BaseResolver |
|
97 <h3>Class Attributes</h3> |
|
98 |
|
99 <table> |
|
100 <tr><td>TypeCodeMap</td></tr> |
|
101 </table> |
|
102 <h3>Class Methods</h3> |
|
103 |
|
104 <table> |
|
105 <tr><td>None</td></tr> |
|
106 </table> |
|
107 <h3>Methods</h3> |
|
108 |
|
109 <table> |
|
110 |
|
111 <tr> |
|
112 <td><a href="#ArrayResolver.getDictionary">getDictionary</a></td> |
|
113 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
114 </tr> |
|
115 <tr> |
|
116 <td><a href="#ArrayResolver.resolve">resolve</a></td> |
|
117 <td>Public method to get an attribute from a variable.</td> |
|
118 </tr> |
|
119 </table> |
|
120 <h3>Static Methods</h3> |
|
121 |
|
122 <table> |
|
123 <tr><td>None</td></tr> |
|
124 </table> |
|
125 |
|
126 <a NAME="ArrayResolver.getDictionary" ID="ArrayResolver.getDictionary"></a> |
|
127 <h4>ArrayResolver.getDictionary</h4> |
|
128 <b>getDictionary</b>(<i>var</i>) |
|
129 |
|
130 <p> |
|
131 Public method to get the attributes of a variable as a dictionary. |
|
132 </p> |
|
133 <dl> |
|
134 |
|
135 <dt><i>var</i> (any)</dt> |
|
136 <dd> |
|
137 variable to be converted |
|
138 </dd> |
|
139 </dl> |
|
140 <dl> |
|
141 <dt>Yield:</dt> |
|
142 <dd> |
|
143 tuple containing the batch start index and a dictionary |
|
144 containing the variable attributes |
|
145 </dd> |
|
146 </dl> |
|
147 <dl> |
|
148 <dt>Yield Type:</dt> |
|
149 <dd> |
|
150 tuple of (int, dict) |
|
151 </dd> |
|
152 </dl> |
|
153 <a NAME="ArrayResolver.resolve" ID="ArrayResolver.resolve"></a> |
|
154 <h4>ArrayResolver.resolve</h4> |
|
155 <b>resolve</b>(<i>var, attribute</i>) |
|
156 |
|
157 <p> |
|
158 Public method to get an attribute from a variable. |
|
159 </p> |
|
160 <dl> |
|
161 |
|
162 <dt><i>var</i> (tuple or list)</dt> |
|
163 <dd> |
|
164 variable to extract an attribute or value from |
|
165 </dd> |
|
166 <dt><i>attribute</i> (str)</dt> |
|
167 <dd> |
|
168 id of the value to extract |
|
169 </dd> |
|
170 </dl> |
|
171 <dl> |
|
172 <dt>Return:</dt> |
|
173 <dd> |
|
174 value of the attribute |
|
175 </dd> |
|
176 </dl> |
|
177 <dl> |
|
178 <dt>Return Type:</dt> |
|
179 <dd> |
|
180 any |
|
181 </dd> |
|
182 </dl> |
|
183 <div align="right"><a href="#top">Up</a></div> |
|
184 <hr /> |
|
185 <hr /> |
|
186 <a NAME="BaseResolver" ID="BaseResolver"></a> |
|
187 <h2>BaseResolver</h2> |
|
188 |
|
189 <p> |
|
190 Base class of the resolver class tree. |
|
191 </p> |
|
192 <h3>Derived from</h3> |
|
193 None |
|
194 <h3>Class Attributes</h3> |
|
195 |
|
196 <table> |
|
197 <tr><td>None</td></tr> |
|
198 </table> |
|
199 <h3>Class Methods</h3> |
|
200 |
|
201 <table> |
|
202 <tr><td>None</td></tr> |
|
203 </table> |
|
204 <h3>Methods</h3> |
|
205 |
|
206 <table> |
|
207 |
|
208 <tr> |
|
209 <td><a href="#BaseResolver.getDictionary">getDictionary</a></td> |
|
210 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
211 </tr> |
|
212 <tr> |
|
213 <td><a href="#BaseResolver.resolve">resolve</a></td> |
|
214 <td>Public method to get an attribute from a variable.</td> |
|
215 </tr> |
|
216 </table> |
|
217 <h3>Static Methods</h3> |
|
218 |
|
219 <table> |
|
220 <tr><td>None</td></tr> |
|
221 </table> |
|
222 |
|
223 <a NAME="BaseResolver.getDictionary" ID="BaseResolver.getDictionary"></a> |
|
224 <h4>BaseResolver.getDictionary</h4> |
|
225 <b>getDictionary</b>(<i>var</i>) |
|
226 |
|
227 <p> |
|
228 Public method to get the attributes of a variable as a dictionary. |
|
229 </p> |
|
230 <dl> |
|
231 |
|
232 <dt><i>var</i> (any)</dt> |
|
233 <dd> |
|
234 variable to be converted |
|
235 </dd> |
|
236 </dl> |
|
237 <dl> |
|
238 <dt>Return:</dt> |
|
239 <dd> |
|
240 dictionary containing the variable attributes |
|
241 </dd> |
|
242 </dl> |
|
243 <dl> |
|
244 <dt>Return Type:</dt> |
|
245 <dd> |
|
246 dict |
|
247 </dd> |
|
248 </dl> |
|
249 <a NAME="BaseResolver.resolve" ID="BaseResolver.resolve"></a> |
|
250 <h4>BaseResolver.resolve</h4> |
|
251 <b>resolve</b>(<i>var, attribute</i>) |
|
252 |
|
253 <p> |
|
254 Public method to get an attribute from a variable. |
|
255 </p> |
|
256 <dl> |
|
257 |
|
258 <dt><i>var</i> (any)</dt> |
|
259 <dd> |
|
260 variable to extract an attribute or value from |
|
261 </dd> |
|
262 <dt><i>attribute</i> (str)</dt> |
|
263 <dd> |
|
264 name of the attribute to extract |
|
265 </dd> |
|
266 </dl> |
|
267 <dl> |
|
268 <dt>Return:</dt> |
|
269 <dd> |
|
270 value of the attribute |
|
271 </dd> |
|
272 </dl> |
|
273 <dl> |
|
274 <dt>Return Type:</dt> |
|
275 <dd> |
|
276 any |
|
277 </dd> |
|
278 </dl> |
|
279 <div align="right"><a href="#top">Up</a></div> |
|
280 <hr /> |
|
281 <hr /> |
|
282 <a NAME="DefaultResolver" ID="DefaultResolver"></a> |
|
283 <h2>DefaultResolver</h2> |
|
284 |
|
285 <p> |
|
286 Class used to resolve the default way. |
|
287 </p> |
|
288 <h3>Derived from</h3> |
|
289 BaseResolver |
|
290 <h3>Class Attributes</h3> |
|
291 |
|
292 <table> |
|
293 <tr><td>None</td></tr> |
|
294 </table> |
|
295 <h3>Class Methods</h3> |
|
296 |
|
297 <table> |
|
298 <tr><td>None</td></tr> |
|
299 </table> |
|
300 <h3>Methods</h3> |
|
301 |
|
302 <table> |
|
303 |
|
304 <tr> |
|
305 <td><a href="#DefaultResolver.getDictionary">getDictionary</a></td> |
|
306 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
307 </tr> |
|
308 </table> |
|
309 <h3>Static Methods</h3> |
|
310 |
|
311 <table> |
|
312 <tr><td>None</td></tr> |
|
313 </table> |
|
314 |
|
315 <a NAME="DefaultResolver.getDictionary" ID="DefaultResolver.getDictionary"></a> |
|
316 <h4>DefaultResolver.getDictionary</h4> |
|
317 <b>getDictionary</b>(<i>var</i>) |
|
318 |
|
319 <p> |
|
320 Public method to get the attributes of a variable as a dictionary. |
|
321 </p> |
|
322 <dl> |
|
323 |
|
324 <dt><i>var</i> (any)</dt> |
|
325 <dd> |
|
326 variable to be converted |
|
327 </dd> |
|
328 </dl> |
|
329 <dl> |
|
330 <dt>Yield:</dt> |
|
331 <dd> |
|
332 tuple containing the batch start index and a dictionary |
|
333 containing the variable attributes |
|
334 </dd> |
|
335 </dl> |
|
336 <dl> |
|
337 <dt>Yield Type:</dt> |
|
338 <dd> |
|
339 tuple of (int, dict) |
|
340 </dd> |
|
341 </dl> |
|
342 <div align="right"><a href="#top">Up</a></div> |
|
343 <hr /> |
|
344 <hr /> |
|
345 <a NAME="DictResolver" ID="DictResolver"></a> |
|
346 <h2>DictResolver</h2> |
|
347 |
|
348 <p> |
|
349 Class used to resolve from a dictionary. |
|
350 </p> |
|
351 <h3>Derived from</h3> |
|
352 BaseResolver |
|
353 <h3>Class Attributes</h3> |
|
354 |
|
355 <table> |
|
356 <tr><td>None</td></tr> |
|
357 </table> |
|
358 <h3>Class Methods</h3> |
|
359 |
|
360 <table> |
|
361 <tr><td>None</td></tr> |
|
362 </table> |
|
363 <h3>Methods</h3> |
|
364 |
|
365 <table> |
|
366 |
|
367 <tr> |
|
368 <td><a href="#DictResolver.getDictionary">getDictionary</a></td> |
|
369 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
370 </tr> |
|
371 <tr> |
|
372 <td><a href="#DictResolver.keyToStr">keyToStr</a></td> |
|
373 <td>Public method to get a string representation for a key.</td> |
|
374 </tr> |
|
375 <tr> |
|
376 <td><a href="#DictResolver.resolve">resolve</a></td> |
|
377 <td>Public method to get an attribute from a variable.</td> |
|
378 </tr> |
|
379 </table> |
|
380 <h3>Static Methods</h3> |
|
381 |
|
382 <table> |
|
383 <tr><td>None</td></tr> |
|
384 </table> |
|
385 |
|
386 <a NAME="DictResolver.getDictionary" ID="DictResolver.getDictionary"></a> |
|
387 <h4>DictResolver.getDictionary</h4> |
|
388 <b>getDictionary</b>(<i>var</i>) |
|
389 |
|
390 <p> |
|
391 Public method to get the attributes of a variable as a dictionary. |
|
392 </p> |
|
393 <dl> |
|
394 |
|
395 <dt><i>var</i> (any)</dt> |
|
396 <dd> |
|
397 variable to be converted |
|
398 </dd> |
|
399 </dl> |
|
400 <dl> |
|
401 <dt>Yield:</dt> |
|
402 <dd> |
|
403 tuple containing the batch start index and a dictionary |
|
404 containing the variable attributes |
|
405 </dd> |
|
406 </dl> |
|
407 <dl> |
|
408 <dt>Yield Type:</dt> |
|
409 <dd> |
|
410 tuple of (int, dict) |
|
411 </dd> |
|
412 </dl> |
|
413 <a NAME="DictResolver.keyToStr" ID="DictResolver.keyToStr"></a> |
|
414 <h4>DictResolver.keyToStr</h4> |
|
415 <b>keyToStr</b>(<i>key</i>) |
|
416 |
|
417 <p> |
|
418 Public method to get a string representation for a key. |
|
419 </p> |
|
420 <dl> |
|
421 |
|
422 <dt><i>key</i> (any)</dt> |
|
423 <dd> |
|
424 key to be converted |
|
425 </dd> |
|
426 </dl> |
|
427 <dl> |
|
428 <dt>Return:</dt> |
|
429 <dd> |
|
430 string representation of the given key |
|
431 </dd> |
|
432 </dl> |
|
433 <dl> |
|
434 <dt>Return Type:</dt> |
|
435 <dd> |
|
436 str |
|
437 </dd> |
|
438 </dl> |
|
439 <a NAME="DictResolver.resolve" ID="DictResolver.resolve"></a> |
|
440 <h4>DictResolver.resolve</h4> |
|
441 <b>resolve</b>(<i>var, attribute</i>) |
|
442 |
|
443 <p> |
|
444 Public method to get an attribute from a variable. |
|
445 </p> |
|
446 <dl> |
|
447 |
|
448 <dt><i>var</i> (dict)</dt> |
|
449 <dd> |
|
450 variable to extract an attribute or value from |
|
451 </dd> |
|
452 <dt><i>attribute</i> (str)</dt> |
|
453 <dd> |
|
454 name of the attribute to extract |
|
455 </dd> |
|
456 </dl> |
|
457 <dl> |
|
458 <dt>Return:</dt> |
|
459 <dd> |
|
460 value of the attribute |
|
461 </dd> |
|
462 </dl> |
|
463 <dl> |
|
464 <dt>Return Type:</dt> |
|
465 <dd> |
|
466 any |
|
467 </dd> |
|
468 </dl> |
|
469 <div align="right"><a href="#top">Up</a></div> |
|
470 <hr /> |
|
471 <hr /> |
|
472 <a NAME="DictViewResolver" ID="DictViewResolver"></a> |
|
473 <h2>DictViewResolver</h2> |
|
474 |
|
475 <p> |
|
476 Class used to resolve from dict views. |
|
477 </p> |
|
478 <h3>Derived from</h3> |
|
479 ListResolver |
|
480 <h3>Class Attributes</h3> |
|
481 |
|
482 <table> |
|
483 <tr><td>None</td></tr> |
|
484 </table> |
|
485 <h3>Class Methods</h3> |
|
486 |
|
487 <table> |
|
488 <tr><td>None</td></tr> |
|
489 </table> |
|
490 <h3>Methods</h3> |
|
491 |
|
492 <table> |
|
493 |
|
494 <tr> |
|
495 <td><a href="#DictViewResolver.getDictionary">getDictionary</a></td> |
|
496 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
497 </tr> |
|
498 <tr> |
|
499 <td><a href="#DictViewResolver.resolve">resolve</a></td> |
|
500 <td>Public method to get an attribute from a variable.</td> |
|
501 </tr> |
|
502 </table> |
|
503 <h3>Static Methods</h3> |
|
504 |
|
505 <table> |
|
506 <tr><td>None</td></tr> |
|
507 </table> |
|
508 |
|
509 <a NAME="DictViewResolver.getDictionary" ID="DictViewResolver.getDictionary"></a> |
|
510 <h4>DictViewResolver.getDictionary</h4> |
|
511 <b>getDictionary</b>(<i>var</i>) |
|
512 |
|
513 <p> |
|
514 Public method to get the attributes of a variable as a dictionary. |
|
515 </p> |
|
516 <dl> |
|
517 |
|
518 <dt><i>var</i> (any)</dt> |
|
519 <dd> |
|
520 variable to be converted |
|
521 </dd> |
|
522 </dl> |
|
523 <dl> |
|
524 <dt>Return:</dt> |
|
525 <dd> |
|
526 dictionary containing the variable attributes |
|
527 </dd> |
|
528 </dl> |
|
529 <dl> |
|
530 <dt>Return Type:</dt> |
|
531 <dd> |
|
532 dict |
|
533 </dd> |
|
534 </dl> |
|
535 <a NAME="DictViewResolver.resolve" ID="DictViewResolver.resolve"></a> |
|
536 <h4>DictViewResolver.resolve</h4> |
|
537 <b>resolve</b>(<i>var, attribute</i>) |
|
538 |
|
539 <p> |
|
540 Public method to get an attribute from a variable. |
|
541 </p> |
|
542 <dl> |
|
543 |
|
544 <dt><i>var</i> (tuple or list)</dt> |
|
545 <dd> |
|
546 variable to extract an attribute or value from |
|
547 </dd> |
|
548 <dt><i>attribute</i> (str)</dt> |
|
549 <dd> |
|
550 id of the value to extract |
|
551 </dd> |
|
552 </dl> |
|
553 <dl> |
|
554 <dt>Return:</dt> |
|
555 <dd> |
|
556 value of the attribute |
|
557 </dd> |
|
558 </dl> |
|
559 <dl> |
|
560 <dt>Return Type:</dt> |
|
561 <dd> |
|
562 any |
|
563 </dd> |
|
564 </dl> |
|
565 <div align="right"><a href="#top">Up</a></div> |
|
566 <hr /> |
|
567 <hr /> |
|
568 <a NAME="ListResolver" ID="ListResolver"></a> |
|
569 <h2>ListResolver</h2> |
|
570 |
|
571 <p> |
|
572 Class used to resolve from a tuple or list. |
|
573 </p> |
|
574 <h3>Derived from</h3> |
|
575 BaseResolver |
|
576 <h3>Class Attributes</h3> |
|
577 |
|
578 <table> |
|
579 <tr><td>None</td></tr> |
|
580 </table> |
|
581 <h3>Class Methods</h3> |
|
582 |
|
583 <table> |
|
584 <tr><td>None</td></tr> |
|
585 </table> |
|
586 <h3>Methods</h3> |
|
587 |
|
588 <table> |
|
589 |
|
590 <tr> |
|
591 <td><a href="#ListResolver.getDictionary">getDictionary</a></td> |
|
592 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
593 </tr> |
|
594 <tr> |
|
595 <td><a href="#ListResolver.resolve">resolve</a></td> |
|
596 <td>Public method to get an attribute from a variable.</td> |
|
597 </tr> |
|
598 </table> |
|
599 <h3>Static Methods</h3> |
|
600 |
|
601 <table> |
|
602 <tr><td>None</td></tr> |
|
603 </table> |
|
604 |
|
605 <a NAME="ListResolver.getDictionary" ID="ListResolver.getDictionary"></a> |
|
606 <h4>ListResolver.getDictionary</h4> |
|
607 <b>getDictionary</b>(<i>var</i>) |
|
608 |
|
609 <p> |
|
610 Public method to get the attributes of a variable as a dictionary. |
|
611 </p> |
|
612 <dl> |
|
613 |
|
614 <dt><i>var</i> (any)</dt> |
|
615 <dd> |
|
616 variable to be converted |
|
617 </dd> |
|
618 </dl> |
|
619 <dl> |
|
620 <dt>Yield:</dt> |
|
621 <dd> |
|
622 tuple containing the batch start index and a dictionary |
|
623 containing the variable attributes |
|
624 </dd> |
|
625 </dl> |
|
626 <dl> |
|
627 <dt>Yield Type:</dt> |
|
628 <dd> |
|
629 tuple of (int, dict) |
|
630 </dd> |
|
631 </dl> |
|
632 <a NAME="ListResolver.resolve" ID="ListResolver.resolve"></a> |
|
633 <h4>ListResolver.resolve</h4> |
|
634 <b>resolve</b>(<i>var, attribute</i>) |
|
635 |
|
636 <p> |
|
637 Public method to get an attribute from a variable. |
|
638 </p> |
|
639 <dl> |
|
640 |
|
641 <dt><i>var</i> (tuple or list)</dt> |
|
642 <dd> |
|
643 variable to extract an attribute or value from |
|
644 </dd> |
|
645 <dt><i>attribute</i> (str)</dt> |
|
646 <dd> |
|
647 name of the attribute to extract |
|
648 </dd> |
|
649 </dl> |
|
650 <dl> |
|
651 <dt>Return:</dt> |
|
652 <dd> |
|
653 value of the attribute |
|
654 </dd> |
|
655 </dl> |
|
656 <dl> |
|
657 <dt>Return Type:</dt> |
|
658 <dd> |
|
659 any |
|
660 </dd> |
|
661 </dl> |
|
662 <div align="right"><a href="#top">Up</a></div> |
|
663 <hr /> |
|
664 <hr /> |
|
665 <a NAME="MultiValueDictResolver" ID="MultiValueDictResolver"></a> |
|
666 <h2>MultiValueDictResolver</h2> |
|
667 |
|
668 <p> |
|
669 Class used to resolve from Django multi value dictionaries. |
|
670 </p> |
|
671 <h3>Derived from</h3> |
|
672 DictResolver |
|
673 <h3>Class Attributes</h3> |
|
674 |
|
675 <table> |
|
676 <tr><td>None</td></tr> |
|
677 </table> |
|
678 <h3>Class Methods</h3> |
|
679 |
|
680 <table> |
|
681 <tr><td>None</td></tr> |
|
682 </table> |
|
683 <h3>Methods</h3> |
|
684 |
|
685 <table> |
|
686 |
|
687 <tr> |
|
688 <td><a href="#MultiValueDictResolver.getDictionary">getDictionary</a></td> |
|
689 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
690 </tr> |
|
691 <tr> |
|
692 <td><a href="#MultiValueDictResolver.resolve">resolve</a></td> |
|
693 <td>Public method to get an attribute from a variable.</td> |
|
694 </tr> |
|
695 </table> |
|
696 <h3>Static Methods</h3> |
|
697 |
|
698 <table> |
|
699 <tr><td>None</td></tr> |
|
700 </table> |
|
701 |
|
702 <a NAME="MultiValueDictResolver.getDictionary" ID="MultiValueDictResolver.getDictionary"></a> |
|
703 <h4>MultiValueDictResolver.getDictionary</h4> |
|
704 <b>getDictionary</b>(<i>var</i>) |
|
705 |
|
706 <p> |
|
707 Public method to get the attributes of a variable as a dictionary. |
|
708 </p> |
|
709 <dl> |
|
710 |
|
711 <dt><i>var</i> (any)</dt> |
|
712 <dd> |
|
713 variable to be converted |
|
714 </dd> |
|
715 </dl> |
|
716 <dl> |
|
717 <dt>Yield:</dt> |
|
718 <dd> |
|
719 tuple containing the batch start index and a dictionary |
|
720 containing the variable attributes |
|
721 </dd> |
|
722 </dl> |
|
723 <dl> |
|
724 <dt>Yield Type:</dt> |
|
725 <dd> |
|
726 tuple of (int, dict) |
|
727 </dd> |
|
728 </dl> |
|
729 <a NAME="MultiValueDictResolver.resolve" ID="MultiValueDictResolver.resolve"></a> |
|
730 <h4>MultiValueDictResolver.resolve</h4> |
|
731 <b>resolve</b>(<i>var, attribute</i>) |
|
732 |
|
733 <p> |
|
734 Public method to get an attribute from a variable. |
|
735 </p> |
|
736 <dl> |
|
737 |
|
738 <dt><i>var</i> (dict)</dt> |
|
739 <dd> |
|
740 variable to extract an attribute or value from |
|
741 </dd> |
|
742 <dt><i>attribute</i> (str)</dt> |
|
743 <dd> |
|
744 name of the attribute to extract |
|
745 </dd> |
|
746 </dl> |
|
747 <dl> |
|
748 <dt>Return:</dt> |
|
749 <dd> |
|
750 value of the attribute |
|
751 </dd> |
|
752 </dl> |
|
753 <dl> |
|
754 <dt>Return Type:</dt> |
|
755 <dd> |
|
756 any |
|
757 </dd> |
|
758 </dl> |
|
759 <div align="right"><a href="#top">Up</a></div> |
|
760 <hr /> |
|
761 <hr /> |
|
762 <a NAME="NdArrayResolver" ID="NdArrayResolver"></a> |
|
763 <h2>NdArrayResolver</h2> |
|
764 |
|
765 <p> |
|
766 Class used to resolve from numpy ndarray including some meta data. |
|
767 </p> |
|
768 <h3>Derived from</h3> |
|
769 BaseResolver |
|
770 <h3>Class Attributes</h3> |
|
771 |
|
772 <table> |
|
773 <tr><td>None</td></tr> |
|
774 </table> |
|
775 <h3>Class Methods</h3> |
|
776 |
|
777 <table> |
|
778 <tr><td>None</td></tr> |
|
779 </table> |
|
780 <h3>Methods</h3> |
|
781 |
|
782 <table> |
|
783 |
|
784 <tr> |
|
785 <td><a href="#NdArrayResolver.__isNumeric">__isNumeric</a></td> |
|
786 <td>Private method to check, if an array is of a numeric type.</td> |
|
787 </tr> |
|
788 <tr> |
|
789 <td><a href="#NdArrayResolver.getDictionary">getDictionary</a></td> |
|
790 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
791 </tr> |
|
792 <tr> |
|
793 <td><a href="#NdArrayResolver.resolve">resolve</a></td> |
|
794 <td>Public method to get an attribute from a variable.</td> |
|
795 </tr> |
|
796 </table> |
|
797 <h3>Static Methods</h3> |
|
798 |
|
799 <table> |
|
800 <tr><td>None</td></tr> |
|
801 </table> |
|
802 |
|
803 <a NAME="NdArrayResolver.__isNumeric" ID="NdArrayResolver.__isNumeric"></a> |
|
804 <h4>NdArrayResolver.__isNumeric</h4> |
|
805 <b>__isNumeric</b>(<i>arr</i>) |
|
806 |
|
807 <p> |
|
808 Private method to check, if an array is of a numeric type. |
|
809 </p> |
|
810 <dl> |
|
811 |
|
812 <dt><i>arr</i> (ndarray)</dt> |
|
813 <dd> |
|
814 array to check |
|
815 </dd> |
|
816 </dl> |
|
817 <dl> |
|
818 <dt>Return:</dt> |
|
819 <dd> |
|
820 flag indicating a numeric array |
|
821 </dd> |
|
822 </dl> |
|
823 <dl> |
|
824 <dt>Return Type:</dt> |
|
825 <dd> |
|
826 bool |
|
827 </dd> |
|
828 </dl> |
|
829 <a NAME="NdArrayResolver.getDictionary" ID="NdArrayResolver.getDictionary"></a> |
|
830 <h4>NdArrayResolver.getDictionary</h4> |
|
831 <b>getDictionary</b>(<i>var</i>) |
|
832 |
|
833 <p> |
|
834 Public method to get the attributes of a variable as a dictionary. |
|
835 </p> |
|
836 <dl> |
|
837 |
|
838 <dt><i>var</i> (any)</dt> |
|
839 <dd> |
|
840 variable to be converted |
|
841 </dd> |
|
842 </dl> |
|
843 <dl> |
|
844 <dt>Yield:</dt> |
|
845 <dd> |
|
846 tuple containing the batch start index and a dictionary |
|
847 containing the variable attributes |
|
848 </dd> |
|
849 </dl> |
|
850 <dl> |
|
851 <dt>Yield Type:</dt> |
|
852 <dd> |
|
853 tuple of (int, dict) |
|
854 </dd> |
|
855 </dl> |
|
856 <a NAME="NdArrayResolver.resolve" ID="NdArrayResolver.resolve"></a> |
|
857 <h4>NdArrayResolver.resolve</h4> |
|
858 <b>resolve</b>(<i>var, attribute</i>) |
|
859 |
|
860 <p> |
|
861 Public method to get an attribute from a variable. |
|
862 </p> |
|
863 <dl> |
|
864 |
|
865 <dt><i>var</i> (tuple or list)</dt> |
|
866 <dd> |
|
867 variable to extract an attribute or value from |
|
868 </dd> |
|
869 <dt><i>attribute</i> (str)</dt> |
|
870 <dd> |
|
871 id of the value to extract |
|
872 </dd> |
|
873 </dl> |
|
874 <dl> |
|
875 <dt>Return:</dt> |
|
876 <dd> |
|
877 value of the attribute |
|
878 </dd> |
|
879 </dl> |
|
880 <dl> |
|
881 <dt>Return Type:</dt> |
|
882 <dd> |
|
883 any |
|
884 </dd> |
|
885 </dl> |
|
886 <div align="right"><a href="#top">Up</a></div> |
|
887 <hr /> |
|
888 <hr /> |
|
889 <a NAME="SetResolver" ID="SetResolver"></a> |
|
890 <h2>SetResolver</h2> |
|
891 |
|
892 <p> |
|
893 Class used to resolve from a set or frozenset. |
|
894 </p> |
|
895 <h3>Derived from</h3> |
|
896 BaseResolver |
|
897 <h3>Class Attributes</h3> |
|
898 |
|
899 <table> |
|
900 <tr><td>None</td></tr> |
|
901 </table> |
|
902 <h3>Class Methods</h3> |
|
903 |
|
904 <table> |
|
905 <tr><td>None</td></tr> |
|
906 </table> |
|
907 <h3>Methods</h3> |
|
908 |
|
909 <table> |
|
910 |
|
911 <tr> |
|
912 <td><a href="#SetResolver.getDictionary">getDictionary</a></td> |
|
913 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
914 </tr> |
|
915 <tr> |
|
916 <td><a href="#SetResolver.resolve">resolve</a></td> |
|
917 <td>Public method to get an attribute from a variable.</td> |
|
918 </tr> |
|
919 </table> |
|
920 <h3>Static Methods</h3> |
|
921 |
|
922 <table> |
|
923 <tr><td>None</td></tr> |
|
924 </table> |
|
925 |
|
926 <a NAME="SetResolver.getDictionary" ID="SetResolver.getDictionary"></a> |
|
927 <h4>SetResolver.getDictionary</h4> |
|
928 <b>getDictionary</b>(<i>var</i>) |
|
929 |
|
930 <p> |
|
931 Public method to get the attributes of a variable as a dictionary. |
|
932 </p> |
|
933 <dl> |
|
934 |
|
935 <dt><i>var</i> (any)</dt> |
|
936 <dd> |
|
937 variable to be converted |
|
938 </dd> |
|
939 </dl> |
|
940 <dl> |
|
941 <dt>Yield:</dt> |
|
942 <dd> |
|
943 tuple containing the batch start index and a dictionary |
|
944 containing the variable attributes |
|
945 </dd> |
|
946 </dl> |
|
947 <dl> |
|
948 <dt>Yield Type:</dt> |
|
949 <dd> |
|
950 tuple of (int, dict) |
|
951 </dd> |
|
952 </dl> |
|
953 <a NAME="SetResolver.resolve" ID="SetResolver.resolve"></a> |
|
954 <h4>SetResolver.resolve</h4> |
|
955 <b>resolve</b>(<i>var, attribute</i>) |
|
956 |
|
957 <p> |
|
958 Public method to get an attribute from a variable. |
|
959 </p> |
|
960 <dl> |
|
961 |
|
962 <dt><i>var</i> (tuple or list)</dt> |
|
963 <dd> |
|
964 variable to extract an attribute or value from |
|
965 </dd> |
|
966 <dt><i>attribute</i> (str)</dt> |
|
967 <dd> |
|
968 id of the value to extract |
|
969 </dd> |
|
970 </dl> |
|
971 <dl> |
|
972 <dt>Return:</dt> |
|
973 <dd> |
|
974 value of the attribute |
|
975 </dd> |
|
976 </dl> |
|
977 <dl> |
|
978 <dt>Return Type:</dt> |
|
979 <dd> |
|
980 any |
|
981 </dd> |
|
982 </dl> |
|
983 <div align="right"><a href="#top">Up</a></div> |
|
984 <hr /> |
|
985 <hr /> |
|
986 <a NAME="_initTypeMap" ID="_initTypeMap"></a> |
|
987 <h2>_initTypeMap</h2> |
|
988 <b>_initTypeMap</b>(<i></i>) |
|
989 |
|
990 <p> |
|
991 Protected function to initialize the type map. |
|
992 </p> |
|
993 <div align="right"><a href="#top">Up</a></div> |
|
994 <hr /> |
|
995 <hr /> |
|
996 <a NAME="getType" ID="getType"></a> |
|
997 <h2>getType</h2> |
|
998 <b>getType</b>(<i>obj</i>) |
|
999 |
|
1000 <p> |
|
1001 Public method to get the type information for an object. |
|
1002 </p> |
|
1003 <dl> |
|
1004 |
|
1005 <dt><i>obj</i> (any)</dt> |
|
1006 <dd> |
|
1007 object to get type information for |
|
1008 </dd> |
|
1009 </dl> |
|
1010 <dl> |
|
1011 <dt>Return:</dt> |
|
1012 <dd> |
|
1013 tuple containing the type name, type string and resolver |
|
1014 </dd> |
|
1015 </dl> |
|
1016 <dl> |
|
1017 <dt>Return Type:</dt> |
|
1018 <dd> |
|
1019 tuple of str, str, BaseResolver |
|
1020 </dd> |
|
1021 </dl> |
|
1022 <div align="right"><a href="#top">Up</a></div> |
|
1023 <hr /> |
|
1024 </body></html> |