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 18
- ae62d56e345d
- child 22
- 68beeb22dade
equal
deleted
inserted
replaced
| 17:be64e1afc5c2 | 18:ae62d56e345d |
|---|---|
| 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:white; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #4FA4FF; } | |
| 13 h2 { color: white; background: #4FA4FF; } | |
| 14 h3 { color: white; background: #00557F; } | |
| 15 h4 { color: white; background: #00557F; } | |
| 16 | |
| 17 a { color: #AA5500; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Checker_PyLint.PyLint.PyLintConfigDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to configure the PyLint process | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#PyLintConfigDialog">PyLintConfigDialog</a></td> | |
| 34 <td>Class implementing a dialog to configure the PyLint process</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="PyLintConfigDialog" ID="PyLintConfigDialog"></a> | |
| 43 <h2>PyLintConfigDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to configure the PyLint process | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_PyLintConfigDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#PyLintConfigDialog.__init__">PyLintConfigDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PyLintConfigDialog.__createConfigDone">__createConfigDone</a></td> | |
| 64 <td>Private slot to handle the the finished signal of the pylint process.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PyLintConfigDialog.__initializeDefaults">__initializeDefaults</a></td> | |
| 67 <td>Private method to set the default values.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PyLintConfigDialog.__readStderr">__readStderr</a></td> | |
| 70 <td>Private slot to handle the readyReadStandardError signal of the pylint process.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PyLintConfigDialog.__readStdout">__readStdout</a></td> | |
| 73 <td>Private slot to handle the readyReadStandardOutput signal of the pylint process.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PyLintConfigDialog.accept">accept</a></td> | |
| 76 <td>Protected slot called by the Ok button.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PyLintConfigDialog.generateParameters">generateParameters</a></td> | |
| 79 <td>Public method that generates the commandline parameters.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PyLintConfigDialog.on_configButton_clicked">on_configButton_clicked</a></td> | |
| 82 <td>Public slot to handle the generation of a sample configuration.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PyLintConfigDialog.on_configfileButton_clicked">on_configfileButton_clicked</a></td> | |
| 85 <td>Private slot to select the configuration file.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#PyLintConfigDialog.on_reportfileButton_clicked">on_reportfileButton_clicked</a></td> | |
| 88 <td>Private slot to select the report file.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="PyLintConfigDialog.__init__" ID="PyLintConfigDialog.__init__"></a> | |
| 96 <h4>PyLintConfigDialog (Constructor)</h4> | |
| 97 <b>PyLintConfigDialog</b>(<i>ppath, exe, parms=None, parent=None</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>ppath</i></dt> | |
| 102 <dd> | |
| 103 project path (string or QString) | |
| 104 Used to set the default path for the rcfile selection dialog | |
| 105 </dd><dt><i>exe</i></dt> | |
| 106 <dd> | |
| 107 name of the pylint executable (string) | |
| 108 </dd><dt><i>parms</i></dt> | |
| 109 <dd> | |
| 110 parameters to set in the dialog | |
| 111 </dd><dt><i>parent</i></dt> | |
| 112 <dd> | |
| 113 reference to the parent widget (QWidget) | |
| 114 </dd> | |
| 115 </dl><a NAME="PyLintConfigDialog.__createConfigDone" ID="PyLintConfigDialog.__createConfigDone"></a> | |
| 116 <h4>PyLintConfigDialog.__createConfigDone</h4> | |
| 117 <b>__createConfigDone</b>(<i>exitCode, exitStatus</i>) | |
| 118 <p> | |
| 119 Private slot to handle the the finished signal of the pylint process. | |
| 120 </p><dl> | |
| 121 <dt><i>exitCode</i></dt> | |
| 122 <dd> | |
| 123 exit code of the process (integer) | |
| 124 </dd><dt><i>exitStatus</i></dt> | |
| 125 <dd> | |
| 126 exit status of the process (QProcess.ExitStatus) | |
| 127 </dd> | |
| 128 </dl><a NAME="PyLintConfigDialog.__initializeDefaults" ID="PyLintConfigDialog.__initializeDefaults"></a> | |
| 129 <h4>PyLintConfigDialog.__initializeDefaults</h4> | |
| 130 <b>__initializeDefaults</b>(<i></i>) | |
| 131 <p> | |
| 132 Private method to set the default values. | |
| 133 </p><p> | |
| 134 These are needed later on to generate the commandline | |
| 135 parameters. | |
| 136 </p><a NAME="PyLintConfigDialog.__readStderr" ID="PyLintConfigDialog.__readStderr"></a> | |
| 137 <h4>PyLintConfigDialog.__readStderr</h4> | |
| 138 <b>__readStderr</b>(<i></i>) | |
| 139 <p> | |
| 140 Private slot to handle the readyReadStandardError signal of the pylint process. | |
| 141 </p><a NAME="PyLintConfigDialog.__readStdout" ID="PyLintConfigDialog.__readStdout"></a> | |
| 142 <h4>PyLintConfigDialog.__readStdout</h4> | |
| 143 <b>__readStdout</b>(<i></i>) | |
| 144 <p> | |
| 145 Private slot to handle the readyReadStandardOutput signal of the pylint process. | |
| 146 </p><a NAME="PyLintConfigDialog.accept" ID="PyLintConfigDialog.accept"></a> | |
| 147 <h4>PyLintConfigDialog.accept</h4> | |
| 148 <b>accept</b>(<i></i>) | |
| 149 <p> | |
| 150 Protected slot called by the Ok button. | |
| 151 </p><p> | |
| 152 It saves the values in the parameters dictionary. | |
| 153 </p><a NAME="PyLintConfigDialog.generateParameters" ID="PyLintConfigDialog.generateParameters"></a> | |
| 154 <h4>PyLintConfigDialog.generateParameters</h4> | |
| 155 <b>generateParameters</b>(<i></i>) | |
| 156 <p> | |
| 157 Public method that generates the commandline parameters. | |
| 158 </p><p> | |
| 159 It generates a QStringList to be used | |
| 160 to set the QProcess arguments for the pylint call and | |
| 161 a list containing the non default parameters. The second | |
| 162 list can be passed back upon object generation to overwrite | |
| 163 the default settings. | |
| 164 </p><p> | |
| 165 <b>Note</b>: The arguments list contains the name of the pylint executable as | |
| 166 the first parameter. | |
| 167 </p><dl> | |
| 168 <dt>Returns:</dt> | |
| 169 <dd> | |
| 170 a tuple of the commandline parameters and non default parameters | |
| 171 (list of strings, dictionary) | |
| 172 </dd> | |
| 173 </dl><a NAME="PyLintConfigDialog.on_configButton_clicked" ID="PyLintConfigDialog.on_configButton_clicked"></a> | |
| 174 <h4>PyLintConfigDialog.on_configButton_clicked</h4> | |
| 175 <b>on_configButton_clicked</b>(<i></i>) | |
| 176 <p> | |
| 177 Public slot to handle the generation of a sample configuration. | |
| 178 </p><a NAME="PyLintConfigDialog.on_configfileButton_clicked" ID="PyLintConfigDialog.on_configfileButton_clicked"></a> | |
| 179 <h4>PyLintConfigDialog.on_configfileButton_clicked</h4> | |
| 180 <b>on_configfileButton_clicked</b>(<i></i>) | |
| 181 <p> | |
| 182 Private slot to select the configuration file. | |
| 183 </p><p> | |
| 184 It displays a file selection dialog to select the configuration file. | |
| 185 </p><a NAME="PyLintConfigDialog.on_reportfileButton_clicked" ID="PyLintConfigDialog.on_reportfileButton_clicked"></a> | |
| 186 <h4>PyLintConfigDialog.on_reportfileButton_clicked</h4> | |
| 187 <b>on_reportfileButton_clicked</b>(<i></i>) | |
| 188 <p> | |
| 189 Private slot to select the report file. | |
| 190 </p><p> | |
| 191 It displays a file selection dialog to select the report file. | |
| 192 </p> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /> | |
| 195 </body></html> |
