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