src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.__init__.html

branch
eric7
changeset 10784
521fd465b048
parent 10479
856476537696
equal deleted inserted replaced
10783:ccf28bec1227 10784:521fd465b048
40 </table> 40 </table>
41 41
42 <h3>Functions</h3> 42 <h3>Functions</h3>
43 <table> 43 <table>
44 <tr> 44 <tr>
45 <td><a href="#determineSourceType">determineSourceType</a></td>
46 <td>Function to determine the type of a source file given its name.</td>
47 </tr>
48 <tr>
45 <td><a href="#find_module">find_module</a></td> 49 <td><a href="#find_module">find_module</a></td>
46 <td>Function to extend the Python module finding mechanism.</td> 50 <td>Function to extend the Python module finding mechanism.</td>
47 </tr> 51 </tr>
48 <tr> 52 <tr>
49 <td><a href="#getClassBrowserModule">getClassBrowserModule</a></td> 53 <td><a href="#getClassBrowserModule">getClassBrowserModule</a></td>
73 <td><a href="#unregisterClassBrowser">unregisterClassBrowser</a></td> 77 <td><a href="#unregisterClassBrowser">unregisterClassBrowser</a></td>
74 <td>Function to unregister a class browser type.</td> 78 <td>Function to unregister a class browser type.</td>
75 </tr> 79 </tr>
76 </table> 80 </table>
77 81
82 <hr />
83 <hr />
84 <a NAME="determineSourceType" ID="determineSourceType"></a>
85 <h2>determineSourceType</h2>
86 <b>determineSourceType</b>(<i>name, isPyFile=False</i>)
87 <p>
88 Function to determine the type of a source file given its name.
89 </p>
90
91 <dl>
92
93 <dt><i>name</i> (str)</dt>
94 <dd>
95 file name or module name
96 </dd>
97 <dt><i>isPyFile</i> (bool (optional))</dt>
98 <dd>
99 flag indicating a Python file (defaults to False)
100 </dd>
101 </dl>
102 <dl>
103 <dt>Return:</dt>
104 <dd>
105 source file type
106 </dd>
107 </dl>
108 <dl>
109 <dt>Return Type:</dt>
110 <dd>
111 int
112 </dd>
113 </dl>
114 <div align="right"><a href="#top">Up</a></div>
78 <hr /> 115 <hr />
79 <hr /> 116 <hr />
80 <a NAME="find_module" ID="find_module"></a> 117 <a NAME="find_module" ID="find_module"></a>
81 <h2>find_module</h2> 118 <h2>find_module</h2>
82 <b>find_module</b>(<i>name, path, isPyFile=False</i>) 119 <b>find_module</b>(<i>name, path, isPyFile=False</i>)
216 <div align="right"><a href="#top">Up</a></div> 253 <div align="right"><a href="#top">Up</a></div>
217 <hr /> 254 <hr />
218 <hr /> 255 <hr />
219 <a NAME="readmodule" ID="readmodule"></a> 256 <a NAME="readmodule" ID="readmodule"></a>
220 <h2>readmodule</h2> 257 <h2>readmodule</h2>
221 <b>readmodule</b>(<i>module, path=None, isPyFile=False</i>) 258 <b>readmodule</b>(<i>module, searchPath=None, isPyFile=False</i>)
222 <p> 259 <p>
223 Function to read a source file and return a dictionary of classes, functions, 260 Function to read a source file and return a dictionary of classes, functions,
224 modules, etc. . 261 modules, etc. .
225 </p> 262 </p>
226 <p> 263 <p>
232 269
233 <dt><i>module</i> (str)</dt> 270 <dt><i>module</i> (str)</dt>
234 <dd> 271 <dd>
235 name of the source file 272 name of the source file
236 </dd> 273 </dd>
237 <dt><i>path</i> (list of str)</dt> 274 <dt><i>searchPath</i> (list of str)</dt>
238 <dd> 275 <dd>
239 list of paths the file should be searched in 276 list of paths the file should be searched in
240 </dd> 277 </dd>
241 <dt><i>isPyFile</i> (bool)</dt> 278 <dt><i>isPyFile</i> (bool)</dt>
242 <dd> 279 <dd>

eric ide

mercurial