Mercurial Repositories > PyLint Checker / file comparison
comparison: PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.html
PyLintInterface/Documentation/source/Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog.html
- branch
- eric7
- changeset 102
- e40ecfd9ec37
- child 117
- f8955e5dba87
equal
deleted
inserted
replaced
| 101:98784d037491 | 102:e40ecfd9ec37 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Checker_PyLint.PyLintInterface.PyLintConfigDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to configure the PyLint process. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td> | |
| 25 <td>Class implementing a dialog to configure the PyLint process.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a> | |
| 36 <h2>PyLintConfigDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to configure the PyLint process. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_PyLintConfigDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td> | |
| 63 <td>Private slot to handle the the finished signal of the pylint process.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 67 <td>Private method to set the default values.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td> | |
| 71 <td>Private slot to handle the readyReadStandardError signal of the pylint process.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td> | |
| 75 <td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PyLintConfigDialog.accept">accept</a></td> | |
| 79 <td>Public slot called by the Ok button.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td> | |
| 83 <td>Public method that generates the commandline parameters.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> | |
| 87 <td>Private slot to handle the generation of a sample configuration.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> | |
| 97 <h4>PyLintConfigDialog (Constructor)</h4> | |
| 98 <b>PyLintConfigDialog</b>(<i>ppath, exe, parms, version</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>ppath</i> (str)</dt> | |
| 106 <dd> | |
| 107 project path; used to set the default path for the | |
| 108 rcfile picker | |
| 109 </dd> | |
| 110 <dt><i>exe</i> (str)</dt> | |
| 111 <dd> | |
| 112 name of the pylint executable | |
| 113 </dd> | |
| 114 <dt><i>parms</i> (dict)</dt> | |
| 115 <dd> | |
| 116 parameters to set in the dialog | |
| 117 </dd> | |
| 118 <dt><i>version</i> (str)</dt> | |
| 119 <dd> | |
| 120 pylint version (unused) | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> | |
| 124 <h4>PyLintConfigDialog.__createConfigDone</h4> | |
| 125 <b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) | |
| 126 | |
| 127 <p> | |
| 128 Private slot to handle the the finished signal of the pylint process. | |
| 129 </p> | |
| 130 <dl> | |
| 131 | |
| 132 <dt><i>exitCode</i> (int)</dt> | |
| 133 <dd> | |
| 134 exit code of the process | |
| 135 </dd> | |
| 136 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 137 <dd> | |
| 138 exit status of the process | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> | |
| 142 <h4>PyLintConfigDialog.__initializeDefaults</h4> | |
| 143 <b>__initializeDefaults</b>(<i></i>) | |
| 144 | |
| 145 <p> | |
| 146 Private method to set the default values. | |
| 147 </p> | |
| 148 <p> | |
| 149 These are needed later on to generate the commandline | |
| 150 parameters. | |
| 151 </p> | |
| 152 <a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> | |
| 153 <h4>PyLintConfigDialog.__readStderr</h4> | |
| 154 <b>__readStderr</b>(<i></i>) | |
| 155 | |
| 156 <p> | |
| 157 Private slot to handle the readyReadStandardError signal of the | |
| 158 pylint process. | |
| 159 </p> | |
| 160 <a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> | |
| 161 <h4>PyLintConfigDialog.__readStdout</h4> | |
| 162 <b>__readStdout</b>(<i></i>) | |
| 163 | |
| 164 <p> | |
| 165 Private slot to handle the readyReadStandardOutput signal of the | |
| 166 pylint process. | |
| 167 </p> | |
| 168 <a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> | |
| 169 <h4>PyLintConfigDialog.accept</h4> | |
| 170 <b>accept</b>(<i></i>) | |
| 171 | |
| 172 <p> | |
| 173 Public slot called by the Ok button. | |
| 174 </p> | |
| 175 <p> | |
| 176 It saves the values in the parameters dictionary. | |
| 177 </p> | |
| 178 <a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> | |
| 179 <h4>PyLintConfigDialog.generateParameters</h4> | |
| 180 <b>generateParameters</b>(<i></i>) | |
| 181 | |
| 182 <p> | |
| 183 Public method that generates the commandline parameters. | |
| 184 </p> | |
| 185 <p> | |
| 186 It generates a list of strings to be used | |
| 187 to set the QProcess arguments for the pylint call and | |
| 188 a list containing the non default parameters. The second | |
| 189 list can be passed back upon object generation to overwrite | |
| 190 the default settings. | |
| 191 </p> | |
| 192 <p> | |
| 193 <b>Note</b>: The arguments list contains the name of the pylint | |
| 194 executable as the first parameter. | |
| 195 </p> | |
| 196 <dl> | |
| 197 <dt>Return:</dt> | |
| 198 <dd> | |
| 199 a tuple of the commandline parameters and non default | |
| 200 parameters | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <dl> | |
| 204 <dt>Return Type:</dt> | |
| 205 <dd> | |
| 206 tuple of (list of str, dict) | |
| 207 </dd> | |
| 208 </dl> | |
| 209 <a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> | |
| 210 <h4>PyLintConfigDialog.on_configButton_clicked</h4> | |
| 211 <b>on_configButton_clicked</b>(<i></i>) | |
| 212 | |
| 213 <p> | |
| 214 Private slot to handle the generation of a sample configuration. | |
| 215 </p> | |
| 216 <div align="right"><a href="#top">Up</a></div> | |
| 217 <hr /> | |
| 218 </body></html> |
