Mercurial Repositories > PyLint Checker / file comparison
comparison: PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintConfigDialog.html
PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLint.PyLintConfigDialog.html
- branch
- eric7
- changeset 98
- ab4aabca55ec
- parent 95
- 50eba81e4a9f
equal
deleted
inserted
replaced
| 97:2226347d86e4 | 98:ab4aabca55ec |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a dialog to configure the PyLint process. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td> | |
| 39 <td>Class implementing a dialog to configure the PyLint process.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a> | |
| 50 <h2>PyLintConfigDialog</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a dialog to configure the PyLint process. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QDialog, Ui_PyLintConfigDialog | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td> | |
| 77 <td>Private slot to handle the the finished signal of the pylint process.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 81 <td>Private method to set the default values.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td> | |
| 85 <td>Private slot to handle the readyReadStandardError signal of the pylint process.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td> | |
| 89 <td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#PyLintConfigDialog.accept">accept</a></td> | |
| 93 <td>Public slot called by the Ok button.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td> | |
| 97 <td>Public method that generates the commandline parameters.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> | |
| 101 <td>Private slot to handle the generation of a sample configuration.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#PyLintConfigDialog.on_configfileButton_clicked">on_configfileButton_clicked</a></td> | |
| 105 <td>Private slot to select the configuration file.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#PyLintConfigDialog.on_reportfileButton_clicked">on_reportfileButton_clicked</a></td> | |
| 109 <td>Private slot to select the report file.</td> | |
| 110 </tr> | |
| 111 </table> | |
| 112 <h3>Static Methods</h3> | |
| 113 | |
| 114 <table> | |
| 115 <tr><td>None</td></tr> | |
| 116 </table> | |
| 117 | |
| 118 <a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> | |
| 119 <h4>PyLintConfigDialog (Constructor)</h4> | |
| 120 <b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>) | |
| 121 | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p> | |
| 125 <dl> | |
| 126 | |
| 127 <dt><i>ppath</i></dt> | |
| 128 <dd> | |
| 129 project path (string or QString) | |
| 130 Used to set the default path for the rcfile selection dialog | |
| 131 </dd> | |
| 132 <dt><i>exe</i></dt> | |
| 133 <dd> | |
| 134 name of the pylint executable (string) | |
| 135 </dd> | |
| 136 <dt><i>parms</i></dt> | |
| 137 <dd> | |
| 138 parameters to set in the dialog | |
| 139 </dd> | |
| 140 <dt><i>version</i></dt> | |
| 141 <dd> | |
| 142 pylint version (string) | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> | |
| 146 <h4>PyLintConfigDialog.__createConfigDone</h4> | |
| 147 <b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) | |
| 148 | |
| 149 <p> | |
| 150 Private slot to handle the the finished signal of the pylint process. | |
| 151 </p> | |
| 152 <dl> | |
| 153 | |
| 154 <dt><i>exitCode</i></dt> | |
| 155 <dd> | |
| 156 exit code of the process (integer) | |
| 157 </dd> | |
| 158 <dt><i>exitStatus</i></dt> | |
| 159 <dd> | |
| 160 exit status of the process (QProcess.ExitStatus) | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> | |
| 164 <h4>PyLintConfigDialog.__initializeDefaults</h4> | |
| 165 <b>__initializeDefaults</b>(<i></i>) | |
| 166 | |
| 167 <p> | |
| 168 Private method to set the default values. | |
| 169 </p> | |
| 170 <p> | |
| 171 These are needed later on to generate the commandline | |
| 172 parameters. | |
| 173 </p> | |
| 174 <a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> | |
| 175 <h4>PyLintConfigDialog.__readStderr</h4> | |
| 176 <b>__readStderr</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Private slot to handle the readyReadStandardError signal of the | |
| 180 pylint process. | |
| 181 </p> | |
| 182 <a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> | |
| 183 <h4>PyLintConfigDialog.__readStdout</h4> | |
| 184 <b>__readStdout</b>(<i></i>) | |
| 185 | |
| 186 <p> | |
| 187 Private slot to handle the readyReadStandardOutput signal of the | |
| 188 pylint process. | |
| 189 </p> | |
| 190 <a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> | |
| 191 <h4>PyLintConfigDialog.accept</h4> | |
| 192 <b>accept</b>(<i></i>) | |
| 193 | |
| 194 <p> | |
| 195 Public slot called by the Ok button. | |
| 196 </p> | |
| 197 <p> | |
| 198 It saves the values in the parameters dictionary. | |
| 199 </p> | |
| 200 <a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> | |
| 201 <h4>PyLintConfigDialog.generateParameters</h4> | |
| 202 <b>generateParameters</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Public method that generates the commandline parameters. | |
| 206 </p> | |
| 207 <p> | |
| 208 It generates a QStringList to be used | |
| 209 to set the QProcess arguments for the pylint call and | |
| 210 a list containing the non default parameters. The second | |
| 211 list can be passed back upon object generation to overwrite | |
| 212 the default settings. | |
| 213 </p> | |
| 214 <p> | |
| 215 <b>Note</b>: The arguments list contains the name of the pylint | |
| 216 executable as the first parameter. | |
| 217 </p> | |
| 218 <dl> | |
| 219 <dt>Return:</dt> | |
| 220 <dd> | |
| 221 a tuple of the commandline parameters and non default | |
| 222 parameters (list of strings, dictionary) | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> | |
| 226 <h4>PyLintConfigDialog.on_configButton_clicked</h4> | |
| 227 <b>on_configButton_clicked</b>(<i></i>) | |
| 228 | |
| 229 <p> | |
| 230 Private slot to handle the generation of a sample configuration. | |
| 231 </p> | |
| 232 <a NAME="PyLintConfigDialog.on_configfileButton_clicked" ID="PyLintConfigDialog.on_configfileButton_clicked"></a> | |
| 233 <h4>PyLintConfigDialog.on_configfileButton_clicked</h4> | |
| 234 <b>on_configfileButton_clicked</b>(<i></i>) | |
| 235 | |
| 236 <p> | |
| 237 Private slot to select the configuration file. | |
| 238 </p> | |
| 239 <p> | |
| 240 It displays a file selection dialog to select the configuration file. | |
| 241 </p> | |
| 242 <a NAME="PyLintConfigDialog.on_reportfileButton_clicked" ID="PyLintConfigDialog.on_reportfileButton_clicked"></a> | |
| 243 <h4>PyLintConfigDialog.on_reportfileButton_clicked</h4> | |
| 244 <b>on_reportfileButton_clicked</b>(<i></i>) | |
| 245 | |
| 246 <p> | |
| 247 Private slot to select the report file. | |
| 248 </p> | |
| 249 <p> | |
| 250 It displays a file selection dialog to select the report file. | |
| 251 </p> | |
| 252 <div align="right"><a href="#top">Up</a></div> | |
| 253 <hr /> | |
| 254 </body></html> |
