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

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

eric ide

mercurial