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

branch
eric7
changeset 10433
328f3ec4b77a
parent 10229
e50bbf250343
child 10479
856476537696
equal deleted inserted replaced
10432:2fe91fe443dd 10433:328f3ec4b77a
116 <p> 116 <p>
117 Constructor 117 Constructor
118 </p> 118 </p>
119 <dl> 119 <dl>
120 120
121 <dt><i>module</i></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
124 </dd> 124 </dd>
125 <dt><i>name</i></dt> 125 <dt><i>name</i> (str)</dt>
126 <dd> 126 <dd>
127 name of this class 127 name of this class
128 </dd> 128 </dd>
129 <dt><i>file</i></dt> 129 <dt><i>file</i> (str)</dt>
130 <dd> 130 <dd>
131 filename containing this attribute 131 filename containing this attribute
132 </dd> 132 </dd>
133 <dt><i>lineno</i></dt> 133 <dt><i>lineno</i> (int)</dt>
134 <dd> 134 <dd>
135 linenumber of the class definition 135 linenumber of the class definition
136 </dd> 136 </dd>
137 </dl> 137 </dl>
138 <div align="right"><a href="#top">Up</a></div> 138 <div align="right"><a href="#top">Up</a></div>
178 <p> 178 <p>
179 Constructor 179 Constructor
180 </p> 180 </p>
181 <dl> 181 <dl>
182 182
183 <dt><i>module</i></dt> 183 <dt><i>module</i> (str)</dt>
184 <dd> 184 <dd>
185 name of the module containing this class 185 name of the module containing this class
186 </dd> 186 </dd>
187 <dt><i>name</i></dt> 187 <dt><i>name</i> (str)</dt>
188 <dd> 188 <dd>
189 name of this class 189 name of this class
190 </dd> 190 </dd>
191 <dt><i>superClasses</i></dt> 191 <dt><i>superClasses</i> (list of str)</dt>
192 <dd> 192 <dd>
193 list of class names this class is inherited from 193 list of class names this class is inherited from
194 </dd> 194 </dd>
195 <dt><i>file</i></dt> 195 <dt><i>file</i> (str)</dt>
196 <dd> 196 <dd>
197 filename containing this class 197 filename containing this class
198 </dd> 198 </dd>
199 <dt><i>lineno</i></dt> 199 <dt><i>lineno</i> (int)</dt>
200 <dd> 200 <dd>
201 linenumber of the class definition 201 linenumber of the class definition
202 </dd> 202 </dd>
203 </dl> 203 </dl>
204 <div align="right"><a href="#top">Up</a></div> 204 <div align="right"><a href="#top">Up</a></div>
244 <p> 244 <p>
245 Constructor 245 Constructor
246 </p> 246 </p>
247 <dl> 247 <dl>
248 248
249 <dt><i>module</i></dt> 249 <dt><i>module</i> (str)</dt>
250 <dd> 250 <dd>
251 name of the module containing this function 251 name of the module containing this function
252 </dd> 252 </dd>
253 <dt><i>name</i></dt> 253 <dt><i>name</i> (str)</dt>
254 <dd> 254 <dd>
255 name of this function 255 name of this function
256 </dd> 256 </dd>
257 <dt><i>file</i></dt> 257 <dt><i>file</i> (str)</dt>
258 <dd> 258 <dd>
259 filename containing this class 259 filename containing this class
260 </dd> 260 </dd>
261 <dt><i>lineno</i></dt> 261 <dt><i>lineno</i> (int)</dt>
262 <dd> 262 <dd>
263 linenumber of the class definition 263 linenumber of the class definition
264 </dd> 264 </dd>
265 <dt><i>signature</i></dt> 265 <dt><i>signature</i> (str)</dt>
266 <dd> 266 <dd>
267 parameterlist of the method 267 parameterlist of the method
268 </dd> 268 </dd>
269 <dt><i>separator</i></dt> 269 <dt><i>separator</i> (str)</dt>
270 <dd> 270 <dd>
271 string separating the parameters 271 string separating the parameters
272 </dd> 272 </dd>
273 <dt><i>modifierType</i></dt> 273 <dt><i>modifierType</i> (int)</dt>
274 <dd> 274 <dd>
275 type of the function 275 type of the function
276 </dd> 276 </dd>
277 <dt><i>annotation</i></dt> 277 <dt><i>annotation</i> (str)</dt>
278 <dd> 278 <dd>
279 return annotation 279 return annotation
280 </dd> 280 </dd>
281 </dl> 281 </dl>
282 <div align="right"><a href="#top">Up</a></div> 282 <div align="right"><a href="#top">Up</a></div>
326 <p> 326 <p>
327 Constructor 327 Constructor
328 </p> 328 </p>
329 <dl> 329 <dl>
330 330
331 <dt><i>module</i></dt> 331 <dt><i>module</i> (str)</dt>
332 <dd> 332 <dd>
333 name of the module containing the import (string) 333 name of the module containing the import
334 </dd> 334 </dd>
335 <dt><i>file</i></dt> 335 <dt><i>file</i> (str)</dt>
336 <dd> 336 <dd>
337 file name containing the import (string) 337 file name containing the import
338 </dd> 338 </dd>
339 <dt><i>importedModule</i></dt> 339 <dt><i>importedModule</i> (str)</dt>
340 <dd> 340 <dd>
341 name of the imported module (string) 341 name of the imported module
342 </dd> 342 </dd>
343 </dl> 343 </dl>
344 <a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a> 344 <a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a>
345 <h4>ImportedModule.addImport</h4> 345 <h4>ImportedModule.addImport</h4>
346 <b>addImport</b>(<i>lineno, importedNames</i>) 346 <b>addImport</b>(<i>lineno, importedNames</i>)
348 <p> 348 <p>
349 Public method to add a list of imported names. 349 Public method to add a list of imported names.
350 </p> 350 </p>
351 <dl> 351 <dl>
352 352
353 <dt><i>lineno</i></dt> 353 <dt><i>lineno</i> (int)</dt>
354 <dd> 354 <dd>
355 line number of the import 355 line number of the import
356 </dd> 356 </dd>
357 <dt><i>importedNames</i></dt> 357 <dt><i>importedNames</i> (list of str)</dt>
358 <dd> 358 <dd>
359 list of imported names (list of strings) 359 list of imported names
360 </dd> 360 </dd>
361 </dl> 361 </dl>
362 <div align="right"><a href="#top">Up</a></div> 362 <div align="right"><a href="#top">Up</a></div>
363 <hr /> 363 <hr />
364 <hr /> 364 <hr />
414 <p> 414 <p>
415 Constructor 415 Constructor
416 </p> 416 </p>
417 <dl> 417 <dl>
418 418
419 <dt><i>module</i></dt> 419 <dt><i>module</i> (str)</dt>
420 <dd> 420 <dd>
421 name of the module containing the import (string) 421 name of the module containing the import
422 </dd> 422 </dd>
423 <dt><i>file</i></dt> 423 <dt><i>file</i> (str)</dt>
424 <dd> 424 <dd>
425 file name containing the import (string) 425 file name containing the import
426 </dd> 426 </dd>
427 </dl> 427 </dl>
428 <a NAME="Imports.addImport" ID="Imports.addImport"></a> 428 <a NAME="Imports.addImport" ID="Imports.addImport"></a>
429 <h4>Imports.addImport</h4> 429 <h4>Imports.addImport</h4>
430 <b>addImport</b>(<i>moduleName, names, lineno</i>) 430 <b>addImport</b>(<i>moduleName, names, lineno</i>)
432 <p> 432 <p>
433 Public method to add a list of imported names. 433 Public method to add a list of imported names.
434 </p> 434 </p>
435 <dl> 435 <dl>
436 436
437 <dt><i>moduleName</i></dt> 437 <dt><i>moduleName</i> (str)</dt>
438 <dd> 438 <dd>
439 name of the imported module (string) 439 name of the imported module
440 </dd> 440 </dd>
441 <dt><i>names</i></dt> 441 <dt><i>names</i> (list of str)</dt>
442 <dd> 442 <dd>
443 list of names (list of strings) 443 list of names
444 </dd> 444 </dd>
445 <dt><i>lineno</i></dt> 445 <dt><i>lineno</i> (int)</dt>
446 <dd> 446 <dd>
447 line number of the import 447 line number of the import
448 </dd> 448 </dd>
449 </dl> 449 </dl>
450 <a NAME="Imports.getImport" ID="Imports.getImport"></a> 450 <a NAME="Imports.getImport" ID="Imports.getImport"></a>
454 <p> 454 <p>
455 Public method to get an imported module item. 455 Public method to get an imported module item.
456 </p> 456 </p>
457 <dl> 457 <dl>
458 458
459 <dt><i>moduleName</i></dt> 459 <dt><i>moduleName</i> (str)</dt>
460 <dd> 460 <dd>
461 name of the imported module (string) 461 name of the imported module
462 </dd> 462 </dd>
463 </dl> 463 </dl>
464 <dl> 464 <dl>
465 <dt>Return:</dt> 465 <dt>Return:</dt>
466 <dd> 466 <dd>
467 imported module item (ImportedModule) or None 467 imported module item
468 </dd>
469 </dl>
470 <dl>
471 <dt>Return Type:</dt>
472 <dd>
473 ImportedModule
468 </dd> 474 </dd>
469 </dl> 475 </dl>
470 <a NAME="Imports.getImports" ID="Imports.getImports"></a> 476 <a NAME="Imports.getImports" ID="Imports.getImports"></a>
471 <h4>Imports.getImports</h4> 477 <h4>Imports.getImports</h4>
472 <b>getImports</b>(<i></i>) 478 <b>getImports</b>(<i></i>)
479 <dd> 485 <dd>
480 dictionary of imported module names with name as key and list 486 dictionary of imported module names with name as key and list
481 of line numbers of imports as value 487 of line numbers of imports as value
482 </dd> 488 </dd>
483 </dl> 489 </dl>
490 <dl>
491 <dt>Return Type:</dt>
492 <dd>
493 dict
494 </dd>
495 </dl>
484 <div align="right"><a href="#top">Up</a></div> 496 <div align="right"><a href="#top">Up</a></div>
485 <hr /> 497 <hr />
486 <hr /> 498 <hr />
487 <a NAME="Publics" ID="Publics"></a> 499 <a NAME="Publics" ID="Publics"></a>
488 <h2>Publics</h2> 500 <h2>Publics</h2>
566 <p> 578 <p>
567 Module function to return the indentation depth. 579 Module function to return the indentation depth.
568 </p> 580 </p>
569 <dl> 581 <dl>
570 582
571 <dt><i>ws</i></dt> 583 <dt><i>ws</i> (str)</dt>
572 <dd> 584 <dd>
573 the whitespace to be checked (string) 585 the whitespace to be checked
574 </dd> 586 </dd>
575 </dl> 587 </dl>
576 <dl> 588 <dl>
577 <dt>Return:</dt> 589 <dt>Return:</dt>
578 <dd> 590 <dd>
579 length of the whitespace string (integer) 591 length of the whitespace string
592 </dd>
593 </dl>
594 <dl>
595 <dt>Return Type:</dt>
596 <dd>
597 int
580 </dd> 598 </dd>
581 </dl> 599 </dl>
582 <div align="right"><a href="#top">Up</a></div> 600 <div align="right"><a href="#top">Up</a></div>
583 <hr /> 601 <hr />
584 <hr /> 602 <hr />

eric ide

mercurial