Documentation/Source/eric6.Utilities.ClassBrowsers.pyclbr.html

changeset 4183
856ba07de877
parent 3967
383a043d62ec
child 5606
da305d172769
equal deleted inserted replaced
4182:a84cadf71513 4183:856ba07de877
42 <td>Class to represent a Python class.</td> 42 <td>Class to represent a Python class.</td>
43 </tr><tr> 43 </tr><tr>
44 <td><a href="#Function">Function</a></td> 44 <td><a href="#Function">Function</a></td>
45 <td>Class to represent a Python function.</td> 45 <td>Class to represent a Python function.</td>
46 </tr><tr> 46 </tr><tr>
47 <td><a href="#ImportedModule">ImportedModule</a></td>
48 <td>Class to represent an imported module.</td>
49 </tr><tr>
50 <td><a href="#Imports">Imports</a></td>
51 <td>Class to represent the list of imported modules.</td>
52 </tr><tr>
47 <td><a href="#Publics">Publics</a></td> 53 <td><a href="#Publics">Publics</a></td>
48 <td>Class to represent the list of public identifiers.</td> 54 <td>Class to represent the list of public identifiers.</td>
49 </tr><tr> 55 </tr><tr>
50 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> 56 <td><a href="#VisibilityMixin">VisibilityMixin</a></td>
51 <td>Mixin class implementing the notion of visibility.</td> 57 <td>Mixin class implementing the notion of visibility.</td>
215 <dd> 221 <dd>
216 type of the function 222 type of the function
217 </dd><dt><i>annotation</i></dt> 223 </dd><dt><i>annotation</i></dt>
218 <dd> 224 <dd>
219 return annotation 225 return annotation
226 </dd>
227 </dl>
228 <div align="right"><a href="#top">Up</a></div>
229 <hr /><hr />
230 <a NAME="ImportedModule" ID="ImportedModule"></a>
231 <h2>ImportedModule</h2>
232 <p>
233 Class to represent an imported module.
234 </p>
235 <h3>Derived from</h3>
236 object
237 <h3>Class Attributes</h3>
238 <table>
239 <tr><td>None</td></tr>
240 </table>
241 <h3>Class Methods</h3>
242 <table>
243 <tr><td>None</td></tr>
244 </table>
245 <h3>Methods</h3>
246 <table>
247 <tr>
248 <td><a href="#ImportedModule.__init__">ImportedModule</a></td>
249 <td>Constructor</td>
250 </tr><tr>
251 <td><a href="#ImportedModule.addImport">addImport</a></td>
252 <td>Public method to add a list of imported names.</td>
253 </tr>
254 </table>
255 <h3>Static Methods</h3>
256 <table>
257 <tr><td>None</td></tr>
258 </table>
259 <a NAME="ImportedModule.__init__" ID="ImportedModule.__init__"></a>
260 <h4>ImportedModule (Constructor)</h4>
261 <b>ImportedModule</b>(<i>module, file, importedModule</i>)
262 <p>
263 Constructor
264 </p><dl>
265 <dt><i>module</i></dt>
266 <dd>
267 name of the module containing the import (string)
268 </dd><dt><i>file</i></dt>
269 <dd>
270 file name containing the import (string)
271 </dd><dt><i>importedModule</i></dt>
272 <dd>
273 name of the imported module (string)
274 </dd>
275 </dl><a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a>
276 <h4>ImportedModule.addImport</h4>
277 <b>addImport</b>(<i>lineno, importedNames</i>)
278 <p>
279 Public method to add a list of imported names.
280 </p><dl>
281 <dt><i>lineno</i></dt>
282 <dd>
283 line number of the import
284 </dd><dt><i>importedNames</i></dt>
285 <dd>
286 list of imported names (list of strings)
287 </dd>
288 </dl>
289 <div align="right"><a href="#top">Up</a></div>
290 <hr /><hr />
291 <a NAME="Imports" ID="Imports"></a>
292 <h2>Imports</h2>
293 <p>
294 Class to represent the list of imported modules.
295 </p>
296 <h3>Derived from</h3>
297 object
298 <h3>Class Attributes</h3>
299 <table>
300 <tr><td>None</td></tr>
301 </table>
302 <h3>Class Methods</h3>
303 <table>
304 <tr><td>None</td></tr>
305 </table>
306 <h3>Methods</h3>
307 <table>
308 <tr>
309 <td><a href="#Imports.__init__">Imports</a></td>
310 <td>Constructor</td>
311 </tr><tr>
312 <td><a href="#Imports.addImport">addImport</a></td>
313 <td>Public method to add a list of imported names.</td>
314 </tr><tr>
315 <td><a href="#Imports.getImport">getImport</a></td>
316 <td>Public method to get an imported module item.</td>
317 </tr><tr>
318 <td><a href="#Imports.getImports">getImports</a></td>
319 <td>Public method to get all imported module names.</td>
320 </tr>
321 </table>
322 <h3>Static Methods</h3>
323 <table>
324 <tr><td>None</td></tr>
325 </table>
326 <a NAME="Imports.__init__" ID="Imports.__init__"></a>
327 <h4>Imports (Constructor)</h4>
328 <b>Imports</b>(<i>module, file</i>)
329 <p>
330 Constructor
331 </p><dl>
332 <dt><i>module</i></dt>
333 <dd>
334 name of the module containing the import (string)
335 </dd><dt><i>file</i></dt>
336 <dd>
337 file name containing the import (string)
338 </dd>
339 </dl><a NAME="Imports.addImport" ID="Imports.addImport"></a>
340 <h4>Imports.addImport</h4>
341 <b>addImport</b>(<i>moduleName, names, lineno</i>)
342 <p>
343 Public method to add a list of imported names.
344 </p><dl>
345 <dt><i>moduleName</i></dt>
346 <dd>
347 name of the imported module (string)
348 </dd><dt><i>names</i></dt>
349 <dd>
350 list of names (list of strings)
351 </dd><dt><i>lineno</i></dt>
352 <dd>
353 line number of the import
354 </dd>
355 </dl><a NAME="Imports.getImport" ID="Imports.getImport"></a>
356 <h4>Imports.getImport</h4>
357 <b>getImport</b>(<i>moduleName</i>)
358 <p>
359 Public method to get an imported module item.
360 </p><dl>
361 <dt><i>moduleName</i></dt>
362 <dd>
363 name of the imported module (string)
364 </dd>
365 </dl><dl>
366 <dt>Returns:</dt>
367 <dd>
368 imported module item (ImportedModule) or None
369 </dd>
370 </dl><a NAME="Imports.getImports" ID="Imports.getImports"></a>
371 <h4>Imports.getImports</h4>
372 <b>getImports</b>(<i></i>)
373 <p>
374 Public method to get all imported module names.
375 </p><dl>
376 <dt>Returns:</dt>
377 <dd>
378 dictionary of imported module names with name as key and list
379 of line numbers of imports as value
220 </dd> 380 </dd>
221 </dl> 381 </dl>
222 <div align="right"><a href="#top">Up</a></div> 382 <div align="right"><a href="#top">Up</a></div>
223 <hr /><hr /> 383 <hr /><hr />
224 <a NAME="Publics" ID="Publics"></a> 384 <a NAME="Publics" ID="Publics"></a>

eric ide

mercurial