Documentation/Source/eric4.PluginManager.PluginExceptions.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.PluginManager.PluginExceptions</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.PluginManager.PluginExceptions</h1>
24 <p>
25 Module implementing the exceptions raised by the plugin system.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#PluginActivationError">PluginActivationError</a></td>
35 <td>Class defining an error raised, when there was an error during plugin activation.</td>
36 </tr><tr>
37 <td><a href="#PluginClassFormatError">PluginClassFormatError</a></td>
38 <td>Class defining an error raised, when the plugin module's class is invalid.</td>
39 </tr><tr>
40 <td><a href="#PluginError">PluginError</a></td>
41 <td>Class defining a special error for the plugin classes.</td>
42 </tr><tr>
43 <td><a href="#PluginLoadError">PluginLoadError</a></td>
44 <td>Class defining an error raised, when there was an error during plugin loading.</td>
45 </tr><tr>
46 <td><a href="#PluginModuleFormatError">PluginModuleFormatError</a></td>
47 <td>Class defining an error raised, when the plugin module is invalid.</td>
48 </tr><tr>
49 <td><a href="#PluginModulesError">PluginModulesError</a></td>
50 <td>Class defining an error raised, when no plugin modules were found.</td>
51 </tr><tr>
52 <td><a href="#PluginPathError">PluginPathError</a></td>
53 <td>Class defining an error raised, when the plugin paths were not found and could not be created.</td>
54 </tr>
55 </table>
56 <h3>Functions</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <hr /><hr />
61 <a NAME="PluginActivationError" ID="PluginActivationError"></a>
62 <h2>PluginActivationError</h2>
63 <p>
64 Class defining an error raised, when there was an error during plugin activation.
65 </p>
66 <h3>Derived from</h3>
67 PluginError
68 <h3>Class Attributes</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#PluginActivationError.__init__">PluginActivationError</a></td>
76 <td>Constructor</td>
77 </tr>
78 </table>
79 <a NAME="PluginActivationError.__init__" ID="PluginActivationError.__init__"></a>
80 <h4>PluginActivationError (Constructor)</h4>
81 <b>PluginActivationError</b>(<i>name</i>)
82 <p>
83 Constructor
84 </p><dl>
85 <dt><i>name</i></dt>
86 <dd>
87 name of the plugin module (string)
88 </dd>
89 </dl>
90 <div align="right"><a href="#top">Up</a></div>
91 <hr /><hr />
92 <a NAME="PluginClassFormatError" ID="PluginClassFormatError"></a>
93 <h2>PluginClassFormatError</h2>
94 <p>
95 Class defining an error raised, when the plugin module's class is invalid.
96 </p>
97 <h3>Derived from</h3>
98 PluginError
99 <h3>Class Attributes</h3>
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103 <h3>Methods</h3>
104 <table>
105 <tr>
106 <td><a href="#PluginClassFormatError.__init__">PluginClassFormatError</a></td>
107 <td>Constructor</td>
108 </tr>
109 </table>
110 <a NAME="PluginClassFormatError.__init__" ID="PluginClassFormatError.__init__"></a>
111 <h4>PluginClassFormatError (Constructor)</h4>
112 <b>PluginClassFormatError</b>(<i>name, class_, missing</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>name</i></dt>
117 <dd>
118 name of the plugin module (string)
119 </dd><dt><i>class_</i></dt>
120 <dd>
121 name of the class not satisfying the requirements (string)
122 </dd><dt><i>missing</i></dt>
123 <dd>
124 description of the missing element (string)
125 </dd>
126 </dl>
127 <div align="right"><a href="#top">Up</a></div>
128 <hr /><hr />
129 <a NAME="PluginError" ID="PluginError"></a>
130 <h2>PluginError</h2>
131 <p>
132 Class defining a special error for the plugin classes.
133 </p>
134 <h3>Derived from</h3>
135 Exception
136 <h3>Class Attributes</h3>
137 <table>
138 <tr><td>None</td></tr>
139 </table>
140 <h3>Methods</h3>
141 <table>
142 <tr>
143 <td><a href="#PluginError.__init__">PluginError</a></td>
144 <td>Constructor</td>
145 </tr><tr>
146 <td><a href="#PluginError.__repr__">__repr__</a></td>
147 <td>Private method returning a representation of the exception.</td>
148 </tr><tr>
149 <td><a href="#PluginError.__str__">__str__</a></td>
150 <td>Private method returning a string representation of the exception.</td>
151 </tr>
152 </table>
153 <a NAME="PluginError.__init__" ID="PluginError.__init__"></a>
154 <h4>PluginError (Constructor)</h4>
155 <b>PluginError</b>(<i></i>)
156 <p>
157 Constructor
158 </p><a NAME="PluginError.__repr__" ID="PluginError.__repr__"></a>
159 <h4>PluginError.__repr__</h4>
160 <b>__repr__</b>(<i></i>)
161 <p>
162 Private method returning a representation of the exception.
163 </p><dl>
164 <dt>Returns:</dt>
165 <dd>
166 string representing the error message
167 </dd>
168 </dl><a NAME="PluginError.__str__" ID="PluginError.__str__"></a>
169 <h4>PluginError.__str__</h4>
170 <b>__str__</b>(<i></i>)
171 <p>
172 Private method returning a string representation of the exception.
173 </p><dl>
174 <dt>Returns:</dt>
175 <dd>
176 string representing the error message
177 </dd>
178 </dl>
179 <div align="right"><a href="#top">Up</a></div>
180 <hr /><hr />
181 <a NAME="PluginLoadError" ID="PluginLoadError"></a>
182 <h2>PluginLoadError</h2>
183 <p>
184 Class defining an error raised, when there was an error during plugin loading.
185 </p>
186 <h3>Derived from</h3>
187 PluginError
188 <h3>Class Attributes</h3>
189 <table>
190 <tr><td>None</td></tr>
191 </table>
192 <h3>Methods</h3>
193 <table>
194 <tr>
195 <td><a href="#PluginLoadError.__init__">PluginLoadError</a></td>
196 <td>Constructor</td>
197 </tr>
198 </table>
199 <a NAME="PluginLoadError.__init__" ID="PluginLoadError.__init__"></a>
200 <h4>PluginLoadError (Constructor)</h4>
201 <b>PluginLoadError</b>(<i>name</i>)
202 <p>
203 Constructor
204 </p><dl>
205 <dt><i>name</i></dt>
206 <dd>
207 name of the plugin module (string)
208 </dd>
209 </dl>
210 <div align="right"><a href="#top">Up</a></div>
211 <hr /><hr />
212 <a NAME="PluginModuleFormatError" ID="PluginModuleFormatError"></a>
213 <h2>PluginModuleFormatError</h2>
214 <p>
215 Class defining an error raised, when the plugin module is invalid.
216 </p>
217 <h3>Derived from</h3>
218 PluginError
219 <h3>Class Attributes</h3>
220 <table>
221 <tr><td>None</td></tr>
222 </table>
223 <h3>Methods</h3>
224 <table>
225 <tr>
226 <td><a href="#PluginModuleFormatError.__init__">PluginModuleFormatError</a></td>
227 <td>Constructor</td>
228 </tr>
229 </table>
230 <a NAME="PluginModuleFormatError.__init__" ID="PluginModuleFormatError.__init__"></a>
231 <h4>PluginModuleFormatError (Constructor)</h4>
232 <b>PluginModuleFormatError</b>(<i>name, missing</i>)
233 <p>
234 Constructor
235 </p><dl>
236 <dt><i>name</i></dt>
237 <dd>
238 name of the plugin module (string)
239 </dd><dt><i>missing</i></dt>
240 <dd>
241 description of the missing element (string)
242 </dd>
243 </dl>
244 <div align="right"><a href="#top">Up</a></div>
245 <hr /><hr />
246 <a NAME="PluginModulesError" ID="PluginModulesError"></a>
247 <h2>PluginModulesError</h2>
248 <p>
249 Class defining an error raised, when no plugin modules were found.
250 </p>
251 <h3>Derived from</h3>
252 PluginError
253 <h3>Class Attributes</h3>
254 <table>
255 <tr><td>None</td></tr>
256 </table>
257 <h3>Methods</h3>
258 <table>
259 <tr>
260 <td><a href="#PluginModulesError.__init__">PluginModulesError</a></td>
261 <td>Constructor</td>
262 </tr>
263 </table>
264 <a NAME="PluginModulesError.__init__" ID="PluginModulesError.__init__"></a>
265 <h4>PluginModulesError (Constructor)</h4>
266 <b>PluginModulesError</b>(<i></i>)
267 <p>
268 Constructor
269 </p>
270 <div align="right"><a href="#top">Up</a></div>
271 <hr /><hr />
272 <a NAME="PluginPathError" ID="PluginPathError"></a>
273 <h2>PluginPathError</h2>
274 <p>
275 Class defining an error raised, when the plugin paths were not found and
276 could not be created.
277 </p>
278 <h3>Derived from</h3>
279 PluginError
280 <h3>Class Attributes</h3>
281 <table>
282 <tr><td>None</td></tr>
283 </table>
284 <h3>Methods</h3>
285 <table>
286 <tr>
287 <td><a href="#PluginPathError.__init__">PluginPathError</a></td>
288 <td>Constructor</td>
289 </tr>
290 </table>
291 <a NAME="PluginPathError.__init__" ID="PluginPathError.__init__"></a>
292 <h4>PluginPathError (Constructor)</h4>
293 <b>PluginPathError</b>(<i>msg = None</i>)
294 <p>
295 Constructor
296 </p><dl>
297 <dt><i>msg</i></dt>
298 <dd>
299 message to be used by the exception (string)
300 </dd>
301 </dl>
302 <div align="right"><a href="#top">Up</a></div>
303 <hr />
304 </body></html>

eric ide

mercurial