Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.pyclbr.html

src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.pyclbr.html

branch
eric7
changeset 10479
856476537696
parent 10433
328f3ec4b77a
child 10677
6ee2e475490c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Utilities.ClassBrowsers.pyclbr</h1> 9 <h1>eric7.Utilities.ClassBrowsers.pyclbr</h1>
10
11 <p> 10 <p>
12 Parse a Python file and retrieve classes, functions/methods and attributes. 11 Parse a Python file and retrieve classes, functions/methods and attributes.
13 </p> 12 </p>
14 <p> 13 <p>
15 Parse enough of a Python file to recognize class and method definitions and 14 Parse enough of a Python file to recognize class and method definitions and
16 to find out the superclasses of a class as well as its attributes. 15 to find out the superclasses of a class as well as its attributes.
17 </p> 16 </p>
17
18 <h3>Global Attributes</h3> 18 <h3>Global Attributes</h3>
19 19 <table>
20 <table> 20 <tr><td>SUPPORTED_TYPES</td></tr>
21 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>TABWIDTH</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr> 21 <tr><td>TABWIDTH</td></tr>
22 </table> 22 <tr><td>_commentsub</td></tr>
23 <tr><td>_getnext</td></tr>
24 </table>
25
23 <h3>Classes</h3> 26 <h3>Classes</h3>
24 27 <table>
25 <table>
26
27 <tr> 28 <tr>
28 <td><a href="#Attribute">Attribute</a></td> 29 <td><a href="#Attribute">Attribute</a></td>
29 <td>Class to represent a class attribute.</td> 30 <td>Class to represent a class attribute.</td>
30 </tr> 31 </tr>
31 <tr> 32 <tr>
51 <tr> 52 <tr>
52 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> 53 <td><a href="#VisibilityMixin">VisibilityMixin</a></td>
53 <td>Mixin class implementing the notion of visibility.</td> 54 <td>Mixin class implementing the notion of visibility.</td>
54 </tr> 55 </tr>
55 </table> 56 </table>
57
56 <h3>Functions</h3> 58 <h3>Functions</h3>
57 59 <table>
58 <table>
59
60 <tr> 60 <tr>
61 <td><a href="#_indent">_indent</a></td> 61 <td><a href="#_indent">_indent</a></td>
62 <td>Module function to return the indentation depth.</td> 62 <td>Module function to return the indentation depth.</td>
63 </tr> 63 </tr>
64 <tr> 64 <tr>
72 <tr> 72 <tr>
73 <td><a href="#scan">scan</a></td> 73 <td><a href="#scan">scan</a></td>
74 <td>Public method to scan the given source text.</td> 74 <td>Public method to scan the given source text.</td>
75 </tr> 75 </tr>
76 </table> 76 </table>
77
77 <hr /> 78 <hr />
78 <hr /> 79 <hr />
79 <a NAME="Attribute" ID="Attribute"></a> 80 <a NAME="Attribute" ID="Attribute"></a>
80 <h2>Attribute</h2> 81 <h2>Attribute</h2>
81
82 <p> 82 <p>
83 Class to represent a class attribute. 83 Class to represent a class attribute.
84 </p> 84 </p>
85
85 <h3>Derived from</h3> 86 <h3>Derived from</h3>
86 ClbrBaseClasses.Attribute, VisibilityMixin 87 ClbrBaseClasses.Attribute, VisibilityMixin
87 <h3>Class Attributes</h3> 88 <h3>Class Attributes</h3>
88 89 <table>
89 <table> 90 <tr><td>None</td></tr>
90 <tr><td>None</td></tr> 91 </table>
91 </table> 92
92 <h3>Class Methods</h3> 93 <h3>Class Methods</h3>
93 94 <table>
94 <table> 95 <tr><td>None</td></tr>
95 <tr><td>None</td></tr> 96 </table>
96 </table> 97
97 <h3>Methods</h3> 98 <h3>Methods</h3>
98 99 <table>
99 <table>
100
101 <tr> 100 <tr>
102 <td><a href="#Attribute.__init__">Attribute</a></td> 101 <td><a href="#Attribute.__init__">Attribute</a></td>
103 <td>Constructor</td> 102 <td>Constructor</td>
104 </tr> 103 </tr>
105 </table> 104 </table>
105
106 <h3>Static Methods</h3> 106 <h3>Static Methods</h3>
107 107 <table>
108 <table> 108 <tr><td>None</td></tr>
109 <tr><td>None</td></tr> 109 </table>
110 </table> 110
111 111
112 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> 112 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
113 <h4>Attribute (Constructor)</h4> 113 <h4>Attribute (Constructor)</h4>
114 <b>Attribute</b>(<i>module, name, file, lineno</i>) 114 <b>Attribute</b>(<i>module, name, file, lineno</i>)
115
116 <p> 115 <p>
117 Constructor 116 Constructor
118 </p> 117 </p>
118
119 <dl> 119 <dl>
120 120
121 <dt><i>module</i> (str)</dt> 121 <dt><i>module</i> (str)</dt>
122 <dd> 122 <dd>
123 name of the module containing this class 123 name of the module containing this class
138 <div align="right"><a href="#top">Up</a></div> 138 <div align="right"><a href="#top">Up</a></div>
139 <hr /> 139 <hr />
140 <hr /> 140 <hr />
141 <a NAME="Class" ID="Class"></a> 141 <a NAME="Class" ID="Class"></a>
142 <h2>Class</h2> 142 <h2>Class</h2>
143
144 <p> 143 <p>
145 Class to represent a Python class. 144 Class to represent a Python class.
146 </p> 145 </p>
146
147 <h3>Derived from</h3> 147 <h3>Derived from</h3>
148 ClbrBaseClasses.Class, VisibilityMixin 148 ClbrBaseClasses.Class, VisibilityMixin
149 <h3>Class Attributes</h3> 149 <h3>Class Attributes</h3>
150 150 <table>
151 <table> 151 <tr><td>None</td></tr>
152 <tr><td>None</td></tr> 152 </table>
153 </table> 153
154 <h3>Class Methods</h3> 154 <h3>Class Methods</h3>
155 155 <table>
156 <table> 156 <tr><td>None</td></tr>
157 <tr><td>None</td></tr> 157 </table>
158 </table> 158
159 <h3>Methods</h3> 159 <h3>Methods</h3>
160 160 <table>
161 <table>
162
163 <tr> 161 <tr>
164 <td><a href="#Class.__init__">Class</a></td> 162 <td><a href="#Class.__init__">Class</a></td>
165 <td>Constructor</td> 163 <td>Constructor</td>
166 </tr> 164 </tr>
167 </table> 165 </table>
166
168 <h3>Static Methods</h3> 167 <h3>Static Methods</h3>
169 168 <table>
170 <table> 169 <tr><td>None</td></tr>
171 <tr><td>None</td></tr> 170 </table>
172 </table> 171
173 172
174 <a NAME="Class.__init__" ID="Class.__init__"></a> 173 <a NAME="Class.__init__" ID="Class.__init__"></a>
175 <h4>Class (Constructor)</h4> 174 <h4>Class (Constructor)</h4>
176 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>) 175 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>)
177
178 <p> 176 <p>
179 Constructor 177 Constructor
180 </p> 178 </p>
179
181 <dl> 180 <dl>
182 181
183 <dt><i>module</i> (str)</dt> 182 <dt><i>module</i> (str)</dt>
184 <dd> 183 <dd>
185 name of the module containing this class 184 name of the module containing this class
204 <div align="right"><a href="#top">Up</a></div> 203 <div align="right"><a href="#top">Up</a></div>
205 <hr /> 204 <hr />
206 <hr /> 205 <hr />
207 <a NAME="Function" ID="Function"></a> 206 <a NAME="Function" ID="Function"></a>
208 <h2>Function</h2> 207 <h2>Function</h2>
209
210 <p> 208 <p>
211 Class to represent a Python function. 209 Class to represent a Python function.
212 </p> 210 </p>
211
213 <h3>Derived from</h3> 212 <h3>Derived from</h3>
214 ClbrBaseClasses.Function, VisibilityMixin 213 ClbrBaseClasses.Function, VisibilityMixin
215 <h3>Class Attributes</h3> 214 <h3>Class Attributes</h3>
216 215 <table>
217 <table> 216 <tr><td>None</td></tr>
218 <tr><td>None</td></tr> 217 </table>
219 </table> 218
220 <h3>Class Methods</h3> 219 <h3>Class Methods</h3>
221 220 <table>
222 <table> 221 <tr><td>None</td></tr>
223 <tr><td>None</td></tr> 222 </table>
224 </table> 223
225 <h3>Methods</h3> 224 <h3>Methods</h3>
226 225 <table>
227 <table>
228
229 <tr> 226 <tr>
230 <td><a href="#Function.__init__">Function</a></td> 227 <td><a href="#Function.__init__">Function</a></td>
231 <td>Constructor</td> 228 <td>Constructor</td>
232 </tr> 229 </tr>
233 </table> 230 </table>
231
234 <h3>Static Methods</h3> 232 <h3>Static Methods</h3>
235 233 <table>
236 <table> 234 <tr><td>None</td></tr>
237 <tr><td>None</td></tr> 235 </table>
238 </table> 236
239 237
240 <a NAME="Function.__init__" ID="Function.__init__"></a> 238 <a NAME="Function.__init__" ID="Function.__init__"></a>
241 <h4>Function (Constructor)</h4> 239 <h4>Function (Constructor)</h4>
242 <b>Function</b>(<i>module, name, file, lineno, signature="", separator=", ", modifierType=ClbrBaseClasses.Function.General, annotation="", </i>) 240 <b>Function</b>(<i>module, name, file, lineno, signature="", separator=", ", modifierType=ClbrBaseClasses.Function.General, annotation="", </i>)
243
244 <p> 241 <p>
245 Constructor 242 Constructor
246 </p> 243 </p>
244
247 <dl> 245 <dl>
248 246
249 <dt><i>module</i> (str)</dt> 247 <dt><i>module</i> (str)</dt>
250 <dd> 248 <dd>
251 name of the module containing this function 249 name of the module containing this function
282 <div align="right"><a href="#top">Up</a></div> 280 <div align="right"><a href="#top">Up</a></div>
283 <hr /> 281 <hr />
284 <hr /> 282 <hr />
285 <a NAME="ImportedModule" ID="ImportedModule"></a> 283 <a NAME="ImportedModule" ID="ImportedModule"></a>
286 <h2>ImportedModule</h2> 284 <h2>ImportedModule</h2>
287
288 <p> 285 <p>
289 Class to represent an imported module. 286 Class to represent an imported module.
290 </p> 287 </p>
288
291 <h3>Derived from</h3> 289 <h3>Derived from</h3>
292 None 290 None
293 <h3>Class Attributes</h3> 291 <h3>Class Attributes</h3>
294 292 <table>
295 <table> 293 <tr><td>None</td></tr>
296 <tr><td>None</td></tr> 294 </table>
297 </table> 295
298 <h3>Class Methods</h3> 296 <h3>Class Methods</h3>
299 297 <table>
300 <table> 298 <tr><td>None</td></tr>
301 <tr><td>None</td></tr> 299 </table>
302 </table> 300
303 <h3>Methods</h3> 301 <h3>Methods</h3>
304 302 <table>
305 <table>
306
307 <tr> 303 <tr>
308 <td><a href="#ImportedModule.__init__">ImportedModule</a></td> 304 <td><a href="#ImportedModule.__init__">ImportedModule</a></td>
309 <td>Constructor</td> 305 <td>Constructor</td>
310 </tr> 306 </tr>
311 <tr> 307 <tr>
312 <td><a href="#ImportedModule.addImport">addImport</a></td> 308 <td><a href="#ImportedModule.addImport">addImport</a></td>
313 <td>Public method to add a list of imported names.</td> 309 <td>Public method to add a list of imported names.</td>
314 </tr> 310 </tr>
315 </table> 311 </table>
312
316 <h3>Static Methods</h3> 313 <h3>Static Methods</h3>
317 314 <table>
318 <table> 315 <tr><td>None</td></tr>
319 <tr><td>None</td></tr> 316 </table>
320 </table> 317
321 318
322 <a NAME="ImportedModule.__init__" ID="ImportedModule.__init__"></a> 319 <a NAME="ImportedModule.__init__" ID="ImportedModule.__init__"></a>
323 <h4>ImportedModule (Constructor)</h4> 320 <h4>ImportedModule (Constructor)</h4>
324 <b>ImportedModule</b>(<i>module, file, importedModule</i>) 321 <b>ImportedModule</b>(<i>module, file, importedModule</i>)
325
326 <p> 322 <p>
327 Constructor 323 Constructor
328 </p> 324 </p>
325
329 <dl> 326 <dl>
330 327
331 <dt><i>module</i> (str)</dt> 328 <dt><i>module</i> (str)</dt>
332 <dd> 329 <dd>
333 name of the module containing the import 330 name of the module containing the import
342 </dd> 339 </dd>
343 </dl> 340 </dl>
344 <a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a> 341 <a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a>
345 <h4>ImportedModule.addImport</h4> 342 <h4>ImportedModule.addImport</h4>
346 <b>addImport</b>(<i>lineno, importedNames</i>) 343 <b>addImport</b>(<i>lineno, importedNames</i>)
347
348 <p> 344 <p>
349 Public method to add a list of imported names. 345 Public method to add a list of imported names.
350 </p> 346 </p>
347
351 <dl> 348 <dl>
352 349
353 <dt><i>lineno</i> (int)</dt> 350 <dt><i>lineno</i> (int)</dt>
354 <dd> 351 <dd>
355 line number of the import 352 line number of the import
362 <div align="right"><a href="#top">Up</a></div> 359 <div align="right"><a href="#top">Up</a></div>
363 <hr /> 360 <hr />
364 <hr /> 361 <hr />
365 <a NAME="Imports" ID="Imports"></a> 362 <a NAME="Imports" ID="Imports"></a>
366 <h2>Imports</h2> 363 <h2>Imports</h2>
367
368 <p> 364 <p>
369 Class to represent the list of imported modules. 365 Class to represent the list of imported modules.
370 </p> 366 </p>
367
371 <h3>Derived from</h3> 368 <h3>Derived from</h3>
372 None 369 None
373 <h3>Class Attributes</h3> 370 <h3>Class Attributes</h3>
374 371 <table>
375 <table> 372 <tr><td>None</td></tr>
376 <tr><td>None</td></tr> 373 </table>
377 </table> 374
378 <h3>Class Methods</h3> 375 <h3>Class Methods</h3>
379 376 <table>
380 <table> 377 <tr><td>None</td></tr>
381 <tr><td>None</td></tr> 378 </table>
382 </table> 379
383 <h3>Methods</h3> 380 <h3>Methods</h3>
384 381 <table>
385 <table>
386
387 <tr> 382 <tr>
388 <td><a href="#Imports.__init__">Imports</a></td> 383 <td><a href="#Imports.__init__">Imports</a></td>
389 <td>Constructor</td> 384 <td>Constructor</td>
390 </tr> 385 </tr>
391 <tr> 386 <tr>
399 <tr> 394 <tr>
400 <td><a href="#Imports.getImports">getImports</a></td> 395 <td><a href="#Imports.getImports">getImports</a></td>
401 <td>Public method to get all imported module names.</td> 396 <td>Public method to get all imported module names.</td>
402 </tr> 397 </tr>
403 </table> 398 </table>
399
404 <h3>Static Methods</h3> 400 <h3>Static Methods</h3>
405 401 <table>
406 <table> 402 <tr><td>None</td></tr>
407 <tr><td>None</td></tr> 403 </table>
408 </table> 404
409 405
410 <a NAME="Imports.__init__" ID="Imports.__init__"></a> 406 <a NAME="Imports.__init__" ID="Imports.__init__"></a>
411 <h4>Imports (Constructor)</h4> 407 <h4>Imports (Constructor)</h4>
412 <b>Imports</b>(<i>module, file</i>) 408 <b>Imports</b>(<i>module, file</i>)
413
414 <p> 409 <p>
415 Constructor 410 Constructor
416 </p> 411 </p>
412
417 <dl> 413 <dl>
418 414
419 <dt><i>module</i> (str)</dt> 415 <dt><i>module</i> (str)</dt>
420 <dd> 416 <dd>
421 name of the module containing the import 417 name of the module containing the import
426 </dd> 422 </dd>
427 </dl> 423 </dl>
428 <a NAME="Imports.addImport" ID="Imports.addImport"></a> 424 <a NAME="Imports.addImport" ID="Imports.addImport"></a>
429 <h4>Imports.addImport</h4> 425 <h4>Imports.addImport</h4>
430 <b>addImport</b>(<i>moduleName, names, lineno</i>) 426 <b>addImport</b>(<i>moduleName, names, lineno</i>)
431
432 <p> 427 <p>
433 Public method to add a list of imported names. 428 Public method to add a list of imported names.
434 </p> 429 </p>
430
435 <dl> 431 <dl>
436 432
437 <dt><i>moduleName</i> (str)</dt> 433 <dt><i>moduleName</i> (str)</dt>
438 <dd> 434 <dd>
439 name of the imported module 435 name of the imported module
448 </dd> 444 </dd>
449 </dl> 445 </dl>
450 <a NAME="Imports.getImport" ID="Imports.getImport"></a> 446 <a NAME="Imports.getImport" ID="Imports.getImport"></a>
451 <h4>Imports.getImport</h4> 447 <h4>Imports.getImport</h4>
452 <b>getImport</b>(<i>moduleName</i>) 448 <b>getImport</b>(<i>moduleName</i>)
453
454 <p> 449 <p>
455 Public method to get an imported module item. 450 Public method to get an imported module item.
456 </p> 451 </p>
452
457 <dl> 453 <dl>
458 454
459 <dt><i>moduleName</i> (str)</dt> 455 <dt><i>moduleName</i> (str)</dt>
460 <dd> 456 <dd>
461 name of the imported module 457 name of the imported module
474 </dd> 470 </dd>
475 </dl> 471 </dl>
476 <a NAME="Imports.getImports" ID="Imports.getImports"></a> 472 <a NAME="Imports.getImports" ID="Imports.getImports"></a>
477 <h4>Imports.getImports</h4> 473 <h4>Imports.getImports</h4>
478 <b>getImports</b>(<i></i>) 474 <b>getImports</b>(<i></i>)
479
480 <p> 475 <p>
481 Public method to get all imported module names. 476 Public method to get all imported module names.
482 </p> 477 </p>
478
483 <dl> 479 <dl>
484 <dt>Return:</dt> 480 <dt>Return:</dt>
485 <dd> 481 <dd>
486 dictionary of imported module names with name as key and list 482 dictionary of imported module names with name as key and list
487 of line numbers of imports as value 483 of line numbers of imports as value
496 <div align="right"><a href="#top">Up</a></div> 492 <div align="right"><a href="#top">Up</a></div>
497 <hr /> 493 <hr />
498 <hr /> 494 <hr />
499 <a NAME="Publics" ID="Publics"></a> 495 <a NAME="Publics" ID="Publics"></a>
500 <h2>Publics</h2> 496 <h2>Publics</h2>
501
502 <p> 497 <p>
503 Class to represent the list of public identifiers. 498 Class to represent the list of public identifiers.
504 </p> 499 </p>
500
505 <h3>Derived from</h3> 501 <h3>Derived from</h3>
506 None 502 None
507 <h3>Class Attributes</h3> 503 <h3>Class Attributes</h3>
508 504 <table>
509 <table> 505 <tr><td>file</td></tr>
510 <tr><td>file</td></tr><tr><td>identifiers</td></tr><tr><td>lineno</td></tr><tr><td>module</td></tr><tr><td>name</td></tr> 506 <tr><td>identifiers</td></tr>
511 </table> 507 <tr><td>lineno</td></tr>
508 <tr><td>module</td></tr>
509 <tr><td>name</td></tr>
510 </table>
511
512 <h3>Class Methods</h3> 512 <h3>Class Methods</h3>
513 513 <table>
514 <table> 514 <tr><td>None</td></tr>
515 <tr><td>None</td></tr> 515 </table>
516 </table> 516
517 <h3>Methods</h3> 517 <h3>Methods</h3>
518 518 <table>
519 <table> 519 <tr><td>None</td></tr>
520 <tr><td>None</td></tr> 520 </table>
521 </table> 521
522 <h3>Static Methods</h3> 522 <h3>Static Methods</h3>
523 523 <table>
524 <table> 524 <tr><td>None</td></tr>
525 <tr><td>None</td></tr> 525 </table>
526 </table> 526
527 527
528 <div align="right"><a href="#top">Up</a></div> 528 <div align="right"><a href="#top">Up</a></div>
529 <hr /> 529 <hr />
530 <hr /> 530 <hr />
531 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> 531 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a>
532 <h2>VisibilityMixin</h2> 532 <h2>VisibilityMixin</h2>
533
534 <p> 533 <p>
535 Mixin class implementing the notion of visibility. 534 Mixin class implementing the notion of visibility.
536 </p> 535 </p>
536
537 <h3>Derived from</h3> 537 <h3>Derived from</h3>
538 ClbrBaseClasses.ClbrVisibilityMixinBase 538 ClbrBaseClasses.ClbrVisibilityMixinBase
539 <h3>Class Attributes</h3> 539 <h3>Class Attributes</h3>
540 540 <table>
541 <table> 541 <tr><td>None</td></tr>
542 <tr><td>None</td></tr> 542 </table>
543 </table> 543
544 <h3>Class Methods</h3> 544 <h3>Class Methods</h3>
545 545 <table>
546 <table> 546 <tr><td>None</td></tr>
547 <tr><td>None</td></tr> 547 </table>
548 </table> 548
549 <h3>Methods</h3> 549 <h3>Methods</h3>
550 550 <table>
551 <table>
552
553 <tr> 551 <tr>
554 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> 552 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td>
555 <td>Constructor</td> 553 <td>Constructor</td>
556 </tr> 554 </tr>
557 </table> 555 </table>
556
558 <h3>Static Methods</h3> 557 <h3>Static Methods</h3>
559 558 <table>
560 <table> 559 <tr><td>None</td></tr>
561 <tr><td>None</td></tr> 560 </table>
562 </table> 561
563 562
564 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> 563 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a>
565 <h4>VisibilityMixin (Constructor)</h4> 564 <h4>VisibilityMixin (Constructor)</h4>
566 <b>VisibilityMixin</b>(<i></i>) 565 <b>VisibilityMixin</b>(<i></i>)
567
568 <p> 566 <p>
569 Constructor 567 Constructor
570 </p> 568 </p>
569
571 <div align="right"><a href="#top">Up</a></div> 570 <div align="right"><a href="#top">Up</a></div>
572 <hr /> 571 <hr />
573 <hr /> 572 <hr />
574 <a NAME="_indent" ID="_indent"></a> 573 <a NAME="_indent" ID="_indent"></a>
575 <h2>_indent</h2> 574 <h2>_indent</h2>
576 <b>_indent</b>(<i>ws</i>) 575 <b>_indent</b>(<i>ws</i>)
577
578 <p> 576 <p>
579 Module function to return the indentation depth. 577 Module function to return the indentation depth.
580 </p> 578 </p>
579
581 <dl> 580 <dl>
582 581
583 <dt><i>ws</i> (str)</dt> 582 <dt><i>ws</i> (str)</dt>
584 <dd> 583 <dd>
585 the whitespace to be checked 584 the whitespace to be checked
601 <hr /> 600 <hr />
602 <hr /> 601 <hr />
603 <a NAME="calculateEndline" ID="calculateEndline"></a> 602 <a NAME="calculateEndline" ID="calculateEndline"></a>
604 <h2>calculateEndline</h2> 603 <h2>calculateEndline</h2>
605 <b>calculateEndline</b>(<i>lineno, lines, indent</i>) 604 <b>calculateEndline</b>(<i>lineno, lines, indent</i>)
606
607 <p> 605 <p>
608 Function to calculate the end line of a class or method/function. 606 Function to calculate the end line of a class or method/function.
609 </p> 607 </p>
608
610 <dl> 609 <dl>
611 610
612 <dt><i>lineno</i> (int)</dt> 611 <dt><i>lineno</i> (int)</dt>
613 <dd> 612 <dd>
614 line number to start at (one based) 613 line number to start at (one based)
638 <hr /> 637 <hr />
639 <hr /> 638 <hr />
640 <a NAME="readmodule_ex" ID="readmodule_ex"></a> 639 <a NAME="readmodule_ex" ID="readmodule_ex"></a>
641 <h2>readmodule_ex</h2> 640 <h2>readmodule_ex</h2>
642 <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>) 641 <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>)
643
644 <p> 642 <p>
645 Read a module file and return a dictionary of classes. 643 Read a module file and return a dictionary of classes.
646 </p> 644 </p>
647 <p> 645 <p>
648 Search for MODULE in PATH and sys.path, read and parse the 646 Search for MODULE in PATH and sys.path, read and parse the
649 module and return a dictionary with one entry for each class 647 module and return a dictionary with one entry for each class
650 found in the module. 648 found in the module.
651 </p> 649 </p>
650
652 <dl> 651 <dl>
653 652
654 <dt><i>module</i> (str)</dt> 653 <dt><i>module</i> (str)</dt>
655 <dd> 654 <dd>
656 name of the module file 655 name of the module file
680 <hr /> 679 <hr />
681 <hr /> 680 <hr />
682 <a NAME="scan" ID="scan"></a> 681 <a NAME="scan" ID="scan"></a>
683 <h2>scan</h2> 682 <h2>scan</h2>
684 <b>scan</b>(<i>src, file, module</i>) 683 <b>scan</b>(<i>src, file, module</i>)
685
686 <p> 684 <p>
687 Public method to scan the given source text. 685 Public method to scan the given source text.
688 </p> 686 </p>
687
689 <dl> 688 <dl>
690 689
691 <dt><i>src</i> (str)</dt> 690 <dt><i>src</i> (str)</dt>
692 <dd> 691 <dd>
693 source text to be scanned 692 source text to be scanned

Mercurial Repository: eric

eric ide

mercurial