Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html
Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html
- changeset 5977
- 8a0ec75b0f73
- parent 5651
- 982465f8389c
equal
deleted
inserted
replaced
| 5976:549918576245 | 5977:8a0ec75b0f73 |
|---|---|
| 26 Currently it offers class browser support for the following | 26 Currently it offers class browser support for the following |
| 27 programming languages. | 27 programming languages. |
| 28 </p><p> | 28 </p><p> |
| 29 <ul> | 29 <ul> |
| 30 <li>CORBA IDL</li> | 30 <li>CORBA IDL</li> |
| 31 <li>Python</li> | 31 <li>JavaScript</li> |
| 32 <li>ProtoBuf</li> | |
| 33 <li>Python 2</li> | |
| 34 <li>Python 3</li> | |
| 32 <li>Ruby</li> | 35 <li>Ruby</li> |
| 33 </ul> | 36 </ul> |
| 34 </p> | 37 </p> |
| 35 <h3>Global Attributes</h3> | 38 <h3>Global Attributes</h3> |
| 36 <table> | 39 <table> |
| 37 <tr><td>IDL_SOURCE</td></tr><tr><td>JS_SOURCE</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>__extensions</td></tr> | 40 <tr><td>IDL_SOURCE</td></tr><tr><td>JS_SOURCE</td></tr><tr><td>PROTO_SOURCE</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>__extensions</td></tr> |
| 38 </table> | 41 </table> |
| 39 <h3>Classes</h3> | 42 <h3>Classes</h3> |
| 40 <table> | 43 <table> |
| 41 <tr><td>None</td></tr> | 44 <tr><td>None</td></tr> |
| 42 </table> | 45 </table> |
| 55 <h2>find_module</h2> | 58 <h2>find_module</h2> |
| 56 <b>find_module</b>(<i>name, path, isPyFile=False</i>) | 59 <b>find_module</b>(<i>name, path, isPyFile=False</i>) |
| 57 <p> | 60 <p> |
| 58 Module function to extend the Python module finding mechanism. | 61 Module function to extend the Python module finding mechanism. |
| 59 </p><p> | 62 </p><p> |
| 60 This function searches for files in the given path. If the filename | 63 This function searches for files in the given list of paths. If the |
| 61 doesn't have an extension or an extension of .py, the normal search | 64 file name doesn't have an extension or an extension of .py, the normal |
| 62 implemented in the imp module is used. For all other supported files | 65 Python search implemented in the imp module is used. For all other |
| 63 only path is searched. | 66 supported files only the paths list is searched. |
| 64 </p><dl> | 67 </p><dl> |
| 65 <dt><i>name</i></dt> | 68 <dt><i>name</i> (str)</dt> |
| 66 <dd> | 69 <dd> |
| 67 filename or modulename to search for (string) | 70 file name or module name to search for |
| 68 </dd><dt><i>path</i></dt> | 71 </dd><dt><i>path</i> (list of str)</dt> |
| 69 <dd> | 72 <dd> |
| 70 search path (list of strings) | 73 search paths |
| 71 </dd><dt><i>isPyFile</i></dt> | 74 </dd><dt><i>isPyFile</i> (bool)</dt> |
| 72 <dd> | 75 <dd> |
| 73 flag indicating a Python file (boolean) | 76 flag indicating a Python file |
| 74 </dd> | 77 </dd> |
| 75 </dl><dl> | 78 </dl><dl> |
| 76 <dt>Returns:</dt> | 79 <dt>Returns:</dt> |
| 77 <dd> | 80 <dd> |
| 78 tuple of the open file, pathname and description. Description | 81 tuple of the open file, pathname and description. Description |
| 79 is a tuple of file suffix, file mode and file type) | 82 is a tuple of file suffix, file mode and file type) |
| 83 </dd> | |
| 84 </dl><dl> | |
| 85 <dt>Return Type:</dt> | |
| 86 <dd> | |
| 87 tuple | |
| 80 </dd> | 88 </dd> |
| 81 </dl><dl> | 89 </dl><dl> |
| 82 <dt>Raises <b>ImportError</b>:</dt> | 90 <dt>Raises <b>ImportError</b>:</dt> |
| 83 <dd> | 91 <dd> |
| 84 The file or module wasn't found. | 92 The file or module wasn't found. |
| 94 etc. . | 102 etc. . |
| 95 </p><p> | 103 </p><p> |
| 96 The real work of parsing the source file is delegated to the individual | 104 The real work of parsing the source file is delegated to the individual |
| 97 file parsers. | 105 file parsers. |
| 98 </p><dl> | 106 </p><dl> |
| 99 <dt><i>module</i></dt> | 107 <dt><i>module</i> (str)</dt> |
| 100 <dd> | 108 <dd> |
| 101 name of the source file (string) | 109 name of the source file |
| 102 </dd><dt><i>path</i></dt> | 110 </dd><dt><i>path</i> (list of str)</dt> |
| 103 <dd> | 111 <dd> |
| 104 path the file should be searched in (list of strings) | 112 list of paths the file should be searched in |
| 105 </dd><dt><i>isPyFile</i></dt> | 113 </dd><dt><i>isPyFile</i> (bool)</dt> |
| 106 <dd> | 114 <dd> |
| 107 flag indicating a Python file (boolean) | 115 flag indicating a Python file |
| 108 </dd> | 116 </dd> |
| 109 </dl><dl> | 117 </dl><dl> |
| 110 <dt>Returns:</dt> | 118 <dt>Returns:</dt> |
| 111 <dd> | 119 <dd> |
| 112 the resulting dictionary | 120 the resulting dictionary |
| 113 </dd> | 121 </dd> |
| 122 </dl><dl> | |
| 123 <dt>Return Type:</dt> | |
| 124 <dd> | |
| 125 dict | |
| 126 </dd> | |
| 114 </dl> | 127 </dl> |
| 115 <div align="right"><a href="#top">Up</a></div> | 128 <div align="right"><a href="#top">Up</a></div> |
| 116 <hr /> | 129 <hr /> |
| 117 </body></html> | 130 </body></html> |
