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