|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.DebugClients.Python.DebugVariables</h1> |
|
23 <p> |
|
24 Module implementing classes and functions to dump variable contents. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
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> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
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> |
|
39 <td><a href="#BaseResolver">BaseResolver</a></td> |
|
40 <td>Base class of the resolver class tree.</td> |
|
41 </tr><tr> |
|
42 <td><a href="#DefaultResolver">DefaultResolver</a></td> |
|
43 <td>Class used to resolve the default way.</td> |
|
44 </tr><tr> |
|
45 <td><a href="#DictResolver">DictResolver</a></td> |
|
46 <td>Class used to resolve from a dictionary.</td> |
|
47 </tr><tr> |
|
48 <td><a href="#ListResolver">ListResolver</a></td> |
|
49 <td>Class used to resolve from a tuple or list.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#MultiValueDictResolver">MultiValueDictResolver</a></td> |
|
52 <td>Class used to resolve from Django multi value dictionaries.</td> |
|
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> |
|
58 <td>Class used to resolve from numpy ndarray including some meta data.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SetResolver">SetResolver</a></td> |
|
61 <td>Class used to resolve from a set or frozenset.</td> |
|
62 </tr> |
|
63 </table> |
|
64 <h3>Functions</h3> |
|
65 <table> |
|
66 <tr> |
|
67 <td><a href="#_initTypeMap">_initTypeMap</a></td> |
|
68 <td>Protected function to initialize the type map.</td> |
|
69 </tr><tr> |
|
70 <td><a href="#getType">getType</a></td> |
|
71 <td>Public method to get the type information for an object.</td> |
|
72 </tr> |
|
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> |
|
175 <hr /><hr /> |
|
176 <a NAME="BaseResolver" ID="BaseResolver"></a> |
|
177 <h2>BaseResolver</h2> |
|
178 <p> |
|
179 Base class of the resolver class tree. |
|
180 </p> |
|
181 <h3>Derived from</h3> |
|
182 object |
|
183 <h3>Class Attributes</h3> |
|
184 <table> |
|
185 <tr><td>None</td></tr> |
|
186 </table> |
|
187 <h3>Class Methods</h3> |
|
188 <table> |
|
189 <tr><td>None</td></tr> |
|
190 </table> |
|
191 <h3>Methods</h3> |
|
192 <table> |
|
193 <tr> |
|
194 <td><a href="#BaseResolver.getDictionary">getDictionary</a></td> |
|
195 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
196 </tr><tr> |
|
197 <td><a href="#BaseResolver.resolve">resolve</a></td> |
|
198 <td>Public method to get an attribute from a variable.</td> |
|
199 </tr> |
|
200 </table> |
|
201 <h3>Static Methods</h3> |
|
202 <table> |
|
203 <tr><td>None</td></tr> |
|
204 </table> |
|
205 <a NAME="BaseResolver.getDictionary" ID="BaseResolver.getDictionary"></a> |
|
206 <h4>BaseResolver.getDictionary</h4> |
|
207 <b>getDictionary</b>(<i>var</i>) |
|
208 <p> |
|
209 Public method to get the attributes of a variable as a dictionary. |
|
210 </p><dl> |
|
211 <dt><i>var</i> (any)</dt> |
|
212 <dd> |
|
213 variable to be converted |
|
214 </dd> |
|
215 </dl><dl> |
|
216 <dt>Returns:</dt> |
|
217 <dd> |
|
218 dictionary containing the variable attributes |
|
219 </dd> |
|
220 </dl><dl> |
|
221 <dt>Return Type:</dt> |
|
222 <dd> |
|
223 dict |
|
224 </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> |
|
232 <h4>BaseResolver.resolve</h4> |
|
233 <b>resolve</b>(<i>var, attribute</i>) |
|
234 <p> |
|
235 Public method to get an attribute from a variable. |
|
236 </p><dl> |
|
237 <dt><i>var</i> (any)</dt> |
|
238 <dd> |
|
239 variable to extract an attribute or value from |
|
240 </dd><dt><i>attribute</i> (str)</dt> |
|
241 <dd> |
|
242 name of the attribute to extract |
|
243 </dd> |
|
244 </dl><dl> |
|
245 <dt>Returns:</dt> |
|
246 <dd> |
|
247 value of the attribute |
|
248 </dd> |
|
249 </dl><dl> |
|
250 <dt>Return Type:</dt> |
|
251 <dd> |
|
252 any |
|
253 </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> |
|
261 <div align="right"><a href="#top">Up</a></div> |
|
262 <hr /><hr /> |
|
263 <a NAME="DefaultResolver" ID="DefaultResolver"></a> |
|
264 <h2>DefaultResolver</h2> |
|
265 <p> |
|
266 Class used to resolve the default way. |
|
267 </p> |
|
268 <h3>Derived from</h3> |
|
269 BaseResolver |
|
270 <h3>Class Attributes</h3> |
|
271 <table> |
|
272 <tr><td>None</td></tr> |
|
273 </table> |
|
274 <h3>Class Methods</h3> |
|
275 <table> |
|
276 <tr><td>None</td></tr> |
|
277 </table> |
|
278 <h3>Methods</h3> |
|
279 <table> |
|
280 <tr> |
|
281 <td><a href="#DefaultResolver.getDictionary">getDictionary</a></td> |
|
282 <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> |
|
287 </table> |
|
288 <h3>Static Methods</h3> |
|
289 <table> |
|
290 <tr><td>None</td></tr> |
|
291 </table> |
|
292 <a NAME="DefaultResolver.getDictionary" ID="DefaultResolver.getDictionary"></a> |
|
293 <h4>DefaultResolver.getDictionary</h4> |
|
294 <b>getDictionary</b>(<i>var</i>) |
|
295 <p> |
|
296 Public method to get the attributes of a variable as a dictionary. |
|
297 </p><dl> |
|
298 <dt><i>var</i> (any)</dt> |
|
299 <dd> |
|
300 variable to be converted |
|
301 </dd> |
|
302 </dl><dl> |
|
303 <dt>Returns:</dt> |
|
304 <dd> |
|
305 dictionary containing the variable attributes |
|
306 </dd> |
|
307 </dl><dl> |
|
308 <dt>Return Type:</dt> |
|
309 <dd> |
|
310 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> |
|
335 </dl> |
|
336 <div align="right"><a href="#top">Up</a></div> |
|
337 <hr /><hr /> |
|
338 <a NAME="DictResolver" ID="DictResolver"></a> |
|
339 <h2>DictResolver</h2> |
|
340 <p> |
|
341 Class used to resolve from a dictionary. |
|
342 </p> |
|
343 <h3>Derived from</h3> |
|
344 BaseResolver |
|
345 <h3>Class Attributes</h3> |
|
346 <table> |
|
347 <tr><td>None</td></tr> |
|
348 </table> |
|
349 <h3>Class Methods</h3> |
|
350 <table> |
|
351 <tr><td>None</td></tr> |
|
352 </table> |
|
353 <h3>Methods</h3> |
|
354 <table> |
|
355 <tr> |
|
356 <td><a href="#DictResolver.getDictionary">getDictionary</a></td> |
|
357 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
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> |
|
362 <td><a href="#DictResolver.resolve">resolve</a></td> |
|
363 <td>Public method to get an attribute from a variable.</td> |
|
364 </tr> |
|
365 </table> |
|
366 <h3>Static Methods</h3> |
|
367 <table> |
|
368 <tr><td>None</td></tr> |
|
369 </table> |
|
370 <a NAME="DictResolver.getDictionary" ID="DictResolver.getDictionary"></a> |
|
371 <h4>DictResolver.getDictionary</h4> |
|
372 <b>getDictionary</b>(<i>var</i>) |
|
373 <p> |
|
374 Public method to get the attributes of a variable as a dictionary. |
|
375 </p><dl> |
|
376 <dt><i>var</i> (any)</dt> |
|
377 <dd> |
|
378 variable to be converted |
|
379 </dd> |
|
380 </dl><dl> |
|
381 <dt>Returns:</dt> |
|
382 <dd> |
|
383 dictionary containing the variable attributes |
|
384 </dd> |
|
385 </dl><dl> |
|
386 <dt>Return Type:</dt> |
|
387 <dd> |
|
388 dict |
|
389 </dd> |
|
390 </dl><a NAME="DictResolver.keyToStr" ID="DictResolver.keyToStr"></a> |
|
391 <h4>DictResolver.keyToStr</h4> |
|
392 <b>keyToStr</b>(<i>key</i>) |
|
393 <p> |
|
394 Public method to get a string representation for a key. |
|
395 </p><dl> |
|
396 <dt><i>key</i> (any)</dt> |
|
397 <dd> |
|
398 key to be converted |
|
399 </dd> |
|
400 </dl><dl> |
|
401 <dt>Returns:</dt> |
|
402 <dd> |
|
403 string representation of the given key |
|
404 </dd> |
|
405 </dl><dl> |
|
406 <dt>Return Type:</dt> |
|
407 <dd> |
|
408 str |
|
409 </dd> |
|
410 </dl><a NAME="DictResolver.resolve" ID="DictResolver.resolve"></a> |
|
411 <h4>DictResolver.resolve</h4> |
|
412 <b>resolve</b>(<i>var, attribute</i>) |
|
413 <p> |
|
414 Public method to get an attribute from a variable. |
|
415 </p><dl> |
|
416 <dt><i>var</i> (dict)</dt> |
|
417 <dd> |
|
418 variable to extract an attribute or value from |
|
419 </dd><dt><i>attribute</i> (str)</dt> |
|
420 <dd> |
|
421 name of the attribute to extract |
|
422 </dd> |
|
423 </dl><dl> |
|
424 <dt>Returns:</dt> |
|
425 <dd> |
|
426 value of the attribute |
|
427 </dd> |
|
428 </dl><dl> |
|
429 <dt>Return Type:</dt> |
|
430 <dd> |
|
431 any |
|
432 </dd> |
|
433 </dl> |
|
434 <div align="right"><a href="#top">Up</a></div> |
|
435 <hr /><hr /> |
|
436 <a NAME="ListResolver" ID="ListResolver"></a> |
|
437 <h2>ListResolver</h2> |
|
438 <p> |
|
439 Class used to resolve from a tuple or list. |
|
440 </p> |
|
441 <h3>Derived from</h3> |
|
442 BaseResolver |
|
443 <h3>Class Attributes</h3> |
|
444 <table> |
|
445 <tr><td>None</td></tr> |
|
446 </table> |
|
447 <h3>Class Methods</h3> |
|
448 <table> |
|
449 <tr><td>None</td></tr> |
|
450 </table> |
|
451 <h3>Methods</h3> |
|
452 <table> |
|
453 <tr> |
|
454 <td><a href="#ListResolver.getDictionary">getDictionary</a></td> |
|
455 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
456 </tr><tr> |
|
457 <td><a href="#ListResolver.resolve">resolve</a></td> |
|
458 <td>Public method to get an attribute from a variable.</td> |
|
459 </tr> |
|
460 </table> |
|
461 <h3>Static Methods</h3> |
|
462 <table> |
|
463 <tr><td>None</td></tr> |
|
464 </table> |
|
465 <a NAME="ListResolver.getDictionary" ID="ListResolver.getDictionary"></a> |
|
466 <h4>ListResolver.getDictionary</h4> |
|
467 <b>getDictionary</b>(<i>var</i>) |
|
468 <p> |
|
469 Public method to get the attributes of a variable as a dictionary. |
|
470 </p><dl> |
|
471 <dt><i>var</i> (any)</dt> |
|
472 <dd> |
|
473 variable to be converted |
|
474 </dd> |
|
475 </dl><dl> |
|
476 <dt>Returns:</dt> |
|
477 <dd> |
|
478 dictionary containing the variable attributes |
|
479 </dd> |
|
480 </dl><dl> |
|
481 <dt>Return Type:</dt> |
|
482 <dd> |
|
483 dict |
|
484 </dd> |
|
485 </dl><a NAME="ListResolver.resolve" ID="ListResolver.resolve"></a> |
|
486 <h4>ListResolver.resolve</h4> |
|
487 <b>resolve</b>(<i>var, attribute</i>) |
|
488 <p> |
|
489 Public method to get an attribute from a variable. |
|
490 </p><dl> |
|
491 <dt><i>var</i> (tuple or list)</dt> |
|
492 <dd> |
|
493 variable to extract an attribute or value from |
|
494 </dd><dt><i>attribute</i> (str)</dt> |
|
495 <dd> |
|
496 name of the attribute to extract |
|
497 </dd> |
|
498 </dl><dl> |
|
499 <dt>Returns:</dt> |
|
500 <dd> |
|
501 value of the attribute |
|
502 </dd> |
|
503 </dl><dl> |
|
504 <dt>Return Type:</dt> |
|
505 <dd> |
|
506 any |
|
507 </dd> |
|
508 </dl> |
|
509 <div align="right"><a href="#top">Up</a></div> |
|
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 /> |
|
710 <a NAME="SetResolver" ID="SetResolver"></a> |
|
711 <h2>SetResolver</h2> |
|
712 <p> |
|
713 Class used to resolve from a set or frozenset. |
|
714 </p> |
|
715 <h3>Derived from</h3> |
|
716 BaseResolver |
|
717 <h3>Class Attributes</h3> |
|
718 <table> |
|
719 <tr><td>None</td></tr> |
|
720 </table> |
|
721 <h3>Class Methods</h3> |
|
722 <table> |
|
723 <tr><td>None</td></tr> |
|
724 </table> |
|
725 <h3>Methods</h3> |
|
726 <table> |
|
727 <tr> |
|
728 <td><a href="#SetResolver.getDictionary">getDictionary</a></td> |
|
729 <td>Public method to get the attributes of a variable as a dictionary.</td> |
|
730 </tr><tr> |
|
731 <td><a href="#SetResolver.resolve">resolve</a></td> |
|
732 <td>Public method to get an attribute from a variable.</td> |
|
733 </tr> |
|
734 </table> |
|
735 <h3>Static Methods</h3> |
|
736 <table> |
|
737 <tr><td>None</td></tr> |
|
738 </table> |
|
739 <a NAME="SetResolver.getDictionary" ID="SetResolver.getDictionary"></a> |
|
740 <h4>SetResolver.getDictionary</h4> |
|
741 <b>getDictionary</b>(<i>var</i>) |
|
742 <p> |
|
743 Public method to get the attributes of a variable as a dictionary. |
|
744 </p><dl> |
|
745 <dt><i>var</i> (any)</dt> |
|
746 <dd> |
|
747 variable to be converted |
|
748 </dd> |
|
749 </dl><dl> |
|
750 <dt>Returns:</dt> |
|
751 <dd> |
|
752 dictionary containing the variable attributes |
|
753 </dd> |
|
754 </dl><dl> |
|
755 <dt>Return Type:</dt> |
|
756 <dd> |
|
757 dict |
|
758 </dd> |
|
759 </dl><a NAME="SetResolver.resolve" ID="SetResolver.resolve"></a> |
|
760 <h4>SetResolver.resolve</h4> |
|
761 <b>resolve</b>(<i>var, attribute</i>) |
|
762 <p> |
|
763 Public method to get an attribute from a variable. |
|
764 </p><dl> |
|
765 <dt><i>var</i> (tuple or list)</dt> |
|
766 <dd> |
|
767 variable to extract an attribute or value from |
|
768 </dd><dt><i>attribute</i> (str)</dt> |
|
769 <dd> |
|
770 id of the value to extract |
|
771 </dd> |
|
772 </dl><dl> |
|
773 <dt>Returns:</dt> |
|
774 <dd> |
|
775 value of the attribute |
|
776 </dd> |
|
777 </dl><dl> |
|
778 <dt>Return Type:</dt> |
|
779 <dd> |
|
780 any |
|
781 </dd> |
|
782 </dl> |
|
783 <div align="right"><a href="#top">Up</a></div> |
|
784 <hr /><hr /> |
|
785 <a NAME="_initTypeMap" ID="_initTypeMap"></a> |
|
786 <h2>_initTypeMap</h2> |
|
787 <b>_initTypeMap</b>(<i></i>) |
|
788 <p> |
|
789 Protected function to initialize the type map. |
|
790 </p> |
|
791 <div align="right"><a href="#top">Up</a></div> |
|
792 <hr /><hr /> |
|
793 <a NAME="getType" ID="getType"></a> |
|
794 <h2>getType</h2> |
|
795 <b>getType</b>(<i>obj</i>) |
|
796 <p> |
|
797 Public method to get the type information for an object. |
|
798 </p><dl> |
|
799 <dt><i>obj</i> (any)</dt> |
|
800 <dd> |
|
801 object to get type information for |
|
802 </dd> |
|
803 </dl><dl> |
|
804 <dt>Returns:</dt> |
|
805 <dd> |
|
806 tuple containing the type, type name, type string and resolver |
|
807 </dd> |
|
808 </dl><dl> |
|
809 <dt>Return Type:</dt> |
|
810 <dd> |
|
811 tuple of type, str, str, BaseResolver |
|
812 </dd> |
|
813 </dl> |
|
814 <div align="right"><a href="#top">Up</a></div> |
|
815 <hr /> |
|
816 </body></html> |