Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html

eric6/Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7610
df7025fe26a3
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.PluginCodeStyleChecker</h1> 23 <h1>eric6.Plugins.PluginCodeStyleChecker</h1>
24
23 <p> 25 <p>
24 Module implementing the code style checker plug-in. 26 Module implementing the code style checker plug-in.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 31 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#CodeStyleCheckerPlugin">CodeStyleCheckerPlugin</a></td> 38 <td><a href="#CodeStyleCheckerPlugin">CodeStyleCheckerPlugin</a></td>
34 <td>Class implementing the code style checker plug-in.</td> 39 <td>Class implementing the code style checker plug-in.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a> 49 <a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a>
43 <h2>CodeStyleCheckerPlugin</h2> 50 <h2>CodeStyleCheckerPlugin</h2>
51
44 <p> 52 <p>
45 Class implementing the code style checker plug-in. 53 Class implementing the code style checker plug-in.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>batchFinished()</dt> 58 <dt>batchFinished()</dt>
49 <dd> 59 <dd>
50 emitted when a style check batch is done 60 emitted when a style check batch is done
51 </dd><dt>error(str, str)</dt> 61 </dd>
62 <dt>error(str, str)</dt>
52 <dd> 63 <dd>
53 emitted in case of an error 64 emitted in case of an error
54 </dd><dt>styleChecked(str, dict, int, list)</dt> 65 </dd>
66 <dt>styleChecked(str, dict, int, list)</dt>
55 <dd> 67 <dd>
56 emitted when the style check was 68 emitted when the style check was
57 done for a file. 69 done for a file.
58 </dd> 70 </dd>
59 </dl> 71 </dl>
60 <h3>Derived from</h3> 72 <h3>Derived from</h3>
61 QObject 73 QObject
62 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
80
67 <table> 81 <table>
68 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
69 </table> 83 </table>
70 <h3>Methods</h3> 84 <h3>Methods</h3>
71 <table> 85
86 <table>
87
72 <tr> 88 <tr>
73 <td><a href="#CodeStyleCheckerPlugin.__init__">CodeStyleCheckerPlugin</a></td> 89 <td><a href="#CodeStyleCheckerPlugin.__init__">CodeStyleCheckerPlugin</a></td>
74 <td>Constructor</td> 90 <td>Constructor</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#CodeStyleCheckerPlugin.__editorClosed">__editorClosed</a></td> 93 <td><a href="#CodeStyleCheckerPlugin.__editorClosed">__editorClosed</a></td>
77 <td>Private slot called, when an editor was closed.</td> 94 <td>Private slot called, when an editor was closed.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#CodeStyleCheckerPlugin.__editorCodeStyleCheck">__editorCodeStyleCheck</a></td> 97 <td><a href="#CodeStyleCheckerPlugin.__editorCodeStyleCheck">__editorCodeStyleCheck</a></td>
80 <td>Private slot to handle the code style check context menu action of the editors.</td> 98 <td>Private slot to handle the code style check context menu action of the editors.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#CodeStyleCheckerPlugin.__editorOpened">__editorOpened</a></td> 101 <td><a href="#CodeStyleCheckerPlugin.__editorOpened">__editorOpened</a></td>
83 <td>Private slot called, when a new editor was opened.</td> 102 <td>Private slot called, when a new editor was opened.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#CodeStyleCheckerPlugin.__editorShowMenu">__editorShowMenu</a></td> 105 <td><a href="#CodeStyleCheckerPlugin.__editorShowMenu">__editorShowMenu</a></td>
86 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> 106 <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#CodeStyleCheckerPlugin.__initialize">__initialize</a></td> 109 <td><a href="#CodeStyleCheckerPlugin.__initialize">__initialize</a></td>
89 <td>Private slot to (re)initialize the plugin.</td> 110 <td>Private slot to (re)initialize the plugin.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck">__projectBrowserCodeStyleCheck</a></td> 113 <td><a href="#CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck">__projectBrowserCodeStyleCheck</a></td>
92 <td>Private method to handle the code style check context menu action of the project sources browser.</td> 114 <td>Private method to handle the code style check context menu action of the project sources browser.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#CodeStyleCheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td> 117 <td><a href="#CodeStyleCheckerPlugin.__projectBrowserShowMenu">__projectBrowserShowMenu</a></td>
95 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td> 118 <td>Private slot called, when the the project browser menu or a submenu is about to be shown.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#CodeStyleCheckerPlugin.__projectCodeStyleCheck">__projectCodeStyleCheck</a></td> 121 <td><a href="#CodeStyleCheckerPlugin.__projectCodeStyleCheck">__projectCodeStyleCheck</a></td>
98 <td>Private slot used to check the project files for code style.</td> 122 <td>Private slot used to check the project files for code style.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> 125 <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td>
101 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> 126 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#CodeStyleCheckerPlugin.__serviceError">__serviceError</a></td> 129 <td><a href="#CodeStyleCheckerPlugin.__serviceError">__serviceError</a></td>
104 <td>Private slot handling service errors.</td> 130 <td>Private slot handling service errors.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#CodeStyleCheckerPlugin.__translateStyleCheck">__translateStyleCheck</a></td> 133 <td><a href="#CodeStyleCheckerPlugin.__translateStyleCheck">__translateStyleCheck</a></td>
107 <td>Private slot called after perfoming a style check on one file.</td> 134 <td>Private slot called after perfoming a style check on one file.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td> 137 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td>
110 <td>Public method to activate this plugin.</td> 138 <td>Public method to activate this plugin.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#CodeStyleCheckerPlugin.batchJobDone">batchJobDone</a></td> 141 <td><a href="#CodeStyleCheckerPlugin.batchJobDone">batchJobDone</a></td>
113 <td>Public slot handling the completion of a batch job.</td> 142 <td>Public slot handling the completion of a batch job.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#CodeStyleCheckerPlugin.cancelStyleBatchCheck">cancelStyleBatchCheck</a></td> 145 <td><a href="#CodeStyleCheckerPlugin.cancelStyleBatchCheck">cancelStyleBatchCheck</a></td>
116 <td>Public method to cancel all batch jobs.</td> 146 <td>Public method to cancel all batch jobs.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> 149 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td>
119 <td>Public method to deactivate this plugin.</td> 150 <td>Public method to deactivate this plugin.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy2">serviceErrorPy2</a></td> 153 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy2">serviceErrorPy2</a></td>
122 <td>Public slot handling service errors for Python 2.</td> 154 <td>Public slot handling service errors for Python 2.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy3">serviceErrorPy3</a></td> 157 <td><a href="#CodeStyleCheckerPlugin.serviceErrorPy3">serviceErrorPy3</a></td>
125 <td>Public slot handling service errors for Python 2.</td> 158 <td>Public slot handling service errors for Python 2.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#CodeStyleCheckerPlugin.styleBatchCheck">styleBatchCheck</a></td> 161 <td><a href="#CodeStyleCheckerPlugin.styleBatchCheck">styleBatchCheck</a></td>
128 <td>Public method to prepare a style check on multiple Python source files.</td> 162 <td>Public method to prepare a style check on multiple Python source files.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td> 165 <td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td>
131 <td>Public method to prepare a style check on one Python source file.</td> 166 <td>Public method to prepare a style check on one Python source file.</td>
132 </tr> 167 </tr>
133 </table> 168 </table>
134 <h3>Static Methods</h3> 169 <h3>Static Methods</h3>
170
135 <table> 171 <table>
136 <tr><td>None</td></tr> 172 <tr><td>None</td></tr>
137 </table> 173 </table>
174
138 <a NAME="CodeStyleCheckerPlugin.__init__" ID="CodeStyleCheckerPlugin.__init__"></a> 175 <a NAME="CodeStyleCheckerPlugin.__init__" ID="CodeStyleCheckerPlugin.__init__"></a>
139 <h4>CodeStyleCheckerPlugin (Constructor)</h4> 176 <h4>CodeStyleCheckerPlugin (Constructor)</h4>
140 <b>CodeStyleCheckerPlugin</b>(<i>ui</i>) 177 <b>CodeStyleCheckerPlugin</b>(<i>ui</i>)
178
141 <p> 179 <p>
142 Constructor 180 Constructor
143 </p><dl> 181 </p>
182 <dl>
183
144 <dt><i>ui</i></dt> 184 <dt><i>ui</i></dt>
145 <dd> 185 <dd>
146 reference to the user interface object (UI.UserInterface) 186 reference to the user interface object (UI.UserInterface)
147 </dd> 187 </dd>
148 </dl><a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a> 188 </dl>
189 <a NAME="CodeStyleCheckerPlugin.__editorClosed" ID="CodeStyleCheckerPlugin.__editorClosed"></a>
149 <h4>CodeStyleCheckerPlugin.__editorClosed</h4> 190 <h4>CodeStyleCheckerPlugin.__editorClosed</h4>
150 <b>__editorClosed</b>(<i>editor</i>) 191 <b>__editorClosed</b>(<i>editor</i>)
192
151 <p> 193 <p>
152 Private slot called, when an editor was closed. 194 Private slot called, when an editor was closed.
153 </p><dl> 195 </p>
196 <dl>
197
154 <dt><i>editor</i></dt> 198 <dt><i>editor</i></dt>
155 <dd> 199 <dd>
156 reference to the editor (QScintilla.Editor) 200 reference to the editor (QScintilla.Editor)
157 </dd> 201 </dd>
158 </dl><a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a> 202 </dl>
203 <a NAME="CodeStyleCheckerPlugin.__editorCodeStyleCheck" ID="CodeStyleCheckerPlugin.__editorCodeStyleCheck"></a>
159 <h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4> 204 <h4>CodeStyleCheckerPlugin.__editorCodeStyleCheck</h4>
160 <b>__editorCodeStyleCheck</b>(<i></i>) 205 <b>__editorCodeStyleCheck</b>(<i></i>)
206
161 <p> 207 <p>
162 Private slot to handle the code style check context menu action 208 Private slot to handle the code style check context menu action
163 of the editors. 209 of the editors.
164 </p><a NAME="CodeStyleCheckerPlugin.__editorOpened" ID="CodeStyleCheckerPlugin.__editorOpened"></a> 210 </p>
211 <a NAME="CodeStyleCheckerPlugin.__editorOpened" ID="CodeStyleCheckerPlugin.__editorOpened"></a>
165 <h4>CodeStyleCheckerPlugin.__editorOpened</h4> 212 <h4>CodeStyleCheckerPlugin.__editorOpened</h4>
166 <b>__editorOpened</b>(<i>editor</i>) 213 <b>__editorOpened</b>(<i>editor</i>)
214
167 <p> 215 <p>
168 Private slot called, when a new editor was opened. 216 Private slot called, when a new editor was opened.
169 </p><dl> 217 </p>
218 <dl>
219
170 <dt><i>editor</i></dt> 220 <dt><i>editor</i></dt>
171 <dd> 221 <dd>
172 reference to the new editor (QScintilla.Editor) 222 reference to the new editor (QScintilla.Editor)
173 </dd> 223 </dd>
174 </dl><a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a> 224 </dl>
225 <a NAME="CodeStyleCheckerPlugin.__editorShowMenu" ID="CodeStyleCheckerPlugin.__editorShowMenu"></a>
175 <h4>CodeStyleCheckerPlugin.__editorShowMenu</h4> 226 <h4>CodeStyleCheckerPlugin.__editorShowMenu</h4>
176 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) 227 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
228
177 <p> 229 <p>
178 Private slot called, when the the editor context menu or a submenu is 230 Private slot called, when the the editor context menu or a submenu is
179 about to be shown. 231 about to be shown.
180 </p><dl> 232 </p>
233 <dl>
234
181 <dt><i>menuName</i></dt> 235 <dt><i>menuName</i></dt>
182 <dd> 236 <dd>
183 name of the menu to be shown (string) 237 name of the menu to be shown (string)
184 </dd><dt><i>menu</i></dt> 238 </dd>
239 <dt><i>menu</i></dt>
185 <dd> 240 <dd>
186 reference to the menu (QMenu) 241 reference to the menu (QMenu)
187 </dd><dt><i>editor</i></dt> 242 </dd>
243 <dt><i>editor</i></dt>
188 <dd> 244 <dd>
189 reference to the editor 245 reference to the editor
190 </dd> 246 </dd>
191 </dl><a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a> 247 </dl>
248 <a NAME="CodeStyleCheckerPlugin.__initialize" ID="CodeStyleCheckerPlugin.__initialize"></a>
192 <h4>CodeStyleCheckerPlugin.__initialize</h4> 249 <h4>CodeStyleCheckerPlugin.__initialize</h4>
193 <b>__initialize</b>(<i></i>) 250 <b>__initialize</b>(<i></i>)
251
194 <p> 252 <p>
195 Private slot to (re)initialize the plugin. 253 Private slot to (re)initialize the plugin.
196 </p><a NAME="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck"></a> 254 </p>
255 <a NAME="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck"></a>
197 <h4>CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck</h4> 256 <h4>CodeStyleCheckerPlugin.__projectBrowserCodeStyleCheck</h4>
198 <b>__projectBrowserCodeStyleCheck</b>(<i></i>) 257 <b>__projectBrowserCodeStyleCheck</b>(<i></i>)
258
199 <p> 259 <p>
200 Private method to handle the code style check context menu action of 260 Private method to handle the code style check context menu action of
201 the project sources browser. 261 the project sources browser.
202 </p><a NAME="CodeStyleCheckerPlugin.__projectBrowserShowMenu" ID="CodeStyleCheckerPlugin.__projectBrowserShowMenu"></a> 262 </p>
263 <a NAME="CodeStyleCheckerPlugin.__projectBrowserShowMenu" ID="CodeStyleCheckerPlugin.__projectBrowserShowMenu"></a>
203 <h4>CodeStyleCheckerPlugin.__projectBrowserShowMenu</h4> 264 <h4>CodeStyleCheckerPlugin.__projectBrowserShowMenu</h4>
204 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>) 265 <b>__projectBrowserShowMenu</b>(<i>menuName, menu</i>)
266
205 <p> 267 <p>
206 Private slot called, when the the project browser menu or a submenu is 268 Private slot called, when the the project browser menu or a submenu is
207 about to be shown. 269 about to be shown.
208 </p><dl> 270 </p>
271 <dl>
272
209 <dt><i>menuName</i></dt> 273 <dt><i>menuName</i></dt>
210 <dd> 274 <dd>
211 name of the menu to be shown (string) 275 name of the menu to be shown (string)
212 </dd><dt><i>menu</i></dt> 276 </dd>
277 <dt><i>menu</i></dt>
213 <dd> 278 <dd>
214 reference to the menu (QMenu) 279 reference to the menu (QMenu)
215 </dd> 280 </dd>
216 </dl><a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a> 281 </dl>
282 <a NAME="CodeStyleCheckerPlugin.__projectCodeStyleCheck" ID="CodeStyleCheckerPlugin.__projectCodeStyleCheck"></a>
217 <h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4> 283 <h4>CodeStyleCheckerPlugin.__projectCodeStyleCheck</h4>
218 <b>__projectCodeStyleCheck</b>(<i></i>) 284 <b>__projectCodeStyleCheck</b>(<i></i>)
285
219 <p> 286 <p>
220 Private slot used to check the project files for code style. 287 Private slot used to check the project files for code style.
221 </p><a NAME="CodeStyleCheckerPlugin.__projectShowMenu" ID="CodeStyleCheckerPlugin.__projectShowMenu"></a> 288 </p>
289 <a NAME="CodeStyleCheckerPlugin.__projectShowMenu" ID="CodeStyleCheckerPlugin.__projectShowMenu"></a>
222 <h4>CodeStyleCheckerPlugin.__projectShowMenu</h4> 290 <h4>CodeStyleCheckerPlugin.__projectShowMenu</h4>
223 <b>__projectShowMenu</b>(<i>menuName, menu</i>) 291 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
292
224 <p> 293 <p>
225 Private slot called, when the the project menu or a submenu is 294 Private slot called, when the the project menu or a submenu is
226 about to be shown. 295 about to be shown.
227 </p><dl> 296 </p>
297 <dl>
298
228 <dt><i>menuName</i></dt> 299 <dt><i>menuName</i></dt>
229 <dd> 300 <dd>
230 name of the menu to be shown (string) 301 name of the menu to be shown (string)
231 </dd><dt><i>menu</i></dt> 302 </dd>
303 <dt><i>menu</i></dt>
232 <dd> 304 <dd>
233 reference to the menu (QMenu) 305 reference to the menu (QMenu)
234 </dd> 306 </dd>
235 </dl><a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a> 307 </dl>
308 <a NAME="CodeStyleCheckerPlugin.__serviceError" ID="CodeStyleCheckerPlugin.__serviceError"></a>
236 <h4>CodeStyleCheckerPlugin.__serviceError</h4> 309 <h4>CodeStyleCheckerPlugin.__serviceError</h4>
237 <b>__serviceError</b>(<i>fn, msg</i>) 310 <b>__serviceError</b>(<i>fn, msg</i>)
311
238 <p> 312 <p>
239 Private slot handling service errors. 313 Private slot handling service errors.
240 </p><dl> 314 </p>
315 <dl>
316
241 <dt><i>fn</i></dt> 317 <dt><i>fn</i></dt>
242 <dd> 318 <dd>
243 file name (string) 319 file name (string)
244 </dd><dt><i>msg</i></dt> 320 </dd>
321 <dt><i>msg</i></dt>
245 <dd> 322 <dd>
246 message text (string) 323 message text (string)
247 </dd> 324 </dd>
248 </dl><a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a> 325 </dl>
326 <a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a>
249 <h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4> 327 <h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4>
250 <b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>) 328 <b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>)
329
251 <p> 330 <p>
252 Private slot called after perfoming a style check on one file. 331 Private slot called after perfoming a style check on one file.
253 </p><dl> 332 </p>
333 <dl>
334
254 <dt><i>fn</i></dt> 335 <dt><i>fn</i></dt>
255 <dd> 336 <dd>
256 filename of the just checked file (str) 337 filename of the just checked file (str)
257 </dd><dt><i>codeStyleCheckerStats</i></dt> 338 </dd>
339 <dt><i>codeStyleCheckerStats</i></dt>
258 <dd> 340 <dd>
259 stats of style and name check (dict) 341 stats of style and name check (dict)
260 </dd><dt><i>results</i></dt> 342 </dd>
343 <dt><i>results</i></dt>
261 <dd> 344 <dd>
262 tuple for each found violation of style (tuple of 345 tuple for each found violation of style (tuple of
263 lineno (int), position (int), text (str), fixed (bool), 346 lineno (int), position (int), text (str), fixed (bool),
264 autofixing (bool), fixedMsg (str)) 347 autofixing (bool), fixedMsg (str))
265 </dd> 348 </dd>
266 </dl><a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a> 349 </dl>
350 <a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a>
267 <h4>CodeStyleCheckerPlugin.activate</h4> 351 <h4>CodeStyleCheckerPlugin.activate</h4>
268 <b>activate</b>(<i></i>) 352 <b>activate</b>(<i></i>)
353
269 <p> 354 <p>
270 Public method to activate this plugin. 355 Public method to activate this plugin.
271 </p><dl> 356 </p>
357 <dl>
272 <dt>Returns:</dt> 358 <dt>Returns:</dt>
273 <dd> 359 <dd>
274 tuple of None and activation status (boolean) 360 tuple of None and activation status (boolean)
275 </dd> 361 </dd>
276 </dl><a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a> 362 </dl>
363 <a NAME="CodeStyleCheckerPlugin.batchJobDone" ID="CodeStyleCheckerPlugin.batchJobDone"></a>
277 <h4>CodeStyleCheckerPlugin.batchJobDone</h4> 364 <h4>CodeStyleCheckerPlugin.batchJobDone</h4>
278 <b>batchJobDone</b>(<i>fx, lang</i>) 365 <b>batchJobDone</b>(<i>fx, lang</i>)
366
279 <p> 367 <p>
280 Public slot handling the completion of a batch job. 368 Public slot handling the completion of a batch job.
281 </p><dl> 369 </p>
370 <dl>
371
282 <dt><i>fx</i></dt> 372 <dt><i>fx</i></dt>
283 <dd> 373 <dd>
284 service name (string) 374 service name (string)
285 </dd><dt><i>lang</i></dt> 375 </dd>
376 <dt><i>lang</i></dt>
286 <dd> 377 <dd>
287 language (string) 378 language (string)
288 </dd> 379 </dd>
289 </dl><a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a> 380 </dl>
381 <a NAME="CodeStyleCheckerPlugin.cancelStyleBatchCheck" ID="CodeStyleCheckerPlugin.cancelStyleBatchCheck"></a>
290 <h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4> 382 <h4>CodeStyleCheckerPlugin.cancelStyleBatchCheck</h4>
291 <b>cancelStyleBatchCheck</b>(<i></i>) 383 <b>cancelStyleBatchCheck</b>(<i></i>)
384
292 <p> 385 <p>
293 Public method to cancel all batch jobs. 386 Public method to cancel all batch jobs.
294 </p><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> 387 </p>
388 <a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a>
295 <h4>CodeStyleCheckerPlugin.deactivate</h4> 389 <h4>CodeStyleCheckerPlugin.deactivate</h4>
296 <b>deactivate</b>(<i></i>) 390 <b>deactivate</b>(<i></i>)
391
297 <p> 392 <p>
298 Public method to deactivate this plugin. 393 Public method to deactivate this plugin.
299 </p><a NAME="CodeStyleCheckerPlugin.serviceErrorPy2" ID="CodeStyleCheckerPlugin.serviceErrorPy2"></a> 394 </p>
395 <a NAME="CodeStyleCheckerPlugin.serviceErrorPy2" ID="CodeStyleCheckerPlugin.serviceErrorPy2"></a>
300 <h4>CodeStyleCheckerPlugin.serviceErrorPy2</h4> 396 <h4>CodeStyleCheckerPlugin.serviceErrorPy2</h4>
301 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) 397 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>)
398
302 <p> 399 <p>
303 Public slot handling service errors for Python 2. 400 Public slot handling service errors for Python 2.
304 </p><dl> 401 </p>
402 <dl>
403
305 <dt><i>fx</i></dt> 404 <dt><i>fx</i></dt>
306 <dd> 405 <dd>
307 service name (string) 406 service name (string)
308 </dd><dt><i>lang</i></dt> 407 </dd>
408 <dt><i>lang</i></dt>
309 <dd> 409 <dd>
310 language (string) 410 language (string)
311 </dd><dt><i>fn</i></dt> 411 </dd>
412 <dt><i>fn</i></dt>
312 <dd> 413 <dd>
313 file name (string) 414 file name (string)
314 </dd><dt><i>msg</i></dt> 415 </dd>
416 <dt><i>msg</i></dt>
315 <dd> 417 <dd>
316 message text (string) 418 message text (string)
317 </dd> 419 </dd>
318 </dl><a NAME="CodeStyleCheckerPlugin.serviceErrorPy3" ID="CodeStyleCheckerPlugin.serviceErrorPy3"></a> 420 </dl>
421 <a NAME="CodeStyleCheckerPlugin.serviceErrorPy3" ID="CodeStyleCheckerPlugin.serviceErrorPy3"></a>
319 <h4>CodeStyleCheckerPlugin.serviceErrorPy3</h4> 422 <h4>CodeStyleCheckerPlugin.serviceErrorPy3</h4>
320 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) 423 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
424
321 <p> 425 <p>
322 Public slot handling service errors for Python 2. 426 Public slot handling service errors for Python 2.
323 </p><dl> 427 </p>
428 <dl>
429
324 <dt><i>fx</i></dt> 430 <dt><i>fx</i></dt>
325 <dd> 431 <dd>
326 service name (string) 432 service name (string)
327 </dd><dt><i>lang</i></dt> 433 </dd>
434 <dt><i>lang</i></dt>
328 <dd> 435 <dd>
329 language (string) 436 language (string)
330 </dd><dt><i>fn</i></dt> 437 </dd>
438 <dt><i>fn</i></dt>
331 <dd> 439 <dd>
332 file name (string) 440 file name (string)
333 </dd><dt><i>msg</i></dt> 441 </dd>
442 <dt><i>msg</i></dt>
334 <dd> 443 <dd>
335 message text (string) 444 message text (string)
336 </dd> 445 </dd>
337 </dl><a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a> 446 </dl>
447 <a NAME="CodeStyleCheckerPlugin.styleBatchCheck" ID="CodeStyleCheckerPlugin.styleBatchCheck"></a>
338 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4> 448 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4>
339 <b>styleBatchCheck</b>(<i>argumentsList</i>) 449 <b>styleBatchCheck</b>(<i>argumentsList</i>)
450
340 <p> 451 <p>
341 Public method to prepare a style check on multiple Python source files. 452 Public method to prepare a style check on multiple Python source files.
342 </p><dl> 453 </p>
454 <dl>
455
343 <dt><i>argumentsList</i> (list of tuple of (str, str, list))</dt> 456 <dt><i>argumentsList</i> (list of tuple of (str, str, list))</dt>
344 <dd> 457 <dd>
345 list of arguments tuples with each tuple 458 list of arguments tuples with each tuple
346 containing filename, source and args as given in styleCheck() 459 containing filename, source and args as given in styleCheck()
347 method 460 method
348 </dd> 461 </dd>
349 </dl><a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a> 462 </dl>
463 <a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a>
350 <h4>CodeStyleCheckerPlugin.styleCheck</h4> 464 <h4>CodeStyleCheckerPlugin.styleCheck</h4>
351 <b>styleCheck</b>(<i>lang, filename, source, args</i>) 465 <b>styleCheck</b>(<i>lang, filename, source, args</i>)
466
352 <p> 467 <p>
353 Public method to prepare a style check on one Python source file. 468 Public method to prepare a style check on one Python source file.
354 </p><dl> 469 </p>
470 <dl>
471
355 <dt><i>lang</i> (str or None)</dt> 472 <dt><i>lang</i> (str or None)</dt>
356 <dd> 473 <dd>
357 language of the file or None to determine by internal 474 language of the file or None to determine by internal
358 algorithm 475 algorithm
359 </dd><dt><i>filename</i> (str)</dt> 476 </dd>
477 <dt><i>filename</i> (str)</dt>
360 <dd> 478 <dd>
361 source filename 479 source filename
362 </dd><dt><i>source</i> (str)</dt> 480 </dd>
481 <dt><i>source</i> (str)</dt>
363 <dd> 482 <dd>
364 string containing the code to check 483 string containing the code to check
365 </dd><dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt> 484 </dd>
485 <dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
366 <dd> 486 <dd>
367 arguments used by the codeStyleCheck function (list of 487 arguments used by the codeStyleCheck function (list of
368 excludeMessages, includeMessages, repeatMessages, fixCodes, 488 excludeMessages, includeMessages, repeatMessages, fixCodes,
369 noFixCodes, fixIssues, maxLineLength, blankLines, hangClosing, 489 noFixCodes, fixIssues, maxLineLength, blankLines, hangClosing,
370 docType, codeComplexityArgs, miscellaneousArgs, errors, eol, 490 docType, codeComplexityArgs, miscellaneousArgs, errors, eol,

Mercurial Repository: eric

eric ide

mercurial