--- a/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.pyclbr.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.pyclbr.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,7 +7,6 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Utilities.ClassBrowsers.pyclbr</h1> - <p> Parse a Python file and retrieve classes, functions/methods and attributes. </p> @@ -15,15 +14,17 @@ 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> + <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>SUPPORTED_TYPES</td></tr> +<tr><td>TABWIDTH</td></tr> +<tr><td>_commentsub</td></tr> +<tr><td>_getnext</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#Attribute">Attribute</a></td> <td>Class to represent a class attribute.</td> @@ -53,10 +54,9 @@ <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> @@ -74,48 +74,48 @@ <td>Public method to scan the given source text.</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>Class Methods</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> + <h3>Static Methods</h3> - <table> <tr><td>None</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> (str)</dt> @@ -140,44 +140,43 @@ <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>Class Methods</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> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="Class.__init__" ID="Class.__init__"></a> <h4>Class (Constructor)</h4> <b>Class</b>(<i>module, name, superClasses, file, lineno</i>) - <p> Constructor </p> + <dl> <dt><i>module</i> (str)</dt> @@ -206,44 +205,43 @@ <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>Class Methods</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> + <h3>Static Methods</h3> - <table> <tr><td>None</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=", ", modifierType=ClbrBaseClasses.Function.General, annotation="", </i>) - <p> Constructor </p> + <dl> <dt><i>module</i> (str)</dt> @@ -284,26 +282,24 @@ <hr /> <a NAME="ImportedModule" ID="ImportedModule"></a> <h2>ImportedModule</h2> - <p> Class to represent an imported module. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#ImportedModule.__init__">ImportedModule</a></td> <td>Constructor</td> @@ -313,19 +309,20 @@ <td>Public method to add a list of imported names.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="ImportedModule.__init__" ID="ImportedModule.__init__"></a> <h4>ImportedModule (Constructor)</h4> <b>ImportedModule</b>(<i>module, file, importedModule</i>) - <p> Constructor </p> + <dl> <dt><i>module</i> (str)</dt> @@ -344,10 +341,10 @@ <a NAME="ImportedModule.addImport" ID="ImportedModule.addImport"></a> <h4>ImportedModule.addImport</h4> <b>addImport</b>(<i>lineno, importedNames</i>) - <p> Public method to add a list of imported names. </p> + <dl> <dt><i>lineno</i> (int)</dt> @@ -364,26 +361,24 @@ <hr /> <a NAME="Imports" ID="Imports"></a> <h2>Imports</h2> - <p> Class to represent the list of imported modules. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#Imports.__init__">Imports</a></td> <td>Constructor</td> @@ -401,19 +396,20 @@ <td>Public method to get all imported module names.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="Imports.__init__" ID="Imports.__init__"></a> <h4>Imports (Constructor)</h4> <b>Imports</b>(<i>module, file</i>) - <p> Constructor </p> + <dl> <dt><i>module</i> (str)</dt> @@ -428,10 +424,10 @@ <a NAME="Imports.addImport" ID="Imports.addImport"></a> <h4>Imports.addImport</h4> <b>addImport</b>(<i>moduleName, names, lineno</i>) - <p> Public method to add a list of imported names. </p> + <dl> <dt><i>moduleName</i> (str)</dt> @@ -450,10 +446,10 @@ <a NAME="Imports.getImport" ID="Imports.getImport"></a> <h4>Imports.getImport</h4> <b>getImport</b>(<i>moduleName</i>) - <p> Public method to get an imported module item. </p> + <dl> <dt><i>moduleName</i> (str)</dt> @@ -476,10 +472,10 @@ <a NAME="Imports.getImports" ID="Imports.getImports"></a> <h4>Imports.getImports</h4> <b>getImports</b>(<i></i>) - <p> Public method to get all imported module names. </p> + <dl> <dt>Return:</dt> <dd> @@ -498,86 +494,89 @@ <hr /> <a NAME="Publics" ID="Publics"></a> <h2>Publics</h2> - <p> Class to represent the list of public identifiers. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> +<table> +<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> +</table> -<table> -<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> -</table> <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <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>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> <td>Constructor</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> <h4>VisibilityMixin (Constructor)</h4> <b>VisibilityMixin</b>(<i></i>) - <p> Constructor </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> (str)</dt> @@ -603,10 +602,10 @@ <a NAME="calculateEndline" ID="calculateEndline"></a> <h2>calculateEndline</h2> <b>calculateEndline</b>(<i>lineno, lines, indent</i>) - <p> Function to calculate the end line of a class or method/function. </p> + <dl> <dt><i>lineno</i> (int)</dt> @@ -640,7 +639,6 @@ <a NAME="readmodule_ex" ID="readmodule_ex"></a> <h2>readmodule_ex</h2> <b>readmodule_ex</b>(<i>module, path=None, isTypeFile=False</i>) - <p> Read a module file and return a dictionary of classes. </p> @@ -649,6 +647,7 @@ module and return a dictionary with one entry for each class found in the module. </p> + <dl> <dt><i>module</i> (str)</dt> @@ -682,10 +681,10 @@ <a NAME="scan" ID="scan"></a> <h2>scan</h2> <b>scan</b>(<i>src, file, module</i>) - <p> Public method to scan the given source text. </p> + <dl> <dt><i>src</i> (str)</dt> @@ -715,4 +714,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>