diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html
--- a/src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Utilities.ModuleParser</h1>
-
<p>
Parse a Python module file.
</p>
@@ -19,15 +18,25 @@
for the file.</li>
</ul>
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<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>
+<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>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Attribute">Attribute</a></td>
<td>Class to represent a Python function or method.</td>
@@ -53,10 +62,9 @@
<td>Class implementing the visibility aspect of all objects.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#_indent">_indent</a></td>
<td>Protected function to determine the indent width of a whitespace string.</td>
@@ -82,30 +90,29 @@
<td>Module function to reset the list of modules already parsed.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="Attribute" ID="Attribute"></a>
<h2>Attribute</h2>
-
<p>
Class to represent a Python function or method.
</p>
+
<h3>Derived from</h3>
VisibilityBase
<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>
@@ -115,19 +122,20 @@
<td>Public method to add another assignment line number.</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, isSignal=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -154,10 +162,10 @@
<a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
<h4>Attribute.addAssignment</h4>
<b>addAssignment</b>(<i>lineno</i>)
-
<p>
Public method to add another assignment line number.
</p>
+
<dl>
<dt><i>lineno</i> (int)</dt>
@@ -170,26 +178,24 @@
<hr />
<a NAME="Class" ID="Class"></a>
<h2>Class</h2>
-
<p>
Class to represent a Python class.
</p>
+
<h3>Derived from</h3>
VisibilityBase
<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>
@@ -223,19 +229,20 @@
<td>Public method to record the number of the last line of a class.</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>
@@ -262,10 +269,10 @@
<a NAME="Class.addAttribute" ID="Class.addAttribute"></a>
<h4>Class.addAttribute</h4>
<b>addAttribute</b>(<i>name, attr</i>)
-
<p>
Public method to add information about attributes.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -280,10 +287,10 @@
<a NAME="Class.addDescription" ID="Class.addDescription"></a>
<h4>Class.addDescription</h4>
<b>addDescription</b>(<i>description</i>)
-
<p>
Public method to store the class docstring.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -294,10 +301,10 @@
<a NAME="Class.addGlobal" ID="Class.addGlobal"></a>
<h4>Class.addGlobal</h4>
<b>addGlobal</b>(<i>name, attr</i>)
-
<p>
Public method to add information about global (class) variables.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -312,10 +319,10 @@
<a NAME="Class.addMethod" ID="Class.addMethod"></a>
<h4>Class.addMethod</h4>
<b>addMethod</b>(<i>name, function</i>)
-
<p>
Public method to add information about a method.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -330,10 +337,10 @@
<a NAME="Class.getAttribute" ID="Class.getAttribute"></a>
<h4>Class.getAttribute</h4>
<b>getAttribute</b>(<i>name</i>)
-
<p>
Public method to retrieve an attribute by name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -356,10 +363,10 @@
<a NAME="Class.getMethod" ID="Class.getMethod"></a>
<h4>Class.getMethod</h4>
<b>getMethod</b>(<i>name</i>)
-
<p>
Public method to retrieve a method by name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -382,10 +389,10 @@
<a NAME="Class.setEndLine" ID="Class.setEndLine"></a>
<h4>Class.setEndLine</h4>
<b>setEndLine</b>(<i>endLineNo</i>)
-
<p>
Public method to record the number of the last line of a class.
</p>
+
<dl>
<dt><i>endLineNo</i> (int)</dt>
@@ -398,26 +405,26 @@
<hr />
<a NAME="Function" ID="Function"></a>
<h2>Function</h2>
-
<p>
Class to represent a Python function or method.
</p>
+
<h3>Derived from</h3>
VisibilityBase
<h3>Class Attributes</h3>
+<table>
+<tr><td>Class</td></tr>
+<tr><td>General</td></tr>
+<tr><td>Static</td></tr>
+</table>
-<table>
-<tr><td>Class</td></tr><tr><td>General</td></tr><tr><td>Static</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>
@@ -431,19 +438,20 @@
<td>Public method to record the number of the last line of a class.</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="", pyqtSignature=None, modifierType=General, annotation="", </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -482,10 +490,10 @@
<a NAME="Function.addDescription" ID="Function.addDescription"></a>
<h4>Function.addDescription</h4>
<b>addDescription</b>(<i>description</i>)
-
<p>
Public method to store the functions docstring.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -496,10 +504,10 @@
<a NAME="Function.setEndLine" ID="Function.setEndLine"></a>
<h4>Function.setEndLine</h4>
<b>setEndLine</b>(<i>endLineNo</i>)
-
<p>
Public method to record the number of the last line of a class.
</p>
+
<dl>
<dt><i>endLineNo</i> (int)</dt>
@@ -512,26 +520,24 @@
<hr />
<a NAME="Module" ID="Module"></a>
<h2>Module</h2>
-
<p>
Class to represent a Python 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="#Module.__init__">Module</a></td>
<td>Constructor</td>
@@ -601,19 +607,20 @@
<td>Public method to scan the source text and retrieve the relevant information.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Module.__init__" ID="Module.__init__"></a>
<h4>Module (Constructor)</h4>
<b>Module</b>(<i>name, file=None, moduleType=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -632,11 +639,11 @@
<a NAME="Module.__py_scan" ID="Module.__py_scan"></a>
<h4>Module.__py_scan</h4>
<b>__py_scan</b>(<i>src</i>)
-
<p>
Private method to scan the source text of a Python module and retrieve
the relevant information.
</p>
+
<dl>
<dt><i>src</i> (str)</dt>
@@ -647,10 +654,10 @@
<a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a>
<h4>Module.__py_setVisibility</h4>
<b>__py_setVisibility</b>(<i>objectRef</i>)
-
<p>
Private method to set the visibility of an object.
</p>
+
<dl>
<dt><i>objectRef</i> (Attribute, Class or Function)</dt>
@@ -661,11 +668,11 @@
<a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a>
<h4>Module.__rb_scan</h4>
<b>__rb_scan</b>(<i>src</i>)
-
<p>
Private method to scan the source text of a Python module and retrieve
the relevant information.
</p>
+
<dl>
<dt><i>src</i> (str)</dt>
@@ -676,10 +683,10 @@
<a NAME="Module.addClass" ID="Module.addClass"></a>
<h4>Module.addClass</h4>
<b>addClass</b>(<i>name, _class</i>)
-
<p>
Public method to add information about a class.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -694,10 +701,10 @@
<a NAME="Module.addDescription" ID="Module.addDescription"></a>
<h4>Module.addDescription</h4>
<b>addDescription</b>(<i>description</i>)
-
<p>
Public method to store the modules docstring.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -708,10 +715,10 @@
<a NAME="Module.addFunction" ID="Module.addFunction"></a>
<h4>Module.addFunction</h4>
<b>addFunction</b>(<i>name, function</i>)
-
<p>
Public method to add information about a function.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -726,10 +733,10 @@
<a NAME="Module.addGlobal" ID="Module.addGlobal"></a>
<h4>Module.addGlobal</h4>
<b>addGlobal</b>(<i>name, attr</i>)
-
<p>
Public method to add information about global variables.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -744,10 +751,10 @@
<a NAME="Module.addModule" ID="Module.addModule"></a>
<h4>Module.addModule</h4>
<b>addModule</b>(<i>name, module</i>)
-
<p>
Public method to add information about a Ruby module.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -762,10 +769,10 @@
<a NAME="Module.addPathToHierarchy" ID="Module.addPathToHierarchy"></a>
<h4>Module.addPathToHierarchy</h4>
<b>addPathToHierarchy</b>(<i>path, result, fn</i>)
-
<p>
Public method to put the exhausted path into the result dictionary.
</p>
+
<dl>
<dt><i>path</i> (list of str)</dt>
@@ -785,7 +792,6 @@
<a NAME="Module.assembleHierarchy" ID="Module.assembleHierarchy"></a>
<h4>Module.assembleHierarchy</h4>
<b>assembleHierarchy</b>(<i>name, classes, path, result</i>)
-
<p>
Public method to assemble the inheritance hierarchy.
</p>
@@ -797,6 +803,7 @@
<p>
This code is borrowed from Boa Constructor.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -819,10 +826,10 @@
<a NAME="Module.calculateEndline" ID="Module.calculateEndline"></a>
<h4>Module.calculateEndline</h4>
<b>calculateEndline</b>(<i>lines, indent</i>)
-
<p>
Function to calculate the end line of a class or method/function.
</p>
+
<dl>
<dt><i>lineno</i> (int)</dt>
@@ -853,11 +860,11 @@
<a NAME="Module.createHierarchy" ID="Module.createHierarchy"></a>
<h4>Module.createHierarchy</h4>
<b>createHierarchy</b>(<i></i>)
-
<p>
Public method to build the inheritance hierarchy for all classes of
this module.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -873,10 +880,10 @@
<a NAME="Module.getFileName" ID="Module.getFileName"></a>
<h4>Module.getFileName</h4>
<b>getFileName</b>(<i></i>)
-
<p>
Public method to retrieve the modules filename.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -892,10 +899,10 @@
<a NAME="Module.getName" ID="Module.getName"></a>
<h4>Module.getName</h4>
<b>getName</b>(<i></i>)
-
<p>
Public method to retrieve the modules name.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -911,10 +918,10 @@
<a NAME="Module.getType" ID="Module.getType"></a>
<h4>Module.getType</h4>
<b>getType</b>(<i></i>)
-
<p>
Public method to get the type of the module's source.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -930,11 +937,11 @@
<a NAME="Module.scan" ID="Module.scan"></a>
<h4>Module.scan</h4>
<b>scan</b>(<i>src</i>)
-
<p>
Public method to scan the source text and retrieve the relevant
information.
</p>
+
<dl>
<dt><i>src</i> (str)</dt>
@@ -947,26 +954,24 @@
<hr />
<a NAME="RbModule" ID="RbModule"></a>
<h2>RbModule</h2>
-
<p>
Class to represent a Ruby module.
</p>
+
<h3>Derived from</h3>
Class
<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="#RbModule.__init__">RbModule</a></td>
<td>Constructor</td>
@@ -976,19 +981,20 @@
<td>Public method to add information about a class.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RbModule.__init__" ID="RbModule.__init__"></a>
<h4>RbModule (Constructor)</h4>
<b>RbModule</b>(<i>module, name, file, lineno</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -1011,10 +1017,10 @@
<a NAME="RbModule.addClass" ID="RbModule.addClass"></a>
<h4>RbModule.addClass</h4>
<b>addClass</b>(<i>name, _class</i>)
-
<p>
Public method to add information about a class.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1031,26 +1037,24 @@
<hr />
<a NAME="VisibilityBase" ID="VisibilityBase"></a>
<h2>VisibilityBase</h2>
-
<p>
Class implementing the visibility aspect of all objects.
</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="#VisibilityBase.isPrivate">isPrivate</a></td>
<td>Public method to check, if the visibility is Private.</td>
@@ -1076,19 +1080,20 @@
<td>Public method to set the visibility to Public.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VisibilityBase.isPrivate" ID="VisibilityBase.isPrivate"></a>
<h4>VisibilityBase.isPrivate</h4>
<b>isPrivate</b>(<i></i>)
-
<p>
Public method to check, if the visibility is Private.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1104,10 +1109,10 @@
<a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a>
<h4>VisibilityBase.isProtected</h4>
<b>isProtected</b>(<i></i>)
-
<p>
Public method to check, if the visibility is Protected.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1123,10 +1128,10 @@
<a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a>
<h4>VisibilityBase.isPublic</h4>
<b>isPublic</b>(<i></i>)
-
<p>
Public method to check, if the visibility is Public.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1142,34 +1147,34 @@
<a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a>
<h4>VisibilityBase.setPrivate</h4>
<b>setPrivate</b>(<i></i>)
-
<p>
Public method to set the visibility to Private.
</p>
+
<a NAME="VisibilityBase.setProtected" ID="VisibilityBase.setProtected"></a>
<h4>VisibilityBase.setProtected</h4>
<b>setProtected</b>(<i></i>)
-
<p>
Public method to set the visibility to Protected.
</p>
+
<a NAME="VisibilityBase.setPublic" ID="VisibilityBase.setPublic"></a>
<h4>VisibilityBase.setPublic</h4>
<b>setPublic</b>(<i></i>)
-
<p>
Public method to set the visibility to Public.
</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>
Protected function to determine the indent width of a whitespace string.
</p>
+
<dl>
<dt><i>ws</i> (str)</dt>
@@ -1195,7 +1200,6 @@
<a NAME="find_module" ID="find_module"></a>
<h2>find_module</h2>
<b>find_module</b>(<i>name, path, extensions</i>)
-
<p>
Module function to extend the Python module finding mechanism.
</p>
@@ -1205,6 +1209,7 @@
implemented in the imp module is used. For all other supported files
only path is searched.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1247,10 +1252,10 @@
<a NAME="getTypeFromTypeName" ID="getTypeFromTypeName"></a>
<h2>getTypeFromTypeName</h2>
<b>getTypeFromTypeName</b>(<i>name</i>)
-
<p>
Module function to determine the module type given the module type name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1276,7 +1281,6 @@
<a NAME="readModule" ID="readModule"></a>
<h2>readModule</h2>
<b>readModule</b>(<i>module, path=None, inpackage=False, basename="", extensions=None, caching=True, ignoreBuiltinModules=False, </i>)
-
<p>
Function to read a module file and parse it.
</p>
@@ -1285,6 +1289,7 @@
If the module was parsed before, the information is taken
from a cache in order to speed up processing.
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -1339,10 +1344,10 @@
<a NAME="resetParsedModule" ID="resetParsedModule"></a>
<h2>resetParsedModule</h2>
<b>resetParsedModule</b>(<i>module, basename=""</i>)
-
<p>
Module function to clear one module from the list of parsed modules.
</p>
+
<dl>
<dt><i>module</i> (str)</dt>
@@ -1361,10 +1366,10 @@
<a NAME="resetParsedModules" ID="resetParsedModules"></a>
<h2>resetParsedModules</h2>
<b>resetParsedModules</b>(<i></i>)
-
<p>
Module function to reset the list of modules already parsed.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
