src/eric7/Documentation/Source/eric7.PluginManager.PluginExceptions.html

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

eric ide

mercurial