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