Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html
eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.__init__.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7641
- 21ea4fd50b0a
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Utilities.ClassBrowsers.__init__</h1> | 23 <h1>eric6.Utilities.ClassBrowsers.__init__</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Package implementing class browsers for various languages. | 26 Package implementing class browsers for various languages. |
| 25 </p><p> | 27 </p> |
| 28 <p> | |
| 26 Currently it offers class browser support for the following | 29 Currently it offers class browser support for the following |
| 27 programming languages. | 30 programming languages. |
| 28 </p><p> | 31 </p> |
| 32 <p> | |
| 29 <ul> | 33 <ul> |
| 30 <li>CORBA IDL</li> | 34 <li>CORBA IDL</li> |
| 31 <li>JavaScript</li> | 35 <li>JavaScript</li> |
| 32 <li>ProtoBuf</li> | 36 <li>ProtoBuf</li> |
| 33 <li>Python 2</li> | 37 <li>Python 2</li> |
| 34 <li>Python 3</li> | 38 <li>Python 3</li> |
| 35 <li>Ruby</li> | 39 <li>Ruby</li> |
| 36 </ul> | 40 </ul> |
| 37 </p> | 41 </p> |
| 38 <h3>Global Attributes</h3> | 42 <h3>Global Attributes</h3> |
| 43 | |
| 39 <table> | 44 <table> |
| 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> | 45 <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> |
| 41 </table> | 46 </table> |
| 42 <h3>Classes</h3> | 47 <h3>Classes</h3> |
| 48 | |
| 43 <table> | 49 <table> |
| 44 <tr><td>None</td></tr> | 50 <tr><td>None</td></tr> |
| 45 </table> | 51 </table> |
| 46 <h3>Functions</h3> | 52 <h3>Functions</h3> |
| 53 | |
| 47 <table> | 54 <table> |
| 55 | |
| 48 <tr> | 56 <tr> |
| 49 <td><a href="#find_module">find_module</a></td> | 57 <td><a href="#find_module">find_module</a></td> |
| 50 <td>Module function to extend the Python module finding mechanism.</td> | 58 <td>Module function to extend the Python module finding mechanism.</td> |
| 51 </tr><tr> | 59 </tr> |
| 60 <tr> | |
| 52 <td><a href="#readmodule">readmodule</a></td> | 61 <td><a href="#readmodule">readmodule</a></td> |
| 53 <td>Read a source file and return a dictionary of classes, functions, modules, etc.</td> | 62 <td>Read a source file and return a dictionary of classes, functions, modules, etc.</td> |
| 54 </tr> | 63 </tr> |
| 55 </table> | 64 </table> |
| 56 <hr /><hr /> | 65 <hr /> |
| 66 <hr /> | |
| 57 <a NAME="find_module" ID="find_module"></a> | 67 <a NAME="find_module" ID="find_module"></a> |
| 58 <h2>find_module</h2> | 68 <h2>find_module</h2> |
| 59 <b>find_module</b>(<i>name, path, isPyFile=False</i>) | 69 <b>find_module</b>(<i>name, path, isPyFile=False</i>) |
| 70 | |
| 60 <p> | 71 <p> |
| 61 Module function to extend the Python module finding mechanism. | 72 Module function to extend the Python module finding mechanism. |
| 62 </p><p> | 73 </p> |
| 74 <p> | |
| 63 This function searches for files in the given list of paths. If the | 75 This function searches for files in the given list of paths. If the |
| 64 file name doesn't have an extension or an extension of .py, the normal | 76 file name doesn't have an extension or an extension of .py, the normal |
| 65 Python search implemented in the imp module is used. For all other | 77 Python search implemented in the imp module is used. For all other |
| 66 supported files only the paths list is searched. | 78 supported files only the paths list is searched. |
| 67 </p><dl> | 79 </p> |
| 80 <dl> | |
| 81 | |
| 68 <dt><i>name</i> (str)</dt> | 82 <dt><i>name</i> (str)</dt> |
| 69 <dd> | 83 <dd> |
| 70 file name or module name to search for | 84 file name or module name to search for |
| 71 </dd><dt><i>path</i> (list of str)</dt> | 85 </dd> |
| 86 <dt><i>path</i> (list of str)</dt> | |
| 72 <dd> | 87 <dd> |
| 73 search paths | 88 search paths |
| 74 </dd><dt><i>isPyFile</i> (bool)</dt> | 89 </dd> |
| 90 <dt><i>isPyFile</i> (bool)</dt> | |
| 75 <dd> | 91 <dd> |
| 76 flag indicating a Python file | 92 flag indicating a Python file |
| 77 </dd> | 93 </dd> |
| 78 </dl><dl> | 94 </dl> |
| 95 <dl> | |
| 79 <dt>Returns:</dt> | 96 <dt>Returns:</dt> |
| 80 <dd> | 97 <dd> |
| 81 tuple of the open file, pathname and description. Description | 98 tuple of the open file, pathname and description. Description |
| 82 is a tuple of file suffix, file mode and file type) | 99 is a tuple of file suffix, file mode and file type) |
| 83 </dd> | 100 </dd> |
| 84 </dl><dl> | 101 </dl> |
| 102 <dl> | |
| 85 <dt>Return Type:</dt> | 103 <dt>Return Type:</dt> |
| 86 <dd> | 104 <dd> |
| 87 tuple | 105 tuple |
| 88 </dd> | 106 </dd> |
| 89 </dl><dl> | 107 </dl> |
| 108 <dl> | |
| 109 | |
| 90 <dt>Raises <b>ImportError</b>:</dt> | 110 <dt>Raises <b>ImportError</b>:</dt> |
| 91 <dd> | 111 <dd> |
| 92 The file or module wasn't found. | 112 The file or module wasn't found. |
| 93 </dd> | 113 </dd> |
| 94 </dl> | 114 </dl> |
| 95 <div align="right"><a href="#top">Up</a></div> | 115 <div align="right"><a href="#top">Up</a></div> |
| 96 <hr /><hr /> | 116 <hr /> |
| 117 <hr /> | |
| 97 <a NAME="readmodule" ID="readmodule"></a> | 118 <a NAME="readmodule" ID="readmodule"></a> |
| 98 <h2>readmodule</h2> | 119 <h2>readmodule</h2> |
| 99 <b>readmodule</b>(<i>module, path=None, isPyFile=False</i>) | 120 <b>readmodule</b>(<i>module, path=None, isPyFile=False</i>) |
| 121 | |
| 100 <p> | 122 <p> |
| 101 Read a source file and return a dictionary of classes, functions, modules, | 123 Read a source file and return a dictionary of classes, functions, modules, |
| 102 etc. . | 124 etc. . |
| 103 </p><p> | 125 </p> |
| 126 <p> | |
| 104 The real work of parsing the source file is delegated to the individual | 127 The real work of parsing the source file is delegated to the individual |
| 105 file parsers. | 128 file parsers. |
| 106 </p><dl> | 129 </p> |
| 130 <dl> | |
| 131 | |
| 107 <dt><i>module</i> (str)</dt> | 132 <dt><i>module</i> (str)</dt> |
| 108 <dd> | 133 <dd> |
| 109 name of the source file | 134 name of the source file |
| 110 </dd><dt><i>path</i> (list of str)</dt> | 135 </dd> |
| 136 <dt><i>path</i> (list of str)</dt> | |
| 111 <dd> | 137 <dd> |
| 112 list of paths the file should be searched in | 138 list of paths the file should be searched in |
| 113 </dd><dt><i>isPyFile</i> (bool)</dt> | 139 </dd> |
| 140 <dt><i>isPyFile</i> (bool)</dt> | |
| 114 <dd> | 141 <dd> |
| 115 flag indicating a Python file | 142 flag indicating a Python file |
| 116 </dd> | 143 </dd> |
| 117 </dl><dl> | 144 </dl> |
| 145 <dl> | |
| 118 <dt>Returns:</dt> | 146 <dt>Returns:</dt> |
| 119 <dd> | 147 <dd> |
| 120 the resulting dictionary | 148 the resulting dictionary |
| 121 </dd> | 149 </dd> |
| 122 </dl><dl> | 150 </dl> |
| 151 <dl> | |
| 123 <dt>Return Type:</dt> | 152 <dt>Return Type:</dt> |
| 124 <dd> | 153 <dd> |
| 125 dict | 154 dict |
| 126 </dd> | 155 </dd> |
| 127 </dl> | 156 </dl> |
