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