Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

branch
eric7
changeset 10479
856476537696
parent 10433
328f3ec4b77a
child 10784
521fd465b048
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.ModuleParser</h1> 9 <h1>eric7.Utilities.ModuleParser</h1>
10
11 <p> 10 <p>
12 Parse a Python module file. 11 Parse a Python module file.
13 </p> 12 </p>
14 <p> 13 <p>
15 <b>BUGS</b> (from pyclbr.py) 14 <b>BUGS</b> (from pyclbr.py)
17 <li>Code that doesn't pass tabnanny or python -t will confuse it, unless 16 <li>Code that doesn't pass tabnanny or python -t will confuse it, unless
18 you set the module TABWIDTH variable (default 8) to the correct tab width 17 you set the module TABWIDTH variable (default 8) to the correct tab width
19 for the file.</li> 18 for the file.</li>
20 </ul> 19 </ul>
21 </p> 20 </p>
21
22 <h3>Global Attributes</h3> 22 <h3>Global Attributes</h3>
23 23 <table>
24 <table> 24 <tr><td>PTL_SOURCE</td></tr>
25 <tr><td>PTL_SOURCE</td></tr><tr><td>PY_SOURCE</td></tr><tr><td>RB_SOURCE</td></tr><tr><td>SUPPORTED_TYPES</td></tr><tr><td>TABWIDTH</td></tr><tr><td>TYPE_MAPPING</td></tr><tr><td>__all__</td></tr><tr><td>_commentsub</td></tr><tr><td>_hashsub</td></tr><tr><td>_modules</td></tr><tr><td>_py_getnext</td></tr><tr><td>_rb_getnext</td></tr> 25 <tr><td>PY_SOURCE</td></tr>
26 </table> 26 <tr><td>RB_SOURCE</td></tr>
27 <tr><td>SUPPORTED_TYPES</td></tr>
28 <tr><td>TABWIDTH</td></tr>
29 <tr><td>TYPE_MAPPING</td></tr>
30 <tr><td>__all__</td></tr>
31 <tr><td>_commentsub</td></tr>
32 <tr><td>_hashsub</td></tr>
33 <tr><td>_modules</td></tr>
34 <tr><td>_py_getnext</td></tr>
35 <tr><td>_rb_getnext</td></tr>
36 </table>
37
27 <h3>Classes</h3> 38 <h3>Classes</h3>
28 39 <table>
29 <table>
30
31 <tr> 40 <tr>
32 <td><a href="#Attribute">Attribute</a></td> 41 <td><a href="#Attribute">Attribute</a></td>
33 <td>Class to represent a Python function or method.</td> 42 <td>Class to represent a Python function or method.</td>
34 </tr> 43 </tr>
35 <tr> 44 <tr>
51 <tr> 60 <tr>
52 <td><a href="#VisibilityBase">VisibilityBase</a></td> 61 <td><a href="#VisibilityBase">VisibilityBase</a></td>
53 <td>Class implementing the visibility aspect of all objects.</td> 62 <td>Class implementing the visibility aspect of all objects.</td>
54 </tr> 63 </tr>
55 </table> 64 </table>
65
56 <h3>Functions</h3> 66 <h3>Functions</h3>
57 67 <table>
58 <table>
59
60 <tr> 68 <tr>
61 <td><a href="#_indent">_indent</a></td> 69 <td><a href="#_indent">_indent</a></td>
62 <td>Protected function to determine the indent width of a whitespace string.</td> 70 <td>Protected function to determine the indent width of a whitespace string.</td>
63 </tr> 71 </tr>
64 <tr> 72 <tr>
80 <tr> 88 <tr>
81 <td><a href="#resetParsedModules">resetParsedModules</a></td> 89 <td><a href="#resetParsedModules">resetParsedModules</a></td>
82 <td>Module function to reset the list of modules already parsed.</td> 90 <td>Module function to reset the list of modules already parsed.</td>
83 </tr> 91 </tr>
84 </table> 92 </table>
93
85 <hr /> 94 <hr />
86 <hr /> 95 <hr />
87 <a NAME="Attribute" ID="Attribute"></a> 96 <a NAME="Attribute" ID="Attribute"></a>
88 <h2>Attribute</h2> 97 <h2>Attribute</h2>
89
90 <p> 98 <p>
91 Class to represent a Python function or method. 99 Class to represent a Python function or method.
92 </p> 100 </p>
101
93 <h3>Derived from</h3> 102 <h3>Derived from</h3>
94 VisibilityBase 103 VisibilityBase
95 <h3>Class Attributes</h3> 104 <h3>Class Attributes</h3>
96 105 <table>
97 <table> 106 <tr><td>None</td></tr>
98 <tr><td>None</td></tr> 107 </table>
99 </table> 108
100 <h3>Class Methods</h3> 109 <h3>Class Methods</h3>
101 110 <table>
102 <table> 111 <tr><td>None</td></tr>
103 <tr><td>None</td></tr> 112 </table>
104 </table> 113
105 <h3>Methods</h3> 114 <h3>Methods</h3>
106 115 <table>
107 <table>
108
109 <tr> 116 <tr>
110 <td><a href="#Attribute.__init__">Attribute</a></td> 117 <td><a href="#Attribute.__init__">Attribute</a></td>
111 <td>Constructor</td> 118 <td>Constructor</td>
112 </tr> 119 </tr>
113 <tr> 120 <tr>
114 <td><a href="#Attribute.addAssignment">addAssignment</a></td> 121 <td><a href="#Attribute.addAssignment">addAssignment</a></td>
115 <td>Public method to add another assignment line number.</td> 122 <td>Public method to add another assignment line number.</td>
116 </tr> 123 </tr>
117 </table> 124 </table>
125
118 <h3>Static Methods</h3> 126 <h3>Static Methods</h3>
119 127 <table>
120 <table> 128 <tr><td>None</td></tr>
121 <tr><td>None</td></tr> 129 </table>
122 </table> 130
123 131
124 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> 132 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
125 <h4>Attribute (Constructor)</h4> 133 <h4>Attribute (Constructor)</h4>
126 <b>Attribute</b>(<i>module, name, file, lineno, isSignal=False</i>) 134 <b>Attribute</b>(<i>module, name, file, lineno, isSignal=False</i>)
127
128 <p> 135 <p>
129 Constructor 136 Constructor
130 </p> 137 </p>
138
131 <dl> 139 <dl>
132 140
133 <dt><i>module</i> (str)</dt> 141 <dt><i>module</i> (str)</dt>
134 <dd> 142 <dd>
135 name of module containing this function 143 name of module containing this function
152 </dd> 160 </dd>
153 </dl> 161 </dl>
154 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a> 162 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
155 <h4>Attribute.addAssignment</h4> 163 <h4>Attribute.addAssignment</h4>
156 <b>addAssignment</b>(<i>lineno</i>) 164 <b>addAssignment</b>(<i>lineno</i>)
157
158 <p> 165 <p>
159 Public method to add another assignment line number. 166 Public method to add another assignment line number.
160 </p> 167 </p>
168
161 <dl> 169 <dl>
162 170
163 <dt><i>lineno</i> (int)</dt> 171 <dt><i>lineno</i> (int)</dt>
164 <dd> 172 <dd>
165 linenumber of the additional attribute assignment 173 linenumber of the additional attribute assignment
168 <div align="right"><a href="#top">Up</a></div> 176 <div align="right"><a href="#top">Up</a></div>
169 <hr /> 177 <hr />
170 <hr /> 178 <hr />
171 <a NAME="Class" ID="Class"></a> 179 <a NAME="Class" ID="Class"></a>
172 <h2>Class</h2> 180 <h2>Class</h2>
173
174 <p> 181 <p>
175 Class to represent a Python class. 182 Class to represent a Python class.
176 </p> 183 </p>
184
177 <h3>Derived from</h3> 185 <h3>Derived from</h3>
178 VisibilityBase 186 VisibilityBase
179 <h3>Class Attributes</h3> 187 <h3>Class Attributes</h3>
180 188 <table>
181 <table> 189 <tr><td>None</td></tr>
182 <tr><td>None</td></tr> 190 </table>
183 </table> 191
184 <h3>Class Methods</h3> 192 <h3>Class Methods</h3>
185 193 <table>
186 <table> 194 <tr><td>None</td></tr>
187 <tr><td>None</td></tr> 195 </table>
188 </table> 196
189 <h3>Methods</h3> 197 <h3>Methods</h3>
190 198 <table>
191 <table>
192
193 <tr> 199 <tr>
194 <td><a href="#Class.__init__">Class</a></td> 200 <td><a href="#Class.__init__">Class</a></td>
195 <td>Constructor</td> 201 <td>Constructor</td>
196 </tr> 202 </tr>
197 <tr> 203 <tr>
221 <tr> 227 <tr>
222 <td><a href="#Class.setEndLine">setEndLine</a></td> 228 <td><a href="#Class.setEndLine">setEndLine</a></td>
223 <td>Public method to record the number of the last line of a class.</td> 229 <td>Public method to record the number of the last line of a class.</td>
224 </tr> 230 </tr>
225 </table> 231 </table>
232
226 <h3>Static Methods</h3> 233 <h3>Static Methods</h3>
227 234 <table>
228 <table> 235 <tr><td>None</td></tr>
229 <tr><td>None</td></tr> 236 </table>
230 </table> 237
231 238
232 <a NAME="Class.__init__" ID="Class.__init__"></a> 239 <a NAME="Class.__init__" ID="Class.__init__"></a>
233 <h4>Class (Constructor)</h4> 240 <h4>Class (Constructor)</h4>
234 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>) 241 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>)
235
236 <p> 242 <p>
237 Constructor 243 Constructor
238 </p> 244 </p>
245
239 <dl> 246 <dl>
240 247
241 <dt><i>module</i> (str)</dt> 248 <dt><i>module</i> (str)</dt>
242 <dd> 249 <dd>
243 name of module containing this class 250 name of module containing this class
260 </dd> 267 </dd>
261 </dl> 268 </dl>
262 <a NAME="Class.addAttribute" ID="Class.addAttribute"></a> 269 <a NAME="Class.addAttribute" ID="Class.addAttribute"></a>
263 <h4>Class.addAttribute</h4> 270 <h4>Class.addAttribute</h4>
264 <b>addAttribute</b>(<i>name, attr</i>) 271 <b>addAttribute</b>(<i>name, attr</i>)
265
266 <p> 272 <p>
267 Public method to add information about attributes. 273 Public method to add information about attributes.
268 </p> 274 </p>
275
269 <dl> 276 <dl>
270 277
271 <dt><i>name</i> (str)</dt> 278 <dt><i>name</i> (str)</dt>
272 <dd> 279 <dd>
273 name of the attribute to add 280 name of the attribute to add
278 </dd> 285 </dd>
279 </dl> 286 </dl>
280 <a NAME="Class.addDescription" ID="Class.addDescription"></a> 287 <a NAME="Class.addDescription" ID="Class.addDescription"></a>
281 <h4>Class.addDescription</h4> 288 <h4>Class.addDescription</h4>
282 <b>addDescription</b>(<i>description</i>) 289 <b>addDescription</b>(<i>description</i>)
283
284 <p> 290 <p>
285 Public method to store the class docstring. 291 Public method to store the class docstring.
286 </p> 292 </p>
293
287 <dl> 294 <dl>
288 295
289 <dt><i>description</i> (str)</dt> 296 <dt><i>description</i> (str)</dt>
290 <dd> 297 <dd>
291 the docstring to be stored 298 the docstring to be stored
292 </dd> 299 </dd>
293 </dl> 300 </dl>
294 <a NAME="Class.addGlobal" ID="Class.addGlobal"></a> 301 <a NAME="Class.addGlobal" ID="Class.addGlobal"></a>
295 <h4>Class.addGlobal</h4> 302 <h4>Class.addGlobal</h4>
296 <b>addGlobal</b>(<i>name, attr</i>) 303 <b>addGlobal</b>(<i>name, attr</i>)
297
298 <p> 304 <p>
299 Public method to add information about global (class) variables. 305 Public method to add information about global (class) variables.
300 </p> 306 </p>
307
301 <dl> 308 <dl>
302 309
303 <dt><i>name</i> (str)</dt> 310 <dt><i>name</i> (str)</dt>
304 <dd> 311 <dd>
305 name of the global to add 312 name of the global to add
310 </dd> 317 </dd>
311 </dl> 318 </dl>
312 <a NAME="Class.addMethod" ID="Class.addMethod"></a> 319 <a NAME="Class.addMethod" ID="Class.addMethod"></a>
313 <h4>Class.addMethod</h4> 320 <h4>Class.addMethod</h4>
314 <b>addMethod</b>(<i>name, function</i>) 321 <b>addMethod</b>(<i>name, function</i>)
315
316 <p> 322 <p>
317 Public method to add information about a method. 323 Public method to add information about a method.
318 </p> 324 </p>
325
319 <dl> 326 <dl>
320 327
321 <dt><i>name</i> (str)</dt> 328 <dt><i>name</i> (str)</dt>
322 <dd> 329 <dd>
323 name of method to be added 330 name of method to be added
328 </dd> 335 </dd>
329 </dl> 336 </dl>
330 <a NAME="Class.getAttribute" ID="Class.getAttribute"></a> 337 <a NAME="Class.getAttribute" ID="Class.getAttribute"></a>
331 <h4>Class.getAttribute</h4> 338 <h4>Class.getAttribute</h4>
332 <b>getAttribute</b>(<i>name</i>) 339 <b>getAttribute</b>(<i>name</i>)
333
334 <p> 340 <p>
335 Public method to retrieve an attribute by name. 341 Public method to retrieve an attribute by name.
336 </p> 342 </p>
343
337 <dl> 344 <dl>
338 345
339 <dt><i>name</i> (str)</dt> 346 <dt><i>name</i> (str)</dt>
340 <dd> 347 <dd>
341 name of the attribute 348 name of the attribute
354 </dd> 361 </dd>
355 </dl> 362 </dl>
356 <a NAME="Class.getMethod" ID="Class.getMethod"></a> 363 <a NAME="Class.getMethod" ID="Class.getMethod"></a>
357 <h4>Class.getMethod</h4> 364 <h4>Class.getMethod</h4>
358 <b>getMethod</b>(<i>name</i>) 365 <b>getMethod</b>(<i>name</i>)
359
360 <p> 366 <p>
361 Public method to retrieve a method by name. 367 Public method to retrieve a method by name.
362 </p> 368 </p>
369
363 <dl> 370 <dl>
364 371
365 <dt><i>name</i> (str)</dt> 372 <dt><i>name</i> (str)</dt>
366 <dd> 373 <dd>
367 name of the method 374 name of the method
380 </dd> 387 </dd>
381 </dl> 388 </dl>
382 <a NAME="Class.setEndLine" ID="Class.setEndLine"></a> 389 <a NAME="Class.setEndLine" ID="Class.setEndLine"></a>
383 <h4>Class.setEndLine</h4> 390 <h4>Class.setEndLine</h4>
384 <b>setEndLine</b>(<i>endLineNo</i>) 391 <b>setEndLine</b>(<i>endLineNo</i>)
385
386 <p> 392 <p>
387 Public method to record the number of the last line of a class. 393 Public method to record the number of the last line of a class.
388 </p> 394 </p>
395
389 <dl> 396 <dl>
390 397
391 <dt><i>endLineNo</i> (int)</dt> 398 <dt><i>endLineNo</i> (int)</dt>
392 <dd> 399 <dd>
393 number of the last line 400 number of the last line
396 <div align="right"><a href="#top">Up</a></div> 403 <div align="right"><a href="#top">Up</a></div>
397 <hr /> 404 <hr />
398 <hr /> 405 <hr />
399 <a NAME="Function" ID="Function"></a> 406 <a NAME="Function" ID="Function"></a>
400 <h2>Function</h2> 407 <h2>Function</h2>
401
402 <p> 408 <p>
403 Class to represent a Python function or method. 409 Class to represent a Python function or method.
404 </p> 410 </p>
411
405 <h3>Derived from</h3> 412 <h3>Derived from</h3>
406 VisibilityBase 413 VisibilityBase
407 <h3>Class Attributes</h3> 414 <h3>Class Attributes</h3>
408 415 <table>
409 <table> 416 <tr><td>Class</td></tr>
410 <tr><td>Class</td></tr><tr><td>General</td></tr><tr><td>Static</td></tr> 417 <tr><td>General</td></tr>
411 </table> 418 <tr><td>Static</td></tr>
419 </table>
420
412 <h3>Class Methods</h3> 421 <h3>Class Methods</h3>
413 422 <table>
414 <table> 423 <tr><td>None</td></tr>
415 <tr><td>None</td></tr> 424 </table>
416 </table> 425
417 <h3>Methods</h3> 426 <h3>Methods</h3>
418 427 <table>
419 <table>
420
421 <tr> 428 <tr>
422 <td><a href="#Function.__init__">Function</a></td> 429 <td><a href="#Function.__init__">Function</a></td>
423 <td>Constructor</td> 430 <td>Constructor</td>
424 </tr> 431 </tr>
425 <tr> 432 <tr>
429 <tr> 436 <tr>
430 <td><a href="#Function.setEndLine">setEndLine</a></td> 437 <td><a href="#Function.setEndLine">setEndLine</a></td>
431 <td>Public method to record the number of the last line of a class.</td> 438 <td>Public method to record the number of the last line of a class.</td>
432 </tr> 439 </tr>
433 </table> 440 </table>
441
434 <h3>Static Methods</h3> 442 <h3>Static Methods</h3>
435 443 <table>
436 <table> 444 <tr><td>None</td></tr>
437 <tr><td>None</td></tr> 445 </table>
438 </table> 446
439 447
440 <a NAME="Function.__init__" ID="Function.__init__"></a> 448 <a NAME="Function.__init__" ID="Function.__init__"></a>
441 <h4>Function (Constructor)</h4> 449 <h4>Function (Constructor)</h4>
442 <b>Function</b>(<i>module, name, file, lineno, signature="", pyqtSignature=None, modifierType=General, annotation="", </i>) 450 <b>Function</b>(<i>module, name, file, lineno, signature="", pyqtSignature=None, modifierType=General, annotation="", </i>)
443
444 <p> 451 <p>
445 Constructor 452 Constructor
446 </p> 453 </p>
454
447 <dl> 455 <dl>
448 456
449 <dt><i>module</i> (str)</dt> 457 <dt><i>module</i> (str)</dt>
450 <dd> 458 <dd>
451 name of module containing this function 459 name of module containing this function
480 </dd> 488 </dd>
481 </dl> 489 </dl>
482 <a NAME="Function.addDescription" ID="Function.addDescription"></a> 490 <a NAME="Function.addDescription" ID="Function.addDescription"></a>
483 <h4>Function.addDescription</h4> 491 <h4>Function.addDescription</h4>
484 <b>addDescription</b>(<i>description</i>) 492 <b>addDescription</b>(<i>description</i>)
485
486 <p> 493 <p>
487 Public method to store the functions docstring. 494 Public method to store the functions docstring.
488 </p> 495 </p>
496
489 <dl> 497 <dl>
490 498
491 <dt><i>description</i> (str)</dt> 499 <dt><i>description</i> (str)</dt>
492 <dd> 500 <dd>
493 the docstring to be stored 501 the docstring to be stored
494 </dd> 502 </dd>
495 </dl> 503 </dl>
496 <a NAME="Function.setEndLine" ID="Function.setEndLine"></a> 504 <a NAME="Function.setEndLine" ID="Function.setEndLine"></a>
497 <h4>Function.setEndLine</h4> 505 <h4>Function.setEndLine</h4>
498 <b>setEndLine</b>(<i>endLineNo</i>) 506 <b>setEndLine</b>(<i>endLineNo</i>)
499
500 <p> 507 <p>
501 Public method to record the number of the last line of a class. 508 Public method to record the number of the last line of a class.
502 </p> 509 </p>
510
503 <dl> 511 <dl>
504 512
505 <dt><i>endLineNo</i> (int)</dt> 513 <dt><i>endLineNo</i> (int)</dt>
506 <dd> 514 <dd>
507 number of the last line 515 number of the last line
510 <div align="right"><a href="#top">Up</a></div> 518 <div align="right"><a href="#top">Up</a></div>
511 <hr /> 519 <hr />
512 <hr /> 520 <hr />
513 <a NAME="Module" ID="Module"></a> 521 <a NAME="Module" ID="Module"></a>
514 <h2>Module</h2> 522 <h2>Module</h2>
515
516 <p> 523 <p>
517 Class to represent a Python module. 524 Class to represent a Python module.
518 </p> 525 </p>
526
519 <h3>Derived from</h3> 527 <h3>Derived from</h3>
520 None 528 None
521 <h3>Class Attributes</h3> 529 <h3>Class Attributes</h3>
522 530 <table>
523 <table> 531 <tr><td>None</td></tr>
524 <tr><td>None</td></tr> 532 </table>
525 </table> 533
526 <h3>Class Methods</h3> 534 <h3>Class Methods</h3>
527 535 <table>
528 <table> 536 <tr><td>None</td></tr>
529 <tr><td>None</td></tr> 537 </table>
530 </table> 538
531 <h3>Methods</h3> 539 <h3>Methods</h3>
532 540 <table>
533 <table>
534
535 <tr> 541 <tr>
536 <td><a href="#Module.__init__">Module</a></td> 542 <td><a href="#Module.__init__">Module</a></td>
537 <td>Constructor</td> 543 <td>Constructor</td>
538 </tr> 544 </tr>
539 <tr> 545 <tr>
599 <tr> 605 <tr>
600 <td><a href="#Module.scan">scan</a></td> 606 <td><a href="#Module.scan">scan</a></td>
601 <td>Public method to scan the source text and retrieve the relevant information.</td> 607 <td>Public method to scan the source text and retrieve the relevant information.</td>
602 </tr> 608 </tr>
603 </table> 609 </table>
610
604 <h3>Static Methods</h3> 611 <h3>Static Methods</h3>
605 612 <table>
606 <table> 613 <tr><td>None</td></tr>
607 <tr><td>None</td></tr> 614 </table>
608 </table> 615
609 616
610 <a NAME="Module.__init__" ID="Module.__init__"></a> 617 <a NAME="Module.__init__" ID="Module.__init__"></a>
611 <h4>Module (Constructor)</h4> 618 <h4>Module (Constructor)</h4>
612 <b>Module</b>(<i>name, file=None, moduleType=None</i>) 619 <b>Module</b>(<i>name, file=None, moduleType=None</i>)
613
614 <p> 620 <p>
615 Constructor 621 Constructor
616 </p> 622 </p>
623
617 <dl> 624 <dl>
618 625
619 <dt><i>name</i> (str)</dt> 626 <dt><i>name</i> (str)</dt>
620 <dd> 627 <dd>
621 name of this module 628 name of this module
630 </dd> 637 </dd>
631 </dl> 638 </dl>
632 <a NAME="Module.__py_scan" ID="Module.__py_scan"></a> 639 <a NAME="Module.__py_scan" ID="Module.__py_scan"></a>
633 <h4>Module.__py_scan</h4> 640 <h4>Module.__py_scan</h4>
634 <b>__py_scan</b>(<i>src</i>) 641 <b>__py_scan</b>(<i>src</i>)
635
636 <p> 642 <p>
637 Private method to scan the source text of a Python module and retrieve 643 Private method to scan the source text of a Python module and retrieve
638 the relevant information. 644 the relevant information.
639 </p> 645 </p>
646
640 <dl> 647 <dl>
641 648
642 <dt><i>src</i> (str)</dt> 649 <dt><i>src</i> (str)</dt>
643 <dd> 650 <dd>
644 the source text to be scanned 651 the source text to be scanned
645 </dd> 652 </dd>
646 </dl> 653 </dl>
647 <a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a> 654 <a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a>
648 <h4>Module.__py_setVisibility</h4> 655 <h4>Module.__py_setVisibility</h4>
649 <b>__py_setVisibility</b>(<i>objectRef</i>) 656 <b>__py_setVisibility</b>(<i>objectRef</i>)
650
651 <p> 657 <p>
652 Private method to set the visibility of an object. 658 Private method to set the visibility of an object.
653 </p> 659 </p>
660
654 <dl> 661 <dl>
655 662
656 <dt><i>objectRef</i> (Attribute, Class or Function)</dt> 663 <dt><i>objectRef</i> (Attribute, Class or Function)</dt>
657 <dd> 664 <dd>
658 reference to the object 665 reference to the object
659 </dd> 666 </dd>
660 </dl> 667 </dl>
661 <a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a> 668 <a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a>
662 <h4>Module.__rb_scan</h4> 669 <h4>Module.__rb_scan</h4>
663 <b>__rb_scan</b>(<i>src</i>) 670 <b>__rb_scan</b>(<i>src</i>)
664
665 <p> 671 <p>
666 Private method to scan the source text of a Python module and retrieve 672 Private method to scan the source text of a Python module and retrieve
667 the relevant information. 673 the relevant information.
668 </p> 674 </p>
675
669 <dl> 676 <dl>
670 677
671 <dt><i>src</i> (str)</dt> 678 <dt><i>src</i> (str)</dt>
672 <dd> 679 <dd>
673 the source text to be scanned 680 the source text to be scanned
674 </dd> 681 </dd>
675 </dl> 682 </dl>
676 <a NAME="Module.addClass" ID="Module.addClass"></a> 683 <a NAME="Module.addClass" ID="Module.addClass"></a>
677 <h4>Module.addClass</h4> 684 <h4>Module.addClass</h4>
678 <b>addClass</b>(<i>name, _class</i>) 685 <b>addClass</b>(<i>name, _class</i>)
679
680 <p> 686 <p>
681 Public method to add information about a class. 687 Public method to add information about a class.
682 </p> 688 </p>
689
683 <dl> 690 <dl>
684 691
685 <dt><i>name</i> (str)</dt> 692 <dt><i>name</i> (str)</dt>
686 <dd> 693 <dd>
687 name of class to be added 694 name of class to be added
692 </dd> 699 </dd>
693 </dl> 700 </dl>
694 <a NAME="Module.addDescription" ID="Module.addDescription"></a> 701 <a NAME="Module.addDescription" ID="Module.addDescription"></a>
695 <h4>Module.addDescription</h4> 702 <h4>Module.addDescription</h4>
696 <b>addDescription</b>(<i>description</i>) 703 <b>addDescription</b>(<i>description</i>)
697
698 <p> 704 <p>
699 Public method to store the modules docstring. 705 Public method to store the modules docstring.
700 </p> 706 </p>
707
701 <dl> 708 <dl>
702 709
703 <dt><i>description</i> (str)</dt> 710 <dt><i>description</i> (str)</dt>
704 <dd> 711 <dd>
705 the docstring to be stored 712 the docstring to be stored
706 </dd> 713 </dd>
707 </dl> 714 </dl>
708 <a NAME="Module.addFunction" ID="Module.addFunction"></a> 715 <a NAME="Module.addFunction" ID="Module.addFunction"></a>
709 <h4>Module.addFunction</h4> 716 <h4>Module.addFunction</h4>
710 <b>addFunction</b>(<i>name, function</i>) 717 <b>addFunction</b>(<i>name, function</i>)
711
712 <p> 718 <p>
713 Public method to add information about a function. 719 Public method to add information about a function.
714 </p> 720 </p>
721
715 <dl> 722 <dl>
716 723
717 <dt><i>name</i> (str)</dt> 724 <dt><i>name</i> (str)</dt>
718 <dd> 725 <dd>
719 name of function to be added 726 name of function to be added
724 </dd> 731 </dd>
725 </dl> 732 </dl>
726 <a NAME="Module.addGlobal" ID="Module.addGlobal"></a> 733 <a NAME="Module.addGlobal" ID="Module.addGlobal"></a>
727 <h4>Module.addGlobal</h4> 734 <h4>Module.addGlobal</h4>
728 <b>addGlobal</b>(<i>name, attr</i>) 735 <b>addGlobal</b>(<i>name, attr</i>)
729
730 <p> 736 <p>
731 Public method to add information about global variables. 737 Public method to add information about global variables.
732 </p> 738 </p>
739
733 <dl> 740 <dl>
734 741
735 <dt><i>name</i> (str)</dt> 742 <dt><i>name</i> (str)</dt>
736 <dd> 743 <dd>
737 name of the global to add 744 name of the global to add
742 </dd> 749 </dd>
743 </dl> 750 </dl>
744 <a NAME="Module.addModule" ID="Module.addModule"></a> 751 <a NAME="Module.addModule" ID="Module.addModule"></a>
745 <h4>Module.addModule</h4> 752 <h4>Module.addModule</h4>
746 <b>addModule</b>(<i>name, module</i>) 753 <b>addModule</b>(<i>name, module</i>)
747
748 <p> 754 <p>
749 Public method to add information about a Ruby module. 755 Public method to add information about a Ruby module.
750 </p> 756 </p>
757
751 <dl> 758 <dl>
752 759
753 <dt><i>name</i> (str)</dt> 760 <dt><i>name</i> (str)</dt>
754 <dd> 761 <dd>
755 name of module to be added 762 name of module to be added
760 </dd> 767 </dd>
761 </dl> 768 </dl>
762 <a NAME="Module.addPathToHierarchy" ID="Module.addPathToHierarchy"></a> 769 <a NAME="Module.addPathToHierarchy" ID="Module.addPathToHierarchy"></a>
763 <h4>Module.addPathToHierarchy</h4> 770 <h4>Module.addPathToHierarchy</h4>
764 <b>addPathToHierarchy</b>(<i>path, result, fn</i>) 771 <b>addPathToHierarchy</b>(<i>path, result, fn</i>)
765
766 <p> 772 <p>
767 Public method to put the exhausted path into the result dictionary. 773 Public method to put the exhausted path into the result dictionary.
768 </p> 774 </p>
775
769 <dl> 776 <dl>
770 777
771 <dt><i>path</i> (list of str)</dt> 778 <dt><i>path</i> (list of str)</dt>
772 <dd> 779 <dd>
773 the exhausted path of classes 780 the exhausted path of classes
783 </dd> 790 </dd>
784 </dl> 791 </dl>
785 <a NAME="Module.assembleHierarchy" ID="Module.assembleHierarchy"></a> 792 <a NAME="Module.assembleHierarchy" ID="Module.assembleHierarchy"></a>
786 <h4>Module.assembleHierarchy</h4> 793 <h4>Module.assembleHierarchy</h4>
787 <b>assembleHierarchy</b>(<i>name, classes, path, result</i>) 794 <b>assembleHierarchy</b>(<i>name, classes, path, result</i>)
788
789 <p> 795 <p>
790 Public method to assemble the inheritance hierarchy. 796 Public method to assemble the inheritance hierarchy.
791 </p> 797 </p>
792 <p> 798 <p>
793 This method will traverse the class hierarchy, from a given class 799 This method will traverse the class hierarchy, from a given class
795 intended to be inverted, i.e. the highest level are the super classes. 801 intended to be inverted, i.e. the highest level are the super classes.
796 </p> 802 </p>
797 <p> 803 <p>
798 This code is borrowed from Boa Constructor. 804 This code is borrowed from Boa Constructor.
799 </p> 805 </p>
806
800 <dl> 807 <dl>
801 808
802 <dt><i>name</i> (str)</dt> 809 <dt><i>name</i> (str)</dt>
803 <dd> 810 <dd>
804 name of class to assemble hierarchy 811 name of class to assemble hierarchy
817 </dd> 824 </dd>
818 </dl> 825 </dl>
819 <a NAME="Module.calculateEndline" ID="Module.calculateEndline"></a> 826 <a NAME="Module.calculateEndline" ID="Module.calculateEndline"></a>
820 <h4>Module.calculateEndline</h4> 827 <h4>Module.calculateEndline</h4>
821 <b>calculateEndline</b>(<i>lines, indent</i>) 828 <b>calculateEndline</b>(<i>lines, indent</i>)
822
823 <p> 829 <p>
824 Function to calculate the end line of a class or method/function. 830 Function to calculate the end line of a class or method/function.
825 </p> 831 </p>
832
826 <dl> 833 <dl>
827 834
828 <dt><i>lineno</i> (int)</dt> 835 <dt><i>lineno</i> (int)</dt>
829 <dd> 836 <dd>
830 line number to start at (one based) 837 line number to start at (one based)
851 </dd> 858 </dd>
852 </dl> 859 </dl>
853 <a NAME="Module.createHierarchy" ID="Module.createHierarchy"></a> 860 <a NAME="Module.createHierarchy" ID="Module.createHierarchy"></a>
854 <h4>Module.createHierarchy</h4> 861 <h4>Module.createHierarchy</h4>
855 <b>createHierarchy</b>(<i></i>) 862 <b>createHierarchy</b>(<i></i>)
856
857 <p> 863 <p>
858 Public method to build the inheritance hierarchy for all classes of 864 Public method to build the inheritance hierarchy for all classes of
859 this module. 865 this module.
860 </p> 866 </p>
867
861 <dl> 868 <dl>
862 <dt>Return:</dt> 869 <dt>Return:</dt>
863 <dd> 870 <dd>
864 A dictionary with inheritance hierarchies. 871 A dictionary with inheritance hierarchies.
865 </dd> 872 </dd>
871 </dd> 878 </dd>
872 </dl> 879 </dl>
873 <a NAME="Module.getFileName" ID="Module.getFileName"></a> 880 <a NAME="Module.getFileName" ID="Module.getFileName"></a>
874 <h4>Module.getFileName</h4> 881 <h4>Module.getFileName</h4>
875 <b>getFileName</b>(<i></i>) 882 <b>getFileName</b>(<i></i>)
876
877 <p> 883 <p>
878 Public method to retrieve the modules filename. 884 Public method to retrieve the modules filename.
879 </p> 885 </p>
886
880 <dl> 887 <dl>
881 <dt>Return:</dt> 888 <dt>Return:</dt>
882 <dd> 889 <dd>
883 module filename 890 module filename
884 </dd> 891 </dd>
890 </dd> 897 </dd>
891 </dl> 898 </dl>
892 <a NAME="Module.getName" ID="Module.getName"></a> 899 <a NAME="Module.getName" ID="Module.getName"></a>
893 <h4>Module.getName</h4> 900 <h4>Module.getName</h4>
894 <b>getName</b>(<i></i>) 901 <b>getName</b>(<i></i>)
895
896 <p> 902 <p>
897 Public method to retrieve the modules name. 903 Public method to retrieve the modules name.
898 </p> 904 </p>
905
899 <dl> 906 <dl>
900 <dt>Return:</dt> 907 <dt>Return:</dt>
901 <dd> 908 <dd>
902 module name 909 module name
903 </dd> 910 </dd>
909 </dd> 916 </dd>
910 </dl> 917 </dl>
911 <a NAME="Module.getType" ID="Module.getType"></a> 918 <a NAME="Module.getType" ID="Module.getType"></a>
912 <h4>Module.getType</h4> 919 <h4>Module.getType</h4>
913 <b>getType</b>(<i></i>) 920 <b>getType</b>(<i></i>)
914
915 <p> 921 <p>
916 Public method to get the type of the module's source. 922 Public method to get the type of the module's source.
917 </p> 923 </p>
924
918 <dl> 925 <dl>
919 <dt>Return:</dt> 926 <dt>Return:</dt>
920 <dd> 927 <dd>
921 type of the modules's source 928 type of the modules's source
922 </dd> 929 </dd>
928 </dd> 935 </dd>
929 </dl> 936 </dl>
930 <a NAME="Module.scan" ID="Module.scan"></a> 937 <a NAME="Module.scan" ID="Module.scan"></a>
931 <h4>Module.scan</h4> 938 <h4>Module.scan</h4>
932 <b>scan</b>(<i>src</i>) 939 <b>scan</b>(<i>src</i>)
933
934 <p> 940 <p>
935 Public method to scan the source text and retrieve the relevant 941 Public method to scan the source text and retrieve the relevant
936 information. 942 information.
937 </p> 943 </p>
944
938 <dl> 945 <dl>
939 946
940 <dt><i>src</i> (str)</dt> 947 <dt><i>src</i> (str)</dt>
941 <dd> 948 <dd>
942 the source text to be scanned 949 the source text to be scanned
945 <div align="right"><a href="#top">Up</a></div> 952 <div align="right"><a href="#top">Up</a></div>
946 <hr /> 953 <hr />
947 <hr /> 954 <hr />
948 <a NAME="RbModule" ID="RbModule"></a> 955 <a NAME="RbModule" ID="RbModule"></a>
949 <h2>RbModule</h2> 956 <h2>RbModule</h2>
950
951 <p> 957 <p>
952 Class to represent a Ruby module. 958 Class to represent a Ruby module.
953 </p> 959 </p>
960
954 <h3>Derived from</h3> 961 <h3>Derived from</h3>
955 Class 962 Class
956 <h3>Class Attributes</h3> 963 <h3>Class Attributes</h3>
957 964 <table>
958 <table> 965 <tr><td>None</td></tr>
959 <tr><td>None</td></tr> 966 </table>
960 </table> 967
961 <h3>Class Methods</h3> 968 <h3>Class Methods</h3>
962 969 <table>
963 <table> 970 <tr><td>None</td></tr>
964 <tr><td>None</td></tr> 971 </table>
965 </table> 972
966 <h3>Methods</h3> 973 <h3>Methods</h3>
967 974 <table>
968 <table>
969
970 <tr> 975 <tr>
971 <td><a href="#RbModule.__init__">RbModule</a></td> 976 <td><a href="#RbModule.__init__">RbModule</a></td>
972 <td>Constructor</td> 977 <td>Constructor</td>
973 </tr> 978 </tr>
974 <tr> 979 <tr>
975 <td><a href="#RbModule.addClass">addClass</a></td> 980 <td><a href="#RbModule.addClass">addClass</a></td>
976 <td>Public method to add information about a class.</td> 981 <td>Public method to add information about a class.</td>
977 </tr> 982 </tr>
978 </table> 983 </table>
984
979 <h3>Static Methods</h3> 985 <h3>Static Methods</h3>
980 986 <table>
981 <table> 987 <tr><td>None</td></tr>
982 <tr><td>None</td></tr> 988 </table>
983 </table> 989
984 990
985 <a NAME="RbModule.__init__" ID="RbModule.__init__"></a> 991 <a NAME="RbModule.__init__" ID="RbModule.__init__"></a>
986 <h4>RbModule (Constructor)</h4> 992 <h4>RbModule (Constructor)</h4>
987 <b>RbModule</b>(<i>module, name, file, lineno</i>) 993 <b>RbModule</b>(<i>module, name, file, lineno</i>)
988
989 <p> 994 <p>
990 Constructor 995 Constructor
991 </p> 996 </p>
997
992 <dl> 998 <dl>
993 999
994 <dt><i>module</i> (str)</dt> 1000 <dt><i>module</i> (str)</dt>
995 <dd> 1001 <dd>
996 name of module containing this class 1002 name of module containing this class
1009 </dd> 1015 </dd>
1010 </dl> 1016 </dl>
1011 <a NAME="RbModule.addClass" ID="RbModule.addClass"></a> 1017 <a NAME="RbModule.addClass" ID="RbModule.addClass"></a>
1012 <h4>RbModule.addClass</h4> 1018 <h4>RbModule.addClass</h4>
1013 <b>addClass</b>(<i>name, _class</i>) 1019 <b>addClass</b>(<i>name, _class</i>)
1014
1015 <p> 1020 <p>
1016 Public method to add information about a class. 1021 Public method to add information about a class.
1017 </p> 1022 </p>
1023
1018 <dl> 1024 <dl>
1019 1025
1020 <dt><i>name</i> (str)</dt> 1026 <dt><i>name</i> (str)</dt>
1021 <dd> 1027 <dd>
1022 name of class to be added 1028 name of class to be added
1029 <div align="right"><a href="#top">Up</a></div> 1035 <div align="right"><a href="#top">Up</a></div>
1030 <hr /> 1036 <hr />
1031 <hr /> 1037 <hr />
1032 <a NAME="VisibilityBase" ID="VisibilityBase"></a> 1038 <a NAME="VisibilityBase" ID="VisibilityBase"></a>
1033 <h2>VisibilityBase</h2> 1039 <h2>VisibilityBase</h2>
1034
1035 <p> 1040 <p>
1036 Class implementing the visibility aspect of all objects. 1041 Class implementing the visibility aspect of all objects.
1037 </p> 1042 </p>
1043
1038 <h3>Derived from</h3> 1044 <h3>Derived from</h3>
1039 None 1045 None
1040 <h3>Class Attributes</h3> 1046 <h3>Class Attributes</h3>
1041 1047 <table>
1042 <table> 1048 <tr><td>None</td></tr>
1043 <tr><td>None</td></tr> 1049 </table>
1044 </table> 1050
1045 <h3>Class Methods</h3> 1051 <h3>Class Methods</h3>
1046 1052 <table>
1047 <table> 1053 <tr><td>None</td></tr>
1048 <tr><td>None</td></tr> 1054 </table>
1049 </table> 1055
1050 <h3>Methods</h3> 1056 <h3>Methods</h3>
1051 1057 <table>
1052 <table>
1053
1054 <tr> 1058 <tr>
1055 <td><a href="#VisibilityBase.isPrivate">isPrivate</a></td> 1059 <td><a href="#VisibilityBase.isPrivate">isPrivate</a></td>
1056 <td>Public method to check, if the visibility is Private.</td> 1060 <td>Public method to check, if the visibility is Private.</td>
1057 </tr> 1061 </tr>
1058 <tr> 1062 <tr>
1074 <tr> 1078 <tr>
1075 <td><a href="#VisibilityBase.setPublic">setPublic</a></td> 1079 <td><a href="#VisibilityBase.setPublic">setPublic</a></td>
1076 <td>Public method to set the visibility to Public.</td> 1080 <td>Public method to set the visibility to Public.</td>
1077 </tr> 1081 </tr>
1078 </table> 1082 </table>
1083
1079 <h3>Static Methods</h3> 1084 <h3>Static Methods</h3>
1080 1085 <table>
1081 <table> 1086 <tr><td>None</td></tr>
1082 <tr><td>None</td></tr> 1087 </table>
1083 </table> 1088
1084 1089
1085 <a NAME="VisibilityBase.isPrivate" ID="VisibilityBase.isPrivate"></a> 1090 <a NAME="VisibilityBase.isPrivate" ID="VisibilityBase.isPrivate"></a>
1086 <h4>VisibilityBase.isPrivate</h4> 1091 <h4>VisibilityBase.isPrivate</h4>
1087 <b>isPrivate</b>(<i></i>) 1092 <b>isPrivate</b>(<i></i>)
1088
1089 <p> 1093 <p>
1090 Public method to check, if the visibility is Private. 1094 Public method to check, if the visibility is Private.
1091 </p> 1095 </p>
1096
1092 <dl> 1097 <dl>
1093 <dt>Return:</dt> 1098 <dt>Return:</dt>
1094 <dd> 1099 <dd>
1095 flag indicating Private visibility 1100 flag indicating Private visibility
1096 </dd> 1101 </dd>
1102 </dd> 1107 </dd>
1103 </dl> 1108 </dl>
1104 <a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a> 1109 <a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a>
1105 <h4>VisibilityBase.isProtected</h4> 1110 <h4>VisibilityBase.isProtected</h4>
1106 <b>isProtected</b>(<i></i>) 1111 <b>isProtected</b>(<i></i>)
1107
1108 <p> 1112 <p>
1109 Public method to check, if the visibility is Protected. 1113 Public method to check, if the visibility is Protected.
1110 </p> 1114 </p>
1115
1111 <dl> 1116 <dl>
1112 <dt>Return:</dt> 1117 <dt>Return:</dt>
1113 <dd> 1118 <dd>
1114 flag indicating Protected visibility 1119 flag indicating Protected visibility
1115 </dd> 1120 </dd>
1121 </dd> 1126 </dd>
1122 </dl> 1127 </dl>
1123 <a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a> 1128 <a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a>
1124 <h4>VisibilityBase.isPublic</h4> 1129 <h4>VisibilityBase.isPublic</h4>
1125 <b>isPublic</b>(<i></i>) 1130 <b>isPublic</b>(<i></i>)
1126
1127 <p> 1131 <p>
1128 Public method to check, if the visibility is Public. 1132 Public method to check, if the visibility is Public.
1129 </p> 1133 </p>
1134
1130 <dl> 1135 <dl>
1131 <dt>Return:</dt> 1136 <dt>Return:</dt>
1132 <dd> 1137 <dd>
1133 flag indicating Public visibility 1138 flag indicating Public visibility
1134 </dd> 1139 </dd>
1140 </dd> 1145 </dd>
1141 </dl> 1146 </dl>
1142 <a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a> 1147 <a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a>
1143 <h4>VisibilityBase.setPrivate</h4> 1148 <h4>VisibilityBase.setPrivate</h4>
1144 <b>setPrivate</b>(<i></i>) 1149 <b>setPrivate</b>(<i></i>)
1145
1146 <p> 1150 <p>
1147 Public method to set the visibility to Private. 1151 Public method to set the visibility to Private.
1148 </p> 1152 </p>
1153
1149 <a NAME="VisibilityBase.setProtected" ID="VisibilityBase.setProtected"></a> 1154 <a NAME="VisibilityBase.setProtected" ID="VisibilityBase.setProtected"></a>
1150 <h4>VisibilityBase.setProtected</h4> 1155 <h4>VisibilityBase.setProtected</h4>
1151 <b>setProtected</b>(<i></i>) 1156 <b>setProtected</b>(<i></i>)
1152
1153 <p> 1157 <p>
1154 Public method to set the visibility to Protected. 1158 Public method to set the visibility to Protected.
1155 </p> 1159 </p>
1160
1156 <a NAME="VisibilityBase.setPublic" ID="VisibilityBase.setPublic"></a> 1161 <a NAME="VisibilityBase.setPublic" ID="VisibilityBase.setPublic"></a>
1157 <h4>VisibilityBase.setPublic</h4> 1162 <h4>VisibilityBase.setPublic</h4>
1158 <b>setPublic</b>(<i></i>) 1163 <b>setPublic</b>(<i></i>)
1159
1160 <p> 1164 <p>
1161 Public method to set the visibility to Public. 1165 Public method to set the visibility to Public.
1162 </p> 1166 </p>
1167
1163 <div align="right"><a href="#top">Up</a></div> 1168 <div align="right"><a href="#top">Up</a></div>
1164 <hr /> 1169 <hr />
1165 <hr /> 1170 <hr />
1166 <a NAME="_indent" ID="_indent"></a> 1171 <a NAME="_indent" ID="_indent"></a>
1167 <h2>_indent</h2> 1172 <h2>_indent</h2>
1168 <b>_indent</b>(<i>ws</i>) 1173 <b>_indent</b>(<i>ws</i>)
1169
1170 <p> 1174 <p>
1171 Protected function to determine the indent width of a whitespace string. 1175 Protected function to determine the indent width of a whitespace string.
1172 </p> 1176 </p>
1177
1173 <dl> 1178 <dl>
1174 1179
1175 <dt><i>ws</i> (str)</dt> 1180 <dt><i>ws</i> (str)</dt>
1176 <dd> 1181 <dd>
1177 The whitespace string to be cheked. 1182 The whitespace string to be cheked.
1193 <hr /> 1198 <hr />
1194 <hr /> 1199 <hr />
1195 <a NAME="find_module" ID="find_module"></a> 1200 <a NAME="find_module" ID="find_module"></a>
1196 <h2>find_module</h2> 1201 <h2>find_module</h2>
1197 <b>find_module</b>(<i>name, path, extensions</i>) 1202 <b>find_module</b>(<i>name, path, extensions</i>)
1198
1199 <p> 1203 <p>
1200 Module function to extend the Python module finding mechanism. 1204 Module function to extend the Python module finding mechanism.
1201 </p> 1205 </p>
1202 <p> 1206 <p>
1203 This function searches for files in the given path. If the filename 1207 This function searches for files in the given path. If the filename
1204 doesn't have an extension or an extension of .py, the normal search 1208 doesn't have an extension or an extension of .py, the normal search
1205 implemented in the imp module is used. For all other supported files 1209 implemented in the imp module is used. For all other supported files
1206 only path is searched. 1210 only path is searched.
1207 </p> 1211 </p>
1212
1208 <dl> 1213 <dl>
1209 1214
1210 <dt><i>name</i> (str)</dt> 1215 <dt><i>name</i> (str)</dt>
1211 <dd> 1216 <dd>
1212 filename or modulename to search for 1217 filename or modulename to search for
1245 <hr /> 1250 <hr />
1246 <hr /> 1251 <hr />
1247 <a NAME="getTypeFromTypeName" ID="getTypeFromTypeName"></a> 1252 <a NAME="getTypeFromTypeName" ID="getTypeFromTypeName"></a>
1248 <h2>getTypeFromTypeName</h2> 1253 <h2>getTypeFromTypeName</h2>
1249 <b>getTypeFromTypeName</b>(<i>name</i>) 1254 <b>getTypeFromTypeName</b>(<i>name</i>)
1250
1251 <p> 1255 <p>
1252 Module function to determine the module type given the module type name. 1256 Module function to determine the module type given the module type name.
1253 </p> 1257 </p>
1258
1254 <dl> 1259 <dl>
1255 1260
1256 <dt><i>name</i> (str)</dt> 1261 <dt><i>name</i> (str)</dt>
1257 <dd> 1262 <dd>
1258 module type name 1263 module type name
1274 <hr /> 1279 <hr />
1275 <hr /> 1280 <hr />
1276 <a NAME="readModule" ID="readModule"></a> 1281 <a NAME="readModule" ID="readModule"></a>
1277 <h2>readModule</h2> 1282 <h2>readModule</h2>
1278 <b>readModule</b>(<i>module, path=None, inpackage=False, basename="", extensions=None, caching=True, ignoreBuiltinModules=False, </i>) 1283 <b>readModule</b>(<i>module, path=None, inpackage=False, basename="", extensions=None, caching=True, ignoreBuiltinModules=False, </i>)
1279
1280 <p> 1284 <p>
1281 Function to read a module file and parse it. 1285 Function to read a module file and parse it.
1282 </p> 1286 </p>
1283 <p> 1287 <p>
1284 The module is searched in path and sys.path, read and parsed. 1288 The module is searched in path and sys.path, read and parsed.
1285 If the module was parsed before, the information is taken 1289 If the module was parsed before, the information is taken
1286 from a cache in order to speed up processing. 1290 from a cache in order to speed up processing.
1287 </p> 1291 </p>
1292
1288 <dl> 1293 <dl>
1289 1294
1290 <dt><i>module</i> (str)</dt> 1295 <dt><i>module</i> (str)</dt>
1291 <dd> 1296 <dd>
1292 name of the module to be parsed 1297 name of the module to be parsed
1337 <hr /> 1342 <hr />
1338 <hr /> 1343 <hr />
1339 <a NAME="resetParsedModule" ID="resetParsedModule"></a> 1344 <a NAME="resetParsedModule" ID="resetParsedModule"></a>
1340 <h2>resetParsedModule</h2> 1345 <h2>resetParsedModule</h2>
1341 <b>resetParsedModule</b>(<i>module, basename=""</i>) 1346 <b>resetParsedModule</b>(<i>module, basename=""</i>)
1342
1343 <p> 1347 <p>
1344 Module function to clear one module from the list of parsed modules. 1348 Module function to clear one module from the list of parsed modules.
1345 </p> 1349 </p>
1350
1346 <dl> 1351 <dl>
1347 1352
1348 <dt><i>module</i> (str)</dt> 1353 <dt><i>module</i> (str)</dt>
1349 <dd> 1354 <dd>
1350 Name of the module to be parsed 1355 Name of the module to be parsed
1359 <hr /> 1364 <hr />
1360 <hr /> 1365 <hr />
1361 <a NAME="resetParsedModules" ID="resetParsedModules"></a> 1366 <a NAME="resetParsedModules" ID="resetParsedModules"></a>
1362 <h2>resetParsedModules</h2> 1367 <h2>resetParsedModules</h2>
1363 <b>resetParsedModules</b>(<i></i>) 1368 <b>resetParsedModules</b>(<i></i>)
1364
1365 <p> 1369 <p>
1366 Module function to reset the list of modules already parsed. 1370 Module function to reset the list of modules already parsed.
1367 </p> 1371 </p>
1372
1368 <div align="right"><a href="#top">Up</a></div> 1373 <div align="right"><a href="#top">Up</a></div>
1369 <hr /> 1374 <hr />
1370 </body></html> 1375 </body></html>

Mercurial Repository: eric

eric ide

mercurial