Mercurial Repositories > eric / file revision
Documentation/Source/eric5.Utilities.ClassBrowsers.pyclbr.html@edde1fe80b3e
Documentation/Source/eric5.Utilities.ClassBrowsers.pyclbr.html
Sat, 02 Jan 2010 18:19:35 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 02 Jan 2010 18:19:35 +0000
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
- permissions
- -rw-r--r--
Updated documentation.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.Utilities.ClassBrowsers.pyclbr</title> <style> b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Utilities.ClassBrowsers.pyclbr</h1> <p> Parse a Python file and retrieve classes, functions/methods and attributes. </p><p> Parse enough of a Python file to recognize class and method definitions and to find out the superclasses of a class as well as its attributes. </p><p> This is module is based on pyclbr found in the Python 2.2.2 distribution. </p> <h3>Global Attributes</h3> <table> <tr><td>SUPPORTED_TYPES</td></tr><tr><td>TABWIDTH</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr><tr><td>_modules</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#Attribute">Attribute</a></td> <td>Class to represent a class attribute.</td> </tr><tr> <td><a href="#Class">Class</a></td> <td>Class to represent a Python class.</td> </tr><tr> <td><a href="#Function">Function</a></td> <td>Class to represent a Python function.</td> </tr><tr> <td><a href="#Publics">Publics</a></td> <td>Class to represent the list of public identifiers.</td> </tr><tr> <td><a href="#VisibilityMixin">VisibilityMixin</a></td> <td>Mixin class implementing the notion of visibility.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#_indent">_indent</a></td> <td>Module function to return the indentation depth.</td> </tr><tr> <td><a href="#readmodule_ex">readmodule_ex</a></td> <td>Read a module file and return a dictionary of classes.</td> </tr> </table> <hr /><hr /> <a NAME="Attribute" ID="Attribute"></a> <h2>Attribute</h2> <p> Class to represent a class attribute. </p> <h3>Derived from</h3> ClbrBaseClasses.Attribute, VisibilityMixin <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Attribute.__init__">Attribute</a></td> <td>Constructor</td> </tr> </table> <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> <h4>Attribute (Constructor)</h4> <b>Attribute</b>(<i>module, name, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>file</i></dt> <dd> filename containing this attribute </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Class" ID="Class"></a> <h2>Class</h2> <p> Class to represent a Python class. </p> <h3>Derived from</h3> ClbrBaseClasses.Class, VisibilityMixin <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Class.__init__">Class</a></td> <td>Constructor</td> </tr> </table> <a NAME="Class.__init__" ID="Class.__init__"></a> <h4>Class (Constructor)</h4> <b>Class</b>(<i>module, name, super, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>super</i></dt> <dd> list of class names this class is inherited from </dd><dt><i>file</i></dt> <dd> filename containing this class </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Function" ID="Function"></a> <h2>Function</h2> <p> Class to represent a Python function. </p> <h3>Derived from</h3> ClbrBaseClasses.Function, VisibilityMixin <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Function.__init__">Function</a></td> <td>Constructor</td> </tr> </table> <a NAME="Function.__init__" ID="Function.__init__"></a> <h4>Function (Constructor)</h4> <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this function </dd><dt><i>name</i></dt> <dd> name of this function </dd><dt><i>file</i></dt> <dd> filename containing this class </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd><dt><i>signature</i></dt> <dd> parameterlist of the method </dd><dt><i>separator</i></dt> <dd> string separating the parameters </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Publics" ID="Publics"></a> <h2>Publics</h2> <p> Class to represent the list of public identifiers. </p> <h3>Derived from</h3> object <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Publics.__init__">Publics</a></td> <td>Constructor</td> </tr> </table> <a NAME="Publics.__init__" ID="Publics.__init__"></a> <h4>Publics (Constructor)</h4> <b>Publics</b>(<i>module, file, lineno, idents</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this function </dd><dt><i>file</i></dt> <dd> filename containing this class </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd><dt><i>idents</i></dt> <dd> list of public identifiers </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> <h2>VisibilityMixin</h2> <p> Mixin class implementing the notion of visibility. </p> <h3>Derived from</h3> ClbrBaseClasses.ClbrVisibilityMixinBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> <td>Method to initialize the visibility.</td> </tr> </table> <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> <h4>VisibilityMixin (Constructor)</h4> <b>VisibilityMixin</b>(<i></i>) <p> Method to initialize the visibility. </p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="_indent" ID="_indent"></a> <h2>_indent</h2> <b>_indent</b>(<i>ws</i>) <p> Module function to return the indentation depth. </p><dl> <dt><i>ws</i></dt> <dd> the whitespace to be checked (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> length of the whitespace string (integer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="readmodule_ex" ID="readmodule_ex"></a> <h2>readmodule_ex</h2> <b>readmodule_ex</b>(<i>module, path=[], inpackage = False, isPyFile = False</i>) <p> Read a module file and return a dictionary of classes. </p><p> Search for MODULE in PATH and sys.path, read and parse the module and return a dictionary with one entry for each class found in the module. </p><dl> <dt><i>module</i></dt> <dd> name of the module file (string) </dd><dt><i>path</i></dt> <dd> path the module should be searched in (list of strings) </dd><dt><i>inpackage</i></dt> <dd> flag indicating a module inside a package is scanned </dd> </dl><dl> <dt>Returns:</dt> <dd> the resulting dictionary </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
