eric6/Documentation/Source/eric6.PluginManager.PluginExceptions.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7989
a21d673a8f99
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.PluginManager.PluginExceptions</h1> 23 <h1>eric6.PluginManager.PluginExceptions</h1>
24
23 <p> 25 <p>
24 Module implementing the exceptions raised by the plugin system. 26 Module implementing the exceptions raised by the plugin system.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PluginActivationError">PluginActivationError</a></td> 38 <td><a href="#PluginActivationError">PluginActivationError</a></td>
34 <td>Class defining an error raised, when there was an error during plugin activation.</td> 39 <td>Class defining an error raised, when there was an error during plugin activation.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#PluginClassFormatError">PluginClassFormatError</a></td> 42 <td><a href="#PluginClassFormatError">PluginClassFormatError</a></td>
37 <td>Class defining an error raised, when the plugin module's class is invalid.</td> 43 <td>Class defining an error raised, when the plugin module's class is invalid.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#PluginError">PluginError</a></td> 46 <td><a href="#PluginError">PluginError</a></td>
40 <td>Class defining a special error for the plugin classes.</td> 47 <td>Class defining a special error for the plugin classes.</td>
41 </tr><tr> 48 </tr>
49 <tr>
42 <td><a href="#PluginLoadError">PluginLoadError</a></td> 50 <td><a href="#PluginLoadError">PluginLoadError</a></td>
43 <td>Class defining an error raised, when there was an error during plugin loading.</td> 51 <td>Class defining an error raised, when there was an error during plugin loading.</td>
44 </tr><tr> 52 </tr>
53 <tr>
45 <td><a href="#PluginModuleFormatError">PluginModuleFormatError</a></td> 54 <td><a href="#PluginModuleFormatError">PluginModuleFormatError</a></td>
46 <td>Class defining an error raised, when the plugin module is invalid.</td> 55 <td>Class defining an error raised, when the plugin module is invalid.</td>
47 </tr><tr> 56 </tr>
57 <tr>
48 <td><a href="#PluginModulesError">PluginModulesError</a></td> 58 <td><a href="#PluginModulesError">PluginModulesError</a></td>
49 <td>Class defining an error raised, when no plugin modules were found.</td> 59 <td>Class defining an error raised, when no plugin modules were found.</td>
50 </tr><tr> 60 </tr>
61 <tr>
51 <td><a href="#PluginPathError">PluginPathError</a></td> 62 <td><a href="#PluginPathError">PluginPathError</a></td>
52 <td>Class defining an error raised, when the plugin paths were not found and could not be created.</td> 63 <td>Class defining an error raised, when the plugin paths were not found and could not be created.</td>
53 </tr> 64 </tr>
54 </table> 65 </table>
55 <h3>Functions</h3> 66 <h3>Functions</h3>
56 <table> 67
57 <tr><td>None</td></tr> 68 <table>
58 </table> 69 <tr><td>None</td></tr>
59 <hr /><hr /> 70 </table>
71 <hr />
72 <hr />
60 <a NAME="PluginActivationError" ID="PluginActivationError"></a> 73 <a NAME="PluginActivationError" ID="PluginActivationError"></a>
61 <h2>PluginActivationError</h2> 74 <h2>PluginActivationError</h2>
75
62 <p> 76 <p>
63 Class defining an error raised, when there was an error during plugin 77 Class defining an error raised, when there was an error during plugin
64 activation. 78 activation.
65 </p> 79 </p>
66 <h3>Derived from</h3> 80 <h3>Derived from</h3>
67 PluginError 81 PluginError
68 <h3>Class Attributes</h3> 82 <h3>Class Attributes</h3>
69 <table> 83
70 <tr><td>None</td></tr> 84 <table>
71 </table> 85 <tr><td>None</td></tr>
72 <h3>Class Methods</h3> 86 </table>
73 <table> 87 <h3>Class Methods</h3>
74 <tr><td>None</td></tr> 88
75 </table> 89 <table>
76 <h3>Methods</h3> 90 <tr><td>None</td></tr>
77 <table> 91 </table>
92 <h3>Methods</h3>
93
94 <table>
95
78 <tr> 96 <tr>
79 <td><a href="#PluginActivationError.__init__">PluginActivationError</a></td> 97 <td><a href="#PluginActivationError.__init__">PluginActivationError</a></td>
80 <td>Constructor</td> 98 <td>Constructor</td>
81 </tr> 99 </tr>
82 </table> 100 </table>
83 <h3>Static Methods</h3> 101 <h3>Static Methods</h3>
84 <table> 102
85 <tr><td>None</td></tr> 103 <table>
86 </table> 104 <tr><td>None</td></tr>
105 </table>
106
87 <a NAME="PluginActivationError.__init__" ID="PluginActivationError.__init__"></a> 107 <a NAME="PluginActivationError.__init__" ID="PluginActivationError.__init__"></a>
88 <h4>PluginActivationError (Constructor)</h4> 108 <h4>PluginActivationError (Constructor)</h4>
89 <b>PluginActivationError</b>(<i>name</i>) 109 <b>PluginActivationError</b>(<i>name</i>)
90 <p> 110
91 Constructor 111 <p>
92 </p><dl> 112 Constructor
113 </p>
114 <dl>
115
93 <dt><i>name</i></dt> 116 <dt><i>name</i></dt>
94 <dd> 117 <dd>
95 name of the plugin module (string) 118 name of the plugin module (string)
96 </dd> 119 </dd>
97 </dl> 120 </dl>
98 <div align="right"><a href="#top">Up</a></div> 121 <div align="right"><a href="#top">Up</a></div>
99 <hr /><hr /> 122 <hr />
123 <hr />
100 <a NAME="PluginClassFormatError" ID="PluginClassFormatError"></a> 124 <a NAME="PluginClassFormatError" ID="PluginClassFormatError"></a>
101 <h2>PluginClassFormatError</h2> 125 <h2>PluginClassFormatError</h2>
126
102 <p> 127 <p>
103 Class defining an error raised, when the plugin module's class is invalid. 128 Class defining an error raised, when the plugin module's class is invalid.
104 </p> 129 </p>
105 <h3>Derived from</h3> 130 <h3>Derived from</h3>
106 PluginError 131 PluginError
107 <h3>Class Attributes</h3> 132 <h3>Class Attributes</h3>
108 <table> 133
109 <tr><td>None</td></tr> 134 <table>
110 </table> 135 <tr><td>None</td></tr>
111 <h3>Class Methods</h3> 136 </table>
112 <table> 137 <h3>Class Methods</h3>
113 <tr><td>None</td></tr> 138
114 </table> 139 <table>
115 <h3>Methods</h3> 140 <tr><td>None</td></tr>
116 <table> 141 </table>
142 <h3>Methods</h3>
143
144 <table>
145
117 <tr> 146 <tr>
118 <td><a href="#PluginClassFormatError.__init__">PluginClassFormatError</a></td> 147 <td><a href="#PluginClassFormatError.__init__">PluginClassFormatError</a></td>
119 <td>Constructor</td> 148 <td>Constructor</td>
120 </tr> 149 </tr>
121 </table> 150 </table>
122 <h3>Static Methods</h3> 151 <h3>Static Methods</h3>
123 <table> 152
124 <tr><td>None</td></tr> 153 <table>
125 </table> 154 <tr><td>None</td></tr>
155 </table>
156
126 <a NAME="PluginClassFormatError.__init__" ID="PluginClassFormatError.__init__"></a> 157 <a NAME="PluginClassFormatError.__init__" ID="PluginClassFormatError.__init__"></a>
127 <h4>PluginClassFormatError (Constructor)</h4> 158 <h4>PluginClassFormatError (Constructor)</h4>
128 <b>PluginClassFormatError</b>(<i>name, class_, missing</i>) 159 <b>PluginClassFormatError</b>(<i>name, class_, missing</i>)
129 <p> 160
130 Constructor 161 <p>
131 </p><dl> 162 Constructor
163 </p>
164 <dl>
165
132 <dt><i>name</i></dt> 166 <dt><i>name</i></dt>
133 <dd> 167 <dd>
134 name of the plugin module (string) 168 name of the plugin module (string)
135 </dd><dt><i>class_</i></dt> 169 </dd>
170 <dt><i>class_</i></dt>
136 <dd> 171 <dd>
137 name of the class not satisfying the requirements 172 name of the class not satisfying the requirements
138 (string) 173 (string)
139 </dd><dt><i>missing</i></dt> 174 </dd>
175 <dt><i>missing</i></dt>
140 <dd> 176 <dd>
141 description of the missing element (string) 177 description of the missing element (string)
142 </dd> 178 </dd>
143 </dl> 179 </dl>
144 <div align="right"><a href="#top">Up</a></div> 180 <div align="right"><a href="#top">Up</a></div>
145 <hr /><hr /> 181 <hr />
182 <hr />
146 <a NAME="PluginError" ID="PluginError"></a> 183 <a NAME="PluginError" ID="PluginError"></a>
147 <h2>PluginError</h2> 184 <h2>PluginError</h2>
185
148 <p> 186 <p>
149 Class defining a special error for the plugin classes. 187 Class defining a special error for the plugin classes.
150 </p> 188 </p>
151 <h3>Derived from</h3> 189 <h3>Derived from</h3>
152 Exception 190 Exception
153 <h3>Class Attributes</h3> 191 <h3>Class Attributes</h3>
154 <table> 192
155 <tr><td>None</td></tr> 193 <table>
156 </table> 194 <tr><td>None</td></tr>
157 <h3>Class Methods</h3> 195 </table>
158 <table> 196 <h3>Class Methods</h3>
159 <tr><td>None</td></tr> 197
160 </table> 198 <table>
161 <h3>Methods</h3> 199 <tr><td>None</td></tr>
162 <table> 200 </table>
201 <h3>Methods</h3>
202
203 <table>
204
163 <tr> 205 <tr>
164 <td><a href="#PluginError.__init__">PluginError</a></td> 206 <td><a href="#PluginError.__init__">PluginError</a></td>
165 <td>Constructor</td> 207 <td>Constructor</td>
166 </tr><tr> 208 </tr>
209 <tr>
167 <td><a href="#PluginError.__repr__">__repr__</a></td> 210 <td><a href="#PluginError.__repr__">__repr__</a></td>
168 <td>Special method returning a representation of the exception.</td> 211 <td>Special method returning a representation of the exception.</td>
169 </tr><tr> 212 </tr>
213 <tr>
170 <td><a href="#PluginError.__str__">__str__</a></td> 214 <td><a href="#PluginError.__str__">__str__</a></td>
171 <td>Special method returning a string representation of the exception.</td> 215 <td>Special method returning a string representation of the exception.</td>
172 </tr> 216 </tr>
173 </table> 217 </table>
174 <h3>Static Methods</h3> 218 <h3>Static Methods</h3>
175 <table> 219
176 <tr><td>None</td></tr> 220 <table>
177 </table> 221 <tr><td>None</td></tr>
222 </table>
223
178 <a NAME="PluginError.__init__" ID="PluginError.__init__"></a> 224 <a NAME="PluginError.__init__" ID="PluginError.__init__"></a>
179 <h4>PluginError (Constructor)</h4> 225 <h4>PluginError (Constructor)</h4>
180 <b>PluginError</b>(<i></i>) 226 <b>PluginError</b>(<i></i>)
181 <p> 227
182 Constructor 228 <p>
183 </p><a NAME="PluginError.__repr__" ID="PluginError.__repr__"></a> 229 Constructor
230 </p>
231 <a NAME="PluginError.__repr__" ID="PluginError.__repr__"></a>
184 <h4>PluginError.__repr__</h4> 232 <h4>PluginError.__repr__</h4>
185 <b>__repr__</b>(<i></i>) 233 <b>__repr__</b>(<i></i>)
234
186 <p> 235 <p>
187 Special method returning a representation of the exception. 236 Special method returning a representation of the exception.
188 </p><dl> 237 </p>
238 <dl>
189 <dt>Returns:</dt> 239 <dt>Returns:</dt>
190 <dd> 240 <dd>
191 string representing the error message 241 string representing the error message
192 </dd> 242 </dd>
193 </dl><a NAME="PluginError.__str__" ID="PluginError.__str__"></a> 243 </dl>
244 <a NAME="PluginError.__str__" ID="PluginError.__str__"></a>
194 <h4>PluginError.__str__</h4> 245 <h4>PluginError.__str__</h4>
195 <b>__str__</b>(<i></i>) 246 <b>__str__</b>(<i></i>)
247
196 <p> 248 <p>
197 Special method returning a string representation of the exception. 249 Special method returning a string representation of the exception.
198 </p><dl> 250 </p>
251 <dl>
199 <dt>Returns:</dt> 252 <dt>Returns:</dt>
200 <dd> 253 <dd>
201 string representing the error message 254 string representing the error message
202 </dd> 255 </dd>
203 </dl> 256 </dl>
204 <div align="right"><a href="#top">Up</a></div> 257 <div align="right"><a href="#top">Up</a></div>
205 <hr /><hr /> 258 <hr />
259 <hr />
206 <a NAME="PluginLoadError" ID="PluginLoadError"></a> 260 <a NAME="PluginLoadError" ID="PluginLoadError"></a>
207 <h2>PluginLoadError</h2> 261 <h2>PluginLoadError</h2>
262
208 <p> 263 <p>
209 Class defining an error raised, when there was an error during plugin 264 Class defining an error raised, when there was an error during plugin
210 loading. 265 loading.
211 </p> 266 </p>
212 <h3>Derived from</h3> 267 <h3>Derived from</h3>
213 PluginError 268 PluginError
214 <h3>Class Attributes</h3> 269 <h3>Class Attributes</h3>
215 <table> 270
216 <tr><td>None</td></tr> 271 <table>
217 </table> 272 <tr><td>None</td></tr>
218 <h3>Class Methods</h3> 273 </table>
219 <table> 274 <h3>Class Methods</h3>
220 <tr><td>None</td></tr> 275
221 </table> 276 <table>
222 <h3>Methods</h3> 277 <tr><td>None</td></tr>
223 <table> 278 </table>
279 <h3>Methods</h3>
280
281 <table>
282
224 <tr> 283 <tr>
225 <td><a href="#PluginLoadError.__init__">PluginLoadError</a></td> 284 <td><a href="#PluginLoadError.__init__">PluginLoadError</a></td>
226 <td>Constructor</td> 285 <td>Constructor</td>
227 </tr> 286 </tr>
228 </table> 287 </table>
229 <h3>Static Methods</h3> 288 <h3>Static Methods</h3>
230 <table> 289
231 <tr><td>None</td></tr> 290 <table>
232 </table> 291 <tr><td>None</td></tr>
292 </table>
293
233 <a NAME="PluginLoadError.__init__" ID="PluginLoadError.__init__"></a> 294 <a NAME="PluginLoadError.__init__" ID="PluginLoadError.__init__"></a>
234 <h4>PluginLoadError (Constructor)</h4> 295 <h4>PluginLoadError (Constructor)</h4>
235 <b>PluginLoadError</b>(<i>name</i>) 296 <b>PluginLoadError</b>(<i>name</i>)
236 <p> 297
237 Constructor 298 <p>
238 </p><dl> 299 Constructor
300 </p>
301 <dl>
302
239 <dt><i>name</i></dt> 303 <dt><i>name</i></dt>
240 <dd> 304 <dd>
241 name of the plugin module (string) 305 name of the plugin module (string)
242 </dd> 306 </dd>
243 </dl> 307 </dl>
244 <div align="right"><a href="#top">Up</a></div> 308 <div align="right"><a href="#top">Up</a></div>
245 <hr /><hr /> 309 <hr />
310 <hr />
246 <a NAME="PluginModuleFormatError" ID="PluginModuleFormatError"></a> 311 <a NAME="PluginModuleFormatError" ID="PluginModuleFormatError"></a>
247 <h2>PluginModuleFormatError</h2> 312 <h2>PluginModuleFormatError</h2>
313
248 <p> 314 <p>
249 Class defining an error raised, when the plugin module is invalid. 315 Class defining an error raised, when the plugin module is invalid.
250 </p> 316 </p>
251 <h3>Derived from</h3> 317 <h3>Derived from</h3>
252 PluginError 318 PluginError
253 <h3>Class Attributes</h3> 319 <h3>Class Attributes</h3>
254 <table> 320
255 <tr><td>None</td></tr> 321 <table>
256 </table> 322 <tr><td>None</td></tr>
257 <h3>Class Methods</h3> 323 </table>
258 <table> 324 <h3>Class Methods</h3>
259 <tr><td>None</td></tr> 325
260 </table> 326 <table>
261 <h3>Methods</h3> 327 <tr><td>None</td></tr>
262 <table> 328 </table>
329 <h3>Methods</h3>
330
331 <table>
332
263 <tr> 333 <tr>
264 <td><a href="#PluginModuleFormatError.__init__">PluginModuleFormatError</a></td> 334 <td><a href="#PluginModuleFormatError.__init__">PluginModuleFormatError</a></td>
265 <td>Constructor</td> 335 <td>Constructor</td>
266 </tr> 336 </tr>
267 </table> 337 </table>
268 <h3>Static Methods</h3> 338 <h3>Static Methods</h3>
269 <table> 339
270 <tr><td>None</td></tr> 340 <table>
271 </table> 341 <tr><td>None</td></tr>
342 </table>
343
272 <a NAME="PluginModuleFormatError.__init__" ID="PluginModuleFormatError.__init__"></a> 344 <a NAME="PluginModuleFormatError.__init__" ID="PluginModuleFormatError.__init__"></a>
273 <h4>PluginModuleFormatError (Constructor)</h4> 345 <h4>PluginModuleFormatError (Constructor)</h4>
274 <b>PluginModuleFormatError</b>(<i>name, missing</i>) 346 <b>PluginModuleFormatError</b>(<i>name, missing</i>)
275 <p> 347
276 Constructor 348 <p>
277 </p><dl> 349 Constructor
350 </p>
351 <dl>
352
278 <dt><i>name</i></dt> 353 <dt><i>name</i></dt>
279 <dd> 354 <dd>
280 name of the plugin module (string) 355 name of the plugin module (string)
281 </dd><dt><i>missing</i></dt> 356 </dd>
357 <dt><i>missing</i></dt>
282 <dd> 358 <dd>
283 description of the missing element (string) 359 description of the missing element (string)
284 </dd> 360 </dd>
285 </dl> 361 </dl>
286 <div align="right"><a href="#top">Up</a></div> 362 <div align="right"><a href="#top">Up</a></div>
287 <hr /><hr /> 363 <hr />
364 <hr />
288 <a NAME="PluginModulesError" ID="PluginModulesError"></a> 365 <a NAME="PluginModulesError" ID="PluginModulesError"></a>
289 <h2>PluginModulesError</h2> 366 <h2>PluginModulesError</h2>
367
290 <p> 368 <p>
291 Class defining an error raised, when no plugin modules were found. 369 Class defining an error raised, when no plugin modules were found.
292 </p> 370 </p>
293 <h3>Derived from</h3> 371 <h3>Derived from</h3>
294 PluginError 372 PluginError
295 <h3>Class Attributes</h3> 373 <h3>Class Attributes</h3>
296 <table> 374
297 <tr><td>None</td></tr> 375 <table>
298 </table> 376 <tr><td>None</td></tr>
299 <h3>Class Methods</h3> 377 </table>
300 <table> 378 <h3>Class Methods</h3>
301 <tr><td>None</td></tr> 379
302 </table> 380 <table>
303 <h3>Methods</h3> 381 <tr><td>None</td></tr>
304 <table> 382 </table>
383 <h3>Methods</h3>
384
385 <table>
386
305 <tr> 387 <tr>
306 <td><a href="#PluginModulesError.__init__">PluginModulesError</a></td> 388 <td><a href="#PluginModulesError.__init__">PluginModulesError</a></td>
307 <td>Constructor</td> 389 <td>Constructor</td>
308 </tr> 390 </tr>
309 </table> 391 </table>
310 <h3>Static Methods</h3> 392 <h3>Static Methods</h3>
311 <table> 393
312 <tr><td>None</td></tr> 394 <table>
313 </table> 395 <tr><td>None</td></tr>
396 </table>
397
314 <a NAME="PluginModulesError.__init__" ID="PluginModulesError.__init__"></a> 398 <a NAME="PluginModulesError.__init__" ID="PluginModulesError.__init__"></a>
315 <h4>PluginModulesError (Constructor)</h4> 399 <h4>PluginModulesError (Constructor)</h4>
316 <b>PluginModulesError</b>(<i></i>) 400 <b>PluginModulesError</b>(<i></i>)
317 <p> 401
318 Constructor 402 <p>
319 </p> 403 Constructor
320 <div align="right"><a href="#top">Up</a></div> 404 </p>
321 <hr /><hr /> 405 <div align="right"><a href="#top">Up</a></div>
406 <hr />
407 <hr />
322 <a NAME="PluginPathError" ID="PluginPathError"></a> 408 <a NAME="PluginPathError" ID="PluginPathError"></a>
323 <h2>PluginPathError</h2> 409 <h2>PluginPathError</h2>
410
324 <p> 411 <p>
325 Class defining an error raised, when the plugin paths were not found and 412 Class defining an error raised, when the plugin paths were not found and
326 could not be created. 413 could not be created.
327 </p> 414 </p>
328 <h3>Derived from</h3> 415 <h3>Derived from</h3>
329 PluginError 416 PluginError
330 <h3>Class Attributes</h3> 417 <h3>Class Attributes</h3>
331 <table> 418
332 <tr><td>None</td></tr> 419 <table>
333 </table> 420 <tr><td>None</td></tr>
334 <h3>Class Methods</h3> 421 </table>
335 <table> 422 <h3>Class Methods</h3>
336 <tr><td>None</td></tr> 423
337 </table> 424 <table>
338 <h3>Methods</h3> 425 <tr><td>None</td></tr>
339 <table> 426 </table>
427 <h3>Methods</h3>
428
429 <table>
430
340 <tr> 431 <tr>
341 <td><a href="#PluginPathError.__init__">PluginPathError</a></td> 432 <td><a href="#PluginPathError.__init__">PluginPathError</a></td>
342 <td>Constructor</td> 433 <td>Constructor</td>
343 </tr> 434 </tr>
344 </table> 435 </table>
345 <h3>Static Methods</h3> 436 <h3>Static Methods</h3>
346 <table> 437
347 <tr><td>None</td></tr> 438 <table>
348 </table> 439 <tr><td>None</td></tr>
440 </table>
441
349 <a NAME="PluginPathError.__init__" ID="PluginPathError.__init__"></a> 442 <a NAME="PluginPathError.__init__" ID="PluginPathError.__init__"></a>
350 <h4>PluginPathError (Constructor)</h4> 443 <h4>PluginPathError (Constructor)</h4>
351 <b>PluginPathError</b>(<i>msg=None</i>) 444 <b>PluginPathError</b>(<i>msg=None</i>)
352 <p> 445
353 Constructor 446 <p>
354 </p><dl> 447 Constructor
448 </p>
449 <dl>
450
355 <dt><i>msg</i></dt> 451 <dt><i>msg</i></dt>
356 <dd> 452 <dd>
357 message to be used by the exception (string) 453 message to be used by the exception (string)
358 </dd> 454 </dd>
359 </dl> 455 </dl>

eric ide

mercurial