|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Utilities.ClassBrowsers.ClbrBaseClasses</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.Utilities.ClassBrowsers.ClbrBaseClasses</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing base classes used by the various class browsers. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#Attribute">Attribute</a></td> |
|
39 <td>Class to represent an attribute.</td> |
|
40 </tr> |
|
41 <tr> |
|
42 <td><a href="#Class">Class</a></td> |
|
43 <td>Class to represent a class.</td> |
|
44 </tr> |
|
45 <tr> |
|
46 <td><a href="#ClbrBase">ClbrBase</a></td> |
|
47 <td>Class implementing the base of all complex class browser objects.</td> |
|
48 </tr> |
|
49 <tr> |
|
50 <td><a href="#ClbrVisibilityMixinBase">ClbrVisibilityMixinBase</a></td> |
|
51 <td>Class implementing the base class of all visibility mixins.</td> |
|
52 </tr> |
|
53 <tr> |
|
54 <td><a href="#Coding">Coding</a></td> |
|
55 <td>Class to represent a source coding.</td> |
|
56 </tr> |
|
57 <tr> |
|
58 <td><a href="#Enum">Enum</a></td> |
|
59 <td>Class to represent an enum definition.</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#Function">Function</a></td> |
|
63 <td>Class to represent a function or method.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#Module">Module</a></td> |
|
67 <td>Class to represent a module.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#_ClbrBase">_ClbrBase</a></td> |
|
71 <td>Class implementing the base of all class browser objects.</td> |
|
72 </tr> |
|
73 </table> |
|
74 <h3>Functions</h3> |
|
75 |
|
76 <table> |
|
77 <tr><td>None</td></tr> |
|
78 </table> |
|
79 <hr /> |
|
80 <hr /> |
|
81 <a NAME="Attribute" ID="Attribute"></a> |
|
82 <h2>Attribute</h2> |
|
83 |
|
84 <p> |
|
85 Class to represent an attribute. |
|
86 </p> |
|
87 <h3>Derived from</h3> |
|
88 _ClbrBase |
|
89 <h3>Class Attributes</h3> |
|
90 |
|
91 <table> |
|
92 <tr><td>None</td></tr> |
|
93 </table> |
|
94 <h3>Class Methods</h3> |
|
95 |
|
96 <table> |
|
97 <tr><td>None</td></tr> |
|
98 </table> |
|
99 <h3>Methods</h3> |
|
100 |
|
101 <table> |
|
102 |
|
103 <tr> |
|
104 <td><a href="#Attribute.__init__">Attribute</a></td> |
|
105 <td>Constructor</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#Attribute.addAssignment">addAssignment</a></td> |
|
109 <td>Public method to add another assignment line number.</td> |
|
110 </tr> |
|
111 </table> |
|
112 <h3>Static Methods</h3> |
|
113 |
|
114 <table> |
|
115 <tr><td>None</td></tr> |
|
116 </table> |
|
117 |
|
118 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> |
|
119 <h4>Attribute (Constructor)</h4> |
|
120 <b>Attribute</b>(<i>module, name, file, lineno</i>) |
|
121 |
|
122 <p> |
|
123 Constructor |
|
124 </p> |
|
125 <dl> |
|
126 |
|
127 <dt><i>module</i> (str)</dt> |
|
128 <dd> |
|
129 name of the module containing this attribute |
|
130 </dd> |
|
131 <dt><i>name</i> (str)</dt> |
|
132 <dd> |
|
133 name of this attribute |
|
134 </dd> |
|
135 <dt><i>file</i> (str)</dt> |
|
136 <dd> |
|
137 filename containing this attribute |
|
138 </dd> |
|
139 <dt><i>lineno</i> (int)</dt> |
|
140 <dd> |
|
141 line number of the attribute definition |
|
142 </dd> |
|
143 </dl> |
|
144 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a> |
|
145 <h4>Attribute.addAssignment</h4> |
|
146 <b>addAssignment</b>(<i>lineno</i>) |
|
147 |
|
148 <p> |
|
149 Public method to add another assignment line number. |
|
150 </p> |
|
151 <dl> |
|
152 |
|
153 <dt><i>lineno</i> (int)</dt> |
|
154 <dd> |
|
155 line number of the additional attribute assignment |
|
156 </dd> |
|
157 </dl> |
|
158 <div align="right"><a href="#top">Up</a></div> |
|
159 <hr /> |
|
160 <hr /> |
|
161 <a NAME="Class" ID="Class"></a> |
|
162 <h2>Class</h2> |
|
163 |
|
164 <p> |
|
165 Class to represent a class. |
|
166 </p> |
|
167 <h3>Derived from</h3> |
|
168 ClbrBase |
|
169 <h3>Class Attributes</h3> |
|
170 |
|
171 <table> |
|
172 <tr><td>None</td></tr> |
|
173 </table> |
|
174 <h3>Class Methods</h3> |
|
175 |
|
176 <table> |
|
177 <tr><td>None</td></tr> |
|
178 </table> |
|
179 <h3>Methods</h3> |
|
180 |
|
181 <table> |
|
182 |
|
183 <tr> |
|
184 <td><a href="#Class.__init__">Class</a></td> |
|
185 <td>Constructor</td> |
|
186 </tr> |
|
187 </table> |
|
188 <h3>Static Methods</h3> |
|
189 |
|
190 <table> |
|
191 <tr><td>None</td></tr> |
|
192 </table> |
|
193 |
|
194 <a NAME="Class.__init__" ID="Class.__init__"></a> |
|
195 <h4>Class (Constructor)</h4> |
|
196 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>) |
|
197 |
|
198 <p> |
|
199 Constructor |
|
200 </p> |
|
201 <dl> |
|
202 |
|
203 <dt><i>module</i> (str)</dt> |
|
204 <dd> |
|
205 name of the module containing this class |
|
206 </dd> |
|
207 <dt><i>name</i> (str)</dt> |
|
208 <dd> |
|
209 name of this class |
|
210 </dd> |
|
211 <dt><i>superClasses</i> (list of str)</dt> |
|
212 <dd> |
|
213 list of class names this class is inherited from |
|
214 </dd> |
|
215 <dt><i>file</i> (str)</dt> |
|
216 <dd> |
|
217 filename containing this class |
|
218 </dd> |
|
219 <dt><i>lineno</i> (int)</dt> |
|
220 <dd> |
|
221 line number of the class definition |
|
222 </dd> |
|
223 </dl> |
|
224 <div align="right"><a href="#top">Up</a></div> |
|
225 <hr /> |
|
226 <hr /> |
|
227 <a NAME="ClbrBase" ID="ClbrBase"></a> |
|
228 <h2>ClbrBase</h2> |
|
229 |
|
230 <p> |
|
231 Class implementing the base of all complex class browser objects. |
|
232 </p> |
|
233 <h3>Derived from</h3> |
|
234 _ClbrBase |
|
235 <h3>Class Attributes</h3> |
|
236 |
|
237 <table> |
|
238 <tr><td>None</td></tr> |
|
239 </table> |
|
240 <h3>Class Methods</h3> |
|
241 |
|
242 <table> |
|
243 <tr><td>None</td></tr> |
|
244 </table> |
|
245 <h3>Methods</h3> |
|
246 |
|
247 <table> |
|
248 |
|
249 <tr> |
|
250 <td><a href="#ClbrBase.__init__">ClbrBase</a></td> |
|
251 <td>Constructor</td> |
|
252 </tr> |
|
253 <tr> |
|
254 <td><a href="#ClbrBase._addattribute">_addattribute</a></td> |
|
255 <td>Protected method to add information about attributes.</td> |
|
256 </tr> |
|
257 <tr> |
|
258 <td><a href="#ClbrBase._addclass">_addclass</a></td> |
|
259 <td>Protected method method to add a nested class to this class.</td> |
|
260 </tr> |
|
261 <tr> |
|
262 <td><a href="#ClbrBase._addglobal">_addglobal</a></td> |
|
263 <td>Protected method to add information about global variables.</td> |
|
264 </tr> |
|
265 <tr> |
|
266 <td><a href="#ClbrBase._addmethod">_addmethod</a></td> |
|
267 <td>Protected method to add information about a method.</td> |
|
268 </tr> |
|
269 <tr> |
|
270 <td><a href="#ClbrBase._getattribute">_getattribute</a></td> |
|
271 <td>Protected method to retrieve an attribute by name.</td> |
|
272 </tr> |
|
273 <tr> |
|
274 <td><a href="#ClbrBase._getglobal">_getglobal</a></td> |
|
275 <td>Protected method to retrieve a global variable by name.</td> |
|
276 </tr> |
|
277 <tr> |
|
278 <td><a href="#ClbrBase._getmethod">_getmethod</a></td> |
|
279 <td>Protected method to retrieve a method by name.</td> |
|
280 </tr> |
|
281 </table> |
|
282 <h3>Static Methods</h3> |
|
283 |
|
284 <table> |
|
285 <tr><td>None</td></tr> |
|
286 </table> |
|
287 |
|
288 <a NAME="ClbrBase.__init__" ID="ClbrBase.__init__"></a> |
|
289 <h4>ClbrBase (Constructor)</h4> |
|
290 <b>ClbrBase</b>(<i>module, name, file, lineno</i>) |
|
291 |
|
292 <p> |
|
293 Constructor |
|
294 </p> |
|
295 <dl> |
|
296 |
|
297 <dt><i>module</i> (str)</dt> |
|
298 <dd> |
|
299 name of the module containing this object |
|
300 </dd> |
|
301 <dt><i>name</i> (str)</dt> |
|
302 <dd> |
|
303 name of this object |
|
304 </dd> |
|
305 <dt><i>file</i> (str)</dt> |
|
306 <dd> |
|
307 filename containing this object |
|
308 </dd> |
|
309 <dt><i>lineno</i> (int)</dt> |
|
310 <dd> |
|
311 linenumber of the object definition |
|
312 </dd> |
|
313 </dl> |
|
314 <a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a> |
|
315 <h4>ClbrBase._addattribute</h4> |
|
316 <b>_addattribute</b>(<i>attr</i>) |
|
317 |
|
318 <p> |
|
319 Protected method to add information about attributes. |
|
320 </p> |
|
321 <dl> |
|
322 |
|
323 <dt><i>attr</i> (Attribute)</dt> |
|
324 <dd> |
|
325 Attribute object to be added |
|
326 </dd> |
|
327 </dl> |
|
328 <a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a> |
|
329 <h4>ClbrBase._addclass</h4> |
|
330 <b>_addclass</b>(<i>name, _class</i>) |
|
331 |
|
332 <p> |
|
333 Protected method method to add a nested class to this class. |
|
334 </p> |
|
335 <dl> |
|
336 |
|
337 <dt><i>name</i> (str)</dt> |
|
338 <dd> |
|
339 name of the class |
|
340 </dd> |
|
341 <dt><i>_class</i> (Class)</dt> |
|
342 <dd> |
|
343 Class object to be added |
|
344 </dd> |
|
345 </dl> |
|
346 <a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a> |
|
347 <h4>ClbrBase._addglobal</h4> |
|
348 <b>_addglobal</b>(<i>attr</i>) |
|
349 |
|
350 <p> |
|
351 Protected method to add information about global variables. |
|
352 </p> |
|
353 <dl> |
|
354 |
|
355 <dt><i>attr</i> (Attribute)</dt> |
|
356 <dd> |
|
357 Attribute object to be added |
|
358 </dd> |
|
359 </dl> |
|
360 <a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a> |
|
361 <h4>ClbrBase._addmethod</h4> |
|
362 <b>_addmethod</b>(<i>name, function</i>) |
|
363 |
|
364 <p> |
|
365 Protected method to add information about a method. |
|
366 </p> |
|
367 <dl> |
|
368 |
|
369 <dt><i>name</i> (str)</dt> |
|
370 <dd> |
|
371 name of method to be added |
|
372 </dd> |
|
373 <dt><i>function</i> (Function)</dt> |
|
374 <dd> |
|
375 Function object to be added |
|
376 </dd> |
|
377 </dl> |
|
378 <a NAME="ClbrBase._getattribute" ID="ClbrBase._getattribute"></a> |
|
379 <h4>ClbrBase._getattribute</h4> |
|
380 <b>_getattribute</b>(<i>name</i>) |
|
381 |
|
382 <p> |
|
383 Protected method to retrieve an attribute by name. |
|
384 </p> |
|
385 <dl> |
|
386 |
|
387 <dt><i>name</i> (str)</dt> |
|
388 <dd> |
|
389 name of the attribute |
|
390 </dd> |
|
391 </dl> |
|
392 <dl> |
|
393 <dt>Return:</dt> |
|
394 <dd> |
|
395 the named attribute |
|
396 </dd> |
|
397 </dl> |
|
398 <dl> |
|
399 <dt>Return Type:</dt> |
|
400 <dd> |
|
401 Attribute or None |
|
402 </dd> |
|
403 </dl> |
|
404 <a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a> |
|
405 <h4>ClbrBase._getglobal</h4> |
|
406 <b>_getglobal</b>(<i>name</i>) |
|
407 |
|
408 <p> |
|
409 Protected method to retrieve a global variable by name. |
|
410 </p> |
|
411 <dl> |
|
412 |
|
413 <dt><i>name</i> (str)</dt> |
|
414 <dd> |
|
415 name of the global variable |
|
416 </dd> |
|
417 </dl> |
|
418 <dl> |
|
419 <dt>Return:</dt> |
|
420 <dd> |
|
421 the named global variable |
|
422 </dd> |
|
423 </dl> |
|
424 <dl> |
|
425 <dt>Return Type:</dt> |
|
426 <dd> |
|
427 Attribute or None |
|
428 </dd> |
|
429 </dl> |
|
430 <a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a> |
|
431 <h4>ClbrBase._getmethod</h4> |
|
432 <b>_getmethod</b>(<i>name</i>) |
|
433 |
|
434 <p> |
|
435 Protected method to retrieve a method by name. |
|
436 </p> |
|
437 <dl> |
|
438 |
|
439 <dt><i>name</i> (str)</dt> |
|
440 <dd> |
|
441 name of the method (string) |
|
442 </dd> |
|
443 </dl> |
|
444 <dl> |
|
445 <dt>Return:</dt> |
|
446 <dd> |
|
447 the named method |
|
448 </dd> |
|
449 </dl> |
|
450 <dl> |
|
451 <dt>Return Type:</dt> |
|
452 <dd> |
|
453 Function or None |
|
454 </dd> |
|
455 </dl> |
|
456 <div align="right"><a href="#top">Up</a></div> |
|
457 <hr /> |
|
458 <hr /> |
|
459 <a NAME="ClbrVisibilityMixinBase" ID="ClbrVisibilityMixinBase"></a> |
|
460 <h2>ClbrVisibilityMixinBase</h2> |
|
461 |
|
462 <p> |
|
463 Class implementing the base class of all visibility mixins. |
|
464 </p> |
|
465 <h3>Derived from</h3> |
|
466 None |
|
467 <h3>Class Attributes</h3> |
|
468 |
|
469 <table> |
|
470 <tr><td>None</td></tr> |
|
471 </table> |
|
472 <h3>Class Methods</h3> |
|
473 |
|
474 <table> |
|
475 <tr><td>None</td></tr> |
|
476 </table> |
|
477 <h3>Methods</h3> |
|
478 |
|
479 <table> |
|
480 |
|
481 <tr> |
|
482 <td><a href="#ClbrVisibilityMixinBase.isPrivate">isPrivate</a></td> |
|
483 <td>Public method to check, if the visibility is Private.</td> |
|
484 </tr> |
|
485 <tr> |
|
486 <td><a href="#ClbrVisibilityMixinBase.isProtected">isProtected</a></td> |
|
487 <td>Public method to check, if the visibility is Protected.</td> |
|
488 </tr> |
|
489 <tr> |
|
490 <td><a href="#ClbrVisibilityMixinBase.isPublic">isPublic</a></td> |
|
491 <td>Public method to check, if the visibility is Public.</td> |
|
492 </tr> |
|
493 <tr> |
|
494 <td><a href="#ClbrVisibilityMixinBase.setPrivate">setPrivate</a></td> |
|
495 <td>Public method to set the visibility to Private.</td> |
|
496 </tr> |
|
497 <tr> |
|
498 <td><a href="#ClbrVisibilityMixinBase.setProtected">setProtected</a></td> |
|
499 <td>Public method to set the visibility to Protected.</td> |
|
500 </tr> |
|
501 <tr> |
|
502 <td><a href="#ClbrVisibilityMixinBase.setPublic">setPublic</a></td> |
|
503 <td>Public method to set the visibility to Public.</td> |
|
504 </tr> |
|
505 </table> |
|
506 <h3>Static Methods</h3> |
|
507 |
|
508 <table> |
|
509 <tr><td>None</td></tr> |
|
510 </table> |
|
511 |
|
512 <a NAME="ClbrVisibilityMixinBase.isPrivate" ID="ClbrVisibilityMixinBase.isPrivate"></a> |
|
513 <h4>ClbrVisibilityMixinBase.isPrivate</h4> |
|
514 <b>isPrivate</b>(<i></i>) |
|
515 |
|
516 <p> |
|
517 Public method to check, if the visibility is Private. |
|
518 </p> |
|
519 <dl> |
|
520 <dt>Return:</dt> |
|
521 <dd> |
|
522 flag indicating Private visibility |
|
523 </dd> |
|
524 </dl> |
|
525 <dl> |
|
526 <dt>Return Type:</dt> |
|
527 <dd> |
|
528 bool |
|
529 </dd> |
|
530 </dl> |
|
531 <a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a> |
|
532 <h4>ClbrVisibilityMixinBase.isProtected</h4> |
|
533 <b>isProtected</b>(<i></i>) |
|
534 |
|
535 <p> |
|
536 Public method to check, if the visibility is Protected. |
|
537 </p> |
|
538 <dl> |
|
539 <dt>Return:</dt> |
|
540 <dd> |
|
541 flag indicating Protected visibility |
|
542 </dd> |
|
543 </dl> |
|
544 <dl> |
|
545 <dt>Return Type:</dt> |
|
546 <dd> |
|
547 bool |
|
548 </dd> |
|
549 </dl> |
|
550 <a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a> |
|
551 <h4>ClbrVisibilityMixinBase.isPublic</h4> |
|
552 <b>isPublic</b>(<i></i>) |
|
553 |
|
554 <p> |
|
555 Public method to check, if the visibility is Public. |
|
556 </p> |
|
557 <dl> |
|
558 <dt>Return:</dt> |
|
559 <dd> |
|
560 flag indicating Public visibility |
|
561 </dd> |
|
562 </dl> |
|
563 <dl> |
|
564 <dt>Return Type:</dt> |
|
565 <dd> |
|
566 bool |
|
567 </dd> |
|
568 </dl> |
|
569 <a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a> |
|
570 <h4>ClbrVisibilityMixinBase.setPrivate</h4> |
|
571 <b>setPrivate</b>(<i></i>) |
|
572 |
|
573 <p> |
|
574 Public method to set the visibility to Private. |
|
575 </p> |
|
576 <a NAME="ClbrVisibilityMixinBase.setProtected" ID="ClbrVisibilityMixinBase.setProtected"></a> |
|
577 <h4>ClbrVisibilityMixinBase.setProtected</h4> |
|
578 <b>setProtected</b>(<i></i>) |
|
579 |
|
580 <p> |
|
581 Public method to set the visibility to Protected. |
|
582 </p> |
|
583 <a NAME="ClbrVisibilityMixinBase.setPublic" ID="ClbrVisibilityMixinBase.setPublic"></a> |
|
584 <h4>ClbrVisibilityMixinBase.setPublic</h4> |
|
585 <b>setPublic</b>(<i></i>) |
|
586 |
|
587 <p> |
|
588 Public method to set the visibility to Public. |
|
589 </p> |
|
590 <div align="right"><a href="#top">Up</a></div> |
|
591 <hr /> |
|
592 <hr /> |
|
593 <a NAME="Coding" ID="Coding"></a> |
|
594 <h2>Coding</h2> |
|
595 |
|
596 <p> |
|
597 Class to represent a source coding. |
|
598 </p> |
|
599 <h3>Derived from</h3> |
|
600 ClbrBase |
|
601 <h3>Class Attributes</h3> |
|
602 |
|
603 <table> |
|
604 <tr><td>None</td></tr> |
|
605 </table> |
|
606 <h3>Class Methods</h3> |
|
607 |
|
608 <table> |
|
609 <tr><td>None</td></tr> |
|
610 </table> |
|
611 <h3>Methods</h3> |
|
612 |
|
613 <table> |
|
614 |
|
615 <tr> |
|
616 <td><a href="#Coding.__init__">Coding</a></td> |
|
617 <td>Constructor</td> |
|
618 </tr> |
|
619 </table> |
|
620 <h3>Static Methods</h3> |
|
621 |
|
622 <table> |
|
623 <tr><td>None</td></tr> |
|
624 </table> |
|
625 |
|
626 <a NAME="Coding.__init__" ID="Coding.__init__"></a> |
|
627 <h4>Coding (Constructor)</h4> |
|
628 <b>Coding</b>(<i>module, file, lineno, coding</i>) |
|
629 |
|
630 <p> |
|
631 Constructor |
|
632 </p> |
|
633 <dl> |
|
634 |
|
635 <dt><i>module</i> (str)</dt> |
|
636 <dd> |
|
637 name of the module containing this coding statement |
|
638 </dd> |
|
639 <dt><i>file</i> (str)</dt> |
|
640 <dd> |
|
641 filename containing this coding statement |
|
642 </dd> |
|
643 <dt><i>lineno</i> (int)</dt> |
|
644 <dd> |
|
645 line number of the coding definition |
|
646 </dd> |
|
647 <dt><i>coding</i> (str)</dt> |
|
648 <dd> |
|
649 character coding of the source file |
|
650 </dd> |
|
651 </dl> |
|
652 <div align="right"><a href="#top">Up</a></div> |
|
653 <hr /> |
|
654 <hr /> |
|
655 <a NAME="Enum" ID="Enum"></a> |
|
656 <h2>Enum</h2> |
|
657 |
|
658 <p> |
|
659 Class to represent an enum definition. |
|
660 </p> |
|
661 <h3>Derived from</h3> |
|
662 ClbrBase |
|
663 <h3>Class Attributes</h3> |
|
664 |
|
665 <table> |
|
666 <tr><td>None</td></tr> |
|
667 </table> |
|
668 <h3>Class Methods</h3> |
|
669 |
|
670 <table> |
|
671 <tr><td>None</td></tr> |
|
672 </table> |
|
673 <h3>Methods</h3> |
|
674 |
|
675 <table> |
|
676 |
|
677 <tr> |
|
678 <td><a href="#Enum.__init__">Enum</a></td> |
|
679 <td>Constructor</td> |
|
680 </tr> |
|
681 </table> |
|
682 <h3>Static Methods</h3> |
|
683 |
|
684 <table> |
|
685 <tr><td>None</td></tr> |
|
686 </table> |
|
687 |
|
688 <a NAME="Enum.__init__" ID="Enum.__init__"></a> |
|
689 <h4>Enum (Constructor)</h4> |
|
690 <b>Enum</b>(<i>module, name, file, lineno</i>) |
|
691 |
|
692 <p> |
|
693 Constructor |
|
694 </p> |
|
695 <dl> |
|
696 |
|
697 <dt><i>module</i> (str)</dt> |
|
698 <dd> |
|
699 name of the module containing this enum |
|
700 </dd> |
|
701 <dt><i>name</i> (str)</dt> |
|
702 <dd> |
|
703 name of this enum |
|
704 </dd> |
|
705 <dt><i>file</i> (str)</dt> |
|
706 <dd> |
|
707 filename containing this enum |
|
708 </dd> |
|
709 <dt><i>lineno</i> (int)</dt> |
|
710 <dd> |
|
711 line number of the enum definition |
|
712 </dd> |
|
713 </dl> |
|
714 <div align="right"><a href="#top">Up</a></div> |
|
715 <hr /> |
|
716 <hr /> |
|
717 <a NAME="Function" ID="Function"></a> |
|
718 <h2>Function</h2> |
|
719 |
|
720 <p> |
|
721 Class to represent a function or method. |
|
722 </p> |
|
723 <h3>Derived from</h3> |
|
724 ClbrBase |
|
725 <h3>Class Attributes</h3> |
|
726 |
|
727 <table> |
|
728 <tr><td>Class</td></tr><tr><td>General</td></tr><tr><td>Static</td></tr> |
|
729 </table> |
|
730 <h3>Class Methods</h3> |
|
731 |
|
732 <table> |
|
733 <tr><td>None</td></tr> |
|
734 </table> |
|
735 <h3>Methods</h3> |
|
736 |
|
737 <table> |
|
738 |
|
739 <tr> |
|
740 <td><a href="#Function.__init__">Function</a></td> |
|
741 <td>Constructor</td> |
|
742 </tr> |
|
743 </table> |
|
744 <h3>Static Methods</h3> |
|
745 |
|
746 <table> |
|
747 <tr><td>None</td></tr> |
|
748 </table> |
|
749 |
|
750 <a NAME="Function.__init__" ID="Function.__init__"></a> |
|
751 <h4>Function (Constructor)</h4> |
|
752 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', ', modifierType=General, annotation=""</i>) |
|
753 |
|
754 <p> |
|
755 Constructor |
|
756 </p> |
|
757 <dl> |
|
758 |
|
759 <dt><i>module</i> (str)</dt> |
|
760 <dd> |
|
761 name of the module containing this function |
|
762 </dd> |
|
763 <dt><i>name</i> (str)</dt> |
|
764 <dd> |
|
765 name of this function |
|
766 </dd> |
|
767 <dt><i>file</i> (str)</dt> |
|
768 <dd> |
|
769 filename containing this function |
|
770 </dd> |
|
771 <dt><i>lineno</i> (int)</dt> |
|
772 <dd> |
|
773 line number of the function definition |
|
774 </dd> |
|
775 <dt><i>signature</i> (str)</dt> |
|
776 <dd> |
|
777 parameter list of the function |
|
778 </dd> |
|
779 <dt><i>separator</i> (str)</dt> |
|
780 <dd> |
|
781 string separating the parameters of the function |
|
782 </dd> |
|
783 <dt><i>modifierType</i> (int)</dt> |
|
784 <dd> |
|
785 type of the function |
|
786 </dd> |
|
787 <dt><i>annotation</i> (str)</dt> |
|
788 <dd> |
|
789 function return annotation |
|
790 </dd> |
|
791 </dl> |
|
792 <div align="right"><a href="#top">Up</a></div> |
|
793 <hr /> |
|
794 <hr /> |
|
795 <a NAME="Module" ID="Module"></a> |
|
796 <h2>Module</h2> |
|
797 |
|
798 <p> |
|
799 Class to represent a module. |
|
800 </p> |
|
801 <h3>Derived from</h3> |
|
802 ClbrBase |
|
803 <h3>Class Attributes</h3> |
|
804 |
|
805 <table> |
|
806 <tr><td>None</td></tr> |
|
807 </table> |
|
808 <h3>Class Methods</h3> |
|
809 |
|
810 <table> |
|
811 <tr><td>None</td></tr> |
|
812 </table> |
|
813 <h3>Methods</h3> |
|
814 |
|
815 <table> |
|
816 |
|
817 <tr> |
|
818 <td><a href="#Module.__init__">Module</a></td> |
|
819 <td>Constructor</td> |
|
820 </tr> |
|
821 </table> |
|
822 <h3>Static Methods</h3> |
|
823 |
|
824 <table> |
|
825 <tr><td>None</td></tr> |
|
826 </table> |
|
827 |
|
828 <a NAME="Module.__init__" ID="Module.__init__"></a> |
|
829 <h4>Module (Constructor)</h4> |
|
830 <b>Module</b>(<i>module, name, file, lineno</i>) |
|
831 |
|
832 <p> |
|
833 Constructor |
|
834 </p> |
|
835 <dl> |
|
836 |
|
837 <dt><i>module</i> (str)</dt> |
|
838 <dd> |
|
839 name of the module containing this module |
|
840 </dd> |
|
841 <dt><i>name</i> (str)</dt> |
|
842 <dd> |
|
843 name of this module |
|
844 </dd> |
|
845 <dt><i>file</i> (str)</dt> |
|
846 <dd> |
|
847 filename containing this module |
|
848 </dd> |
|
849 <dt><i>lineno</i> (int)</dt> |
|
850 <dd> |
|
851 line number of the module definition |
|
852 </dd> |
|
853 </dl> |
|
854 <div align="right"><a href="#top">Up</a></div> |
|
855 <hr /> |
|
856 <hr /> |
|
857 <a NAME="_ClbrBase" ID="_ClbrBase"></a> |
|
858 <h2>_ClbrBase</h2> |
|
859 |
|
860 <p> |
|
861 Class implementing the base of all class browser objects. |
|
862 </p> |
|
863 <h3>Derived from</h3> |
|
864 None |
|
865 <h3>Class Attributes</h3> |
|
866 |
|
867 <table> |
|
868 <tr><td>None</td></tr> |
|
869 </table> |
|
870 <h3>Class Methods</h3> |
|
871 |
|
872 <table> |
|
873 <tr><td>None</td></tr> |
|
874 </table> |
|
875 <h3>Methods</h3> |
|
876 |
|
877 <table> |
|
878 |
|
879 <tr> |
|
880 <td><a href="#_ClbrBase.__init__">_ClbrBase</a></td> |
|
881 <td>Constructor</td> |
|
882 </tr> |
|
883 <tr> |
|
884 <td><a href="#_ClbrBase.setEndLine">setEndLine</a></td> |
|
885 <td>Public method to set the ending line number.</td> |
|
886 </tr> |
|
887 </table> |
|
888 <h3>Static Methods</h3> |
|
889 |
|
890 <table> |
|
891 <tr><td>None</td></tr> |
|
892 </table> |
|
893 |
|
894 <a NAME="_ClbrBase.__init__" ID="_ClbrBase.__init__"></a> |
|
895 <h4>_ClbrBase (Constructor)</h4> |
|
896 <b>_ClbrBase</b>(<i>module, name, file, lineno</i>) |
|
897 |
|
898 <p> |
|
899 Constructor |
|
900 </p> |
|
901 <dl> |
|
902 |
|
903 <dt><i>module</i> (str)</dt> |
|
904 <dd> |
|
905 name of the module containing this object |
|
906 </dd> |
|
907 <dt><i>name</i> (str)</dt> |
|
908 <dd> |
|
909 name of this object |
|
910 </dd> |
|
911 <dt><i>file</i> (str)</dt> |
|
912 <dd> |
|
913 filename containing this object |
|
914 </dd> |
|
915 <dt><i>lineno</i> (int)</dt> |
|
916 <dd> |
|
917 linenumber of the object definition |
|
918 </dd> |
|
919 </dl> |
|
920 <a NAME="_ClbrBase.setEndLine" ID="_ClbrBase.setEndLine"></a> |
|
921 <h4>_ClbrBase.setEndLine</h4> |
|
922 <b>setEndLine</b>(<i>endLineNo</i>) |
|
923 |
|
924 <p> |
|
925 Public method to set the ending line number. |
|
926 </p> |
|
927 <dl> |
|
928 |
|
929 <dt><i>endLineNo</i> (int)</dt> |
|
930 <dd> |
|
931 number of the last line |
|
932 </dd> |
|
933 </dl> |
|
934 <div align="right"><a href="#top">Up</a></div> |
|
935 <hr /> |
|
936 </body></html> |