Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 10064
8c3207703dac
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html	Thu Dec 21 19:50:01 2023 +0100
@@ -130,25 +130,25 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of module containing this function (string)
+name of module containing this function
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the function (string)
+name of the function
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-name of file containing this function (string)
+name of file containing this function
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the first attribute assignment (integer)
+linenumber of the first attribute assignment
 </dd>
-<dt><i>isSignal</i></dt>
+<dt><i>isSignal</i> (bool)</dt>
 <dd>
-flag indicating a signal definition (boolean)
+flag indicating a signal definition
 </dd>
 </dl>
 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
@@ -160,10 +160,9 @@
 </p>
 <dl>
 
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
 linenumber of the additional attribute assignment
-            (integer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -239,26 +238,25 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of module containing this class (string)
+name of module containing this class
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the class (string)
+name of the class
 </dd>
-<dt><i>superClasses</i></dt>
+<dt><i>superClasses</i> (list of str)</dt>
 <dd>
 list of classnames this class is inherited from
-                (list of strings)
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-name of file containing this class (string)
+name of file containing this class
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition (integer)
+linenumber of the class definition
 </dd>
 </dl>
 <a NAME="Class.addAttribute" ID="Class.addAttribute"></a>
@@ -270,11 +268,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the attribute to add (string)
+name of the attribute to add
 </dd>
-<dt><i>attr</i></dt>
+<dt><i>attr</i> (Attribute)</dt>
 <dd>
 Attribute object to be added
 </dd>
@@ -288,9 +286,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-the docstring to be stored (string)
+the docstring to be stored
 </dd>
 </dl>
 <a NAME="Class.addGlobal" ID="Class.addGlobal"></a>
@@ -302,11 +300,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the global to add (string)
+name of the global to add
 </dd>
-<dt><i>attr</i></dt>
+<dt><i>attr</i> (Attribute)</dt>
 <dd>
 Attribute object to be added
 </dd>
@@ -320,11 +318,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of method to be added (string)
+name of method to be added
 </dd>
-<dt><i>function</i></dt>
+<dt><i>function</i> (Function)</dt>
 <dd>
 Function object to be added
 </dd>
@@ -338,9 +336,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the attribute (string)
+name of the attribute
 </dd>
 </dl>
 <dl>
@@ -349,6 +347,12 @@
 the named attribute or None
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Attribute
+</dd>
+</dl>
 <a NAME="Class.getMethod" ID="Class.getMethod"></a>
 <h4>Class.getMethod</h4>
 <b>getMethod</b>(<i>name</i>)
@@ -358,9 +362,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the method (string)
+name of the method
 </dd>
 </dl>
 <dl>
@@ -369,6 +373,12 @@
 the named method or None
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Function
+</dd>
+</dl>
 <a NAME="Class.setEndLine" ID="Class.setEndLine"></a>
 <h4>Class.setEndLine</h4>
 <b>setEndLine</b>(<i>endLineNo</i>)
@@ -378,9 +388,9 @@
 </p>
 <dl>
 
-<dt><i>endLineNo</i></dt>
+<dt><i>endLineNo</i> (int)</dt>
 <dd>
-number of the last line (integer)
+number of the last line
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -436,35 +446,35 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of module containing this function (string)
+name of module containing this function
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the function (string)
+name of the function
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-name of file containing this function (string)
+name of file containing this function
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the function definition (integer)
+linenumber of the function definition
 </dd>
-<dt><i>signature</i></dt>
+<dt><i>signature</i> (str)</dt>
 <dd>
-the functions call signature (string)
+the functions call signature
 </dd>
-<dt><i>pyqtSignature</i></dt>
+<dt><i>pyqtSignature</i> (str)</dt>
 <dd>
-the functions PyQt signature (string)
+the functions PyQt signature
 </dd>
-<dt><i>modifierType</i></dt>
+<dt><i>modifierType</i> (int)</dt>
 <dd>
 type of the function
 </dd>
-<dt><i>annotation</i></dt>
+<dt><i>annotation</i> (str)</dt>
 <dd>
 return annotation
 </dd>
@@ -478,9 +488,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-the docstring to be stored (string)
+the docstring to be stored
 </dd>
 </dl>
 <a NAME="Function.setEndLine" ID="Function.setEndLine"></a>
@@ -492,9 +502,9 @@
 </p>
 <dl>
 
-<dt><i>endLineNo</i></dt>
+<dt><i>endLineNo</i> (int)</dt>
 <dd>
-number of the last line (integer)
+number of the last line
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -606,15 +616,15 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of this module (string)
+name of this module
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-filename of file containing this module (string)
+filename of file containing this module
 </dd>
-<dt><i>moduleType</i></dt>
+<dt><i>moduleType</i> (int)</dt>
 <dd>
 type of this module
 </dd>
@@ -629,9 +639,9 @@
 </p>
 <dl>
 
-<dt><i>src</i></dt>
+<dt><i>src</i> (str)</dt>
 <dd>
-the source text to be scanned (string)
+the source text to be scanned
 </dd>
 </dl>
 <a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a>
@@ -643,9 +653,9 @@
 </p>
 <dl>
 
-<dt><i>objectRef</i></dt>
+<dt><i>objectRef</i> (Attribute, Class or Function)</dt>
 <dd>
-reference to the object (Attribute, Class or Function)
+reference to the object
 </dd>
 </dl>
 <a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a>
@@ -672,11 +682,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of class to be added (string)
+name of class to be added
 </dd>
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (Class)</dt>
 <dd>
 Class object to be added
 </dd>
@@ -690,9 +700,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-the docstring to be stored (string)
+the docstring to be stored
 </dd>
 </dl>
 <a NAME="Module.addFunction" ID="Module.addFunction"></a>
@@ -704,11 +714,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of function to be added (string)
+name of function to be added
 </dd>
-<dt><i>function</i></dt>
+<dt><i>function</i> (Function)</dt>
 <dd>
 Function object to be added
 </dd>
@@ -722,11 +732,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the global to add (string)
+name of the global to add
 </dd>
-<dt><i>attr</i></dt>
+<dt><i>attr</i> (Attribute)</dt>
 <dd>
 Attribute object to be added
 </dd>
@@ -740,11 +750,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of module to be added (string)
+name of module to be added
 </dd>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
 <dd>
 Module object to be added
 </dd>
@@ -758,15 +768,15 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (list of str)</dt>
 <dd>
 the exhausted path of classes
 </dd>
-<dt><i>result</i></dt>
+<dt><i>result</i> (dict)</dt>
 <dd>
 the result dictionary
 </dd>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (function)</dt>
 <dd>
 function to call for classe that are already part of the
             result dictionary
@@ -789,19 +799,19 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of class to assemble hierarchy (string)
+name of class to assemble hierarchy
 </dd>
-<dt><i>classes</i></dt>
+<dt><i>classes</i> (dict)</dt>
 <dd>
 A dictionary of classes to look in.
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (list of str)</dt>
 <dd>
-
+path of classes
 </dd>
-<dt><i>result</i></dt>
+<dt><i>result</i> (dict)</dt>
 <dd>
 The resultant hierarchy
 </dd>
@@ -854,6 +864,12 @@
 A dictionary with inheritance hierarchies.
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="Module.getFileName" ID="Module.getFileName"></a>
 <h4>Module.getFileName</h4>
 <b>getFileName</b>(<i></i>)
@@ -864,7 +880,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-module filename (string)
+module filename
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Module.getName" ID="Module.getName"></a>
@@ -877,7 +899,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-module name (string)
+module name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Module.getType" ID="Module.getType"></a>
@@ -890,7 +918,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-type of the modules's source (string)
+type of the modules's source
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="Module.scan" ID="Module.scan"></a>
@@ -903,9 +937,9 @@
 </p>
 <dl>
 
-<dt><i>src</i></dt>
+<dt><i>src</i> (str)</dt>
 <dd>
-the source text to be scanned (string)
+the source text to be scanned
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -957,21 +991,21 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of module containing this class (string)
+name of module containing this class
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the class (string)
+name of the class
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-name of file containing this class (string)
+name of file containing this class
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition (integer)
+linenumber of the class definition
 </dd>
 </dl>
 <a NAME="RbModule.addClass" ID="RbModule.addClass"></a>
@@ -983,11 +1017,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of class to be added (string)
+name of class to be added
 </dd>
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (Class)</dt>
 <dd>
 Class object to be added
 </dd>
@@ -1058,7 +1092,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating Private visibility (boolean)
+flag indicating Private visibility
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a>
@@ -1071,7 +1111,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating Protected visibility (boolean)
+flag indicating Protected visibility
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a>
@@ -1084,7 +1130,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating Public visibility (boolean)
+flag indicating Public visibility
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a>
@@ -1120,15 +1172,21 @@
 </p>
 <dl>
 
-<dt><i>ws</i></dt>
+<dt><i>ws</i> (str)</dt>
 <dd>
-The whitespace string to be cheked. (string)
+The whitespace string to be cheked.
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-Length of the whitespace string after tab expansion.
+length of the whitespace string after tab expansion
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -1149,18 +1207,18 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-filename or modulename to search for (string)
+filename or modulename to search for
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (list of str)</dt>
 <dd>
-search path (list of strings)
+search path
 </dd>
-<dt><i>extensions</i></dt>
+<dt><i>extensions</i> (list of str)</dt>
 <dd>
 list of extensions, which should be considered valid
-        source file extensions (list of strings)
+        source file extensions
 </dd>
 </dl>
 <dl>
@@ -1171,6 +1229,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+tuple
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>ImportError</b>:</dt>
 <dd>
@@ -1189,15 +1253,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-module type name (string)
+module type name
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-module type or -1 for failure (integer)
+module type or -1 for failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -1217,45 +1287,50 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module to be parsed (string)
+name of the module to be parsed
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (list of str)</dt>
 <dd>
-search path for the module (list of strings)
+search path for the module
 </dd>
-<dt><i>inpackage</i></dt>
+<dt><i>inpackage</i> (bool)</dt>
 <dd>
 flag indicating that module is inside a
-        package (boolean)
+        package
 </dd>
-<dt><i>basename</i></dt>
+<dt><i>basename</i> (str)</dt>
 <dd>
 a path basename that is deleted from the filename of
-        the module file to be read (string)
+        the module file to be read
 </dd>
-<dt><i>extensions</i></dt>
+<dt><i>extensions</i> (list of str)</dt>
 <dd>
 list of extensions, which should be considered valid
-        source file extensions (list of strings)
+        source file extensions
 </dd>
-<dt><i>caching</i></dt>
+<dt><i>caching</i> (bool)</dt>
 <dd>
 flag indicating that the parsed module should be
-        cached (boolean)
+        cached
 </dd>
-<dt><i>ignoreBuiltinModules</i></dt>
+<dt><i>ignoreBuiltinModules</i> (bool)</dt>
 <dd>
 flag indicating to ignore the builtin modules
-        (boolean)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 reference to a Module object containing the parsed
-        module information (Module)
+        module information
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Module
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -1270,14 +1345,14 @@
 </p>
 <dl>
 
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-Name of the module to be parsed (string)
+Name of the module to be parsed
 </dd>
-<dt><i>basename</i></dt>
+<dt><i>basename</i> (str)</dt>
 <dd>
 a path basename. This basename is deleted from
-        the filename of the module file to be cleared. (string)
+        the filename of the module file to be cleared.
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial