Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginCodeStyleChecker.html
Documentation/Source/eric5.Plugins.PluginCodeStyleChecker.html
- branch
- Py2 comp.
- changeset 3456
- 96232974dcdb
- parent 2985
- 177b1858245f
- child 3525
- 66f4b8646622
equal
deleted
inserted
replaced
| 3178:f25fc1364c88 | 3456:96232974dcdb |
|---|---|
| 41 <hr /><hr /> | 41 <hr /><hr /> |
| 42 <a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a> | 42 <a NAME="CodeStyleCheckerPlugin" ID="CodeStyleCheckerPlugin"></a> |
| 43 <h2>CodeStyleCheckerPlugin</h2> | 43 <h2>CodeStyleCheckerPlugin</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing the code style checker plug-in. | 45 Class implementing the code style checker plug-in. |
| 46 </p> | 46 </p><h3>Signals</h3> |
| 47 <dl> | |
| 48 <dt>styleChecked(str, dict, int, list)</dt> | |
| 49 <dd> | |
| 50 emited when the style check was | |
| 51 done. | |
| 52 </dd> | |
| 53 </dl> | |
| 47 <h3>Derived from</h3> | 54 <h3>Derived from</h3> |
| 48 QObject | 55 QObject |
| 49 <h3>Class Attributes</h3> | 56 <h3>Class Attributes</h3> |
| 50 <table> | 57 <table> |
| 51 <tr><td>None</td></tr> | 58 <tr><td>None</td></tr> |
| 85 <td>Public slot used to check the project files for code style.</td> | 92 <td>Public slot used to check the project files for code style.</td> |
| 86 </tr><tr> | 93 </tr><tr> |
| 87 <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> | 94 <td><a href="#CodeStyleCheckerPlugin.__projectShowMenu">__projectShowMenu</a></td> |
| 88 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | 95 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> |
| 89 </tr><tr> | 96 </tr><tr> |
| 97 <td><a href="#CodeStyleCheckerPlugin.__translateStyleCheck">__translateStyleCheck</a></td> | |
| 98 <td>Privat slot called after perfoming a style check on one file.</td> | |
| 99 </tr><tr> | |
| 90 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td> | 100 <td><a href="#CodeStyleCheckerPlugin.activate">activate</a></td> |
| 91 <td>Public method to activate this plugin.</td> | 101 <td>Public method to activate this plugin.</td> |
| 92 </tr><tr> | 102 </tr><tr> |
| 93 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> | 103 <td><a href="#CodeStyleCheckerPlugin.deactivate">deactivate</a></td> |
| 94 <td>Public method to deactivate this plugin.</td> | 104 <td>Public method to deactivate this plugin.</td> |
| 105 </tr><tr> | |
| 106 <td><a href="#CodeStyleCheckerPlugin.styleCheck">styleCheck</a></td> | |
| 107 <td>Method to prepare a style check on one Python source file in another task.</td> | |
| 95 </tr> | 108 </tr> |
| 96 </table> | 109 </table> |
| 97 <h3>Static Methods</h3> | 110 <h3>Static Methods</h3> |
| 98 <table> | 111 <table> |
| 99 <tr><td>None</td></tr> | 112 <tr><td>None</td></tr> |
| 193 name of the menu to be shown (string) | 206 name of the menu to be shown (string) |
| 194 </dd><dt><i>menu</i></dt> | 207 </dd><dt><i>menu</i></dt> |
| 195 <dd> | 208 <dd> |
| 196 reference to the menu (QMenu) | 209 reference to the menu (QMenu) |
| 197 </dd> | 210 </dd> |
| 211 </dl><a NAME="CodeStyleCheckerPlugin.__translateStyleCheck" ID="CodeStyleCheckerPlugin.__translateStyleCheck"></a> | |
| 212 <h4>CodeStyleCheckerPlugin.__translateStyleCheck</h4> | |
| 213 <b>__translateStyleCheck</b>(<i>fn, codeStyleCheckerStats, results</i>) | |
| 214 <p> | |
| 215 Privat slot called after perfoming a style check on one file. | |
| 216 </p><dl> | |
| 217 <dt><i>fn</i></dt> | |
| 218 <dd> | |
| 219 filename of the just checked file (str) | |
| 220 </dd><dt><i>codeStyleCheckerStats</i></dt> | |
| 221 <dd> | |
| 222 stats of style and name check (dict) | |
| 223 </dd><dt><i>results</i></dt> | |
| 224 <dd> | |
| 225 tuple for each found violation of style (tuple of | |
| 226 lineno (int), position (int), text (str), fixed (bool), | |
| 227 autofixing (bool), fixedMsg (str)) | |
| 228 </dd> | |
| 198 </dl><a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a> | 229 </dl><a NAME="CodeStyleCheckerPlugin.activate" ID="CodeStyleCheckerPlugin.activate"></a> |
| 199 <h4>CodeStyleCheckerPlugin.activate</h4> | 230 <h4>CodeStyleCheckerPlugin.activate</h4> |
| 200 <b>activate</b>(<i></i>) | 231 <b>activate</b>(<i></i>) |
| 201 <p> | 232 <p> |
| 202 Public method to activate this plugin. | 233 Public method to activate this plugin. |
| 208 </dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> | 239 </dl><a NAME="CodeStyleCheckerPlugin.deactivate" ID="CodeStyleCheckerPlugin.deactivate"></a> |
| 209 <h4>CodeStyleCheckerPlugin.deactivate</h4> | 240 <h4>CodeStyleCheckerPlugin.deactivate</h4> |
| 210 <b>deactivate</b>(<i></i>) | 241 <b>deactivate</b>(<i></i>) |
| 211 <p> | 242 <p> |
| 212 Public method to deactivate this plugin. | 243 Public method to deactivate this plugin. |
| 213 </p> | 244 </p><a NAME="CodeStyleCheckerPlugin.styleCheck" ID="CodeStyleCheckerPlugin.styleCheck"></a> |
| 245 <h4>CodeStyleCheckerPlugin.styleCheck</h4> | |
| 246 <b>styleCheck</b>(<i>lang, filename, source, args</i>) | |
| 247 <p> | |
| 248 Method to prepare a style check on one Python source file in another | |
| 249 task. | |
| 250 </p><dl> | |
| 251 <dt><i>lang</i></dt> | |
| 252 <dd> | |
| 253 language of the file or None to determine by internal | |
| 254 algorithm (str or None) | |
| 255 </dd><dt><i>filename</i></dt> | |
| 256 <dd> | |
| 257 source filename (string) | |
| 258 </dd><dt><i>source</i></dt> | |
| 259 <dd> | |
| 260 string containing the code to check (string) | |
| 261 </dd><dt><i>args</i></dt> | |
| 262 <dd> | |
| 263 arguments used by the codeStyleCheck function (list of | |
| 264 excludeMessages (str), includeMessages (str), repeatMessages | |
| 265 (bool), fixCodes (str), noFixCodes (str), fixIssues (bool), | |
| 266 maxLineLength (int), hangClosing (bool), docType (str), errors | |
| 267 (list of str), eol (str), encoding (str)) | |
| 268 </dd> | |
| 269 </dl> | |
| 214 <div align="right"><a href="#top">Up</a></div> | 270 <div align="right"><a href="#top">Up</a></div> |
| 215 <hr /> | 271 <hr /> |
| 216 </body></html> | 272 </body></html> |
