Mercurial Repositories > Pyright Checker / file comparison
comparison: PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog.html
PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog.html
- branch
- eric7
- changeset 3
- 109b8e5513d8
equal
deleted
inserted
replaced
| 2:772534d88459 | 3:109b8e5513d8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog</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_Pyright.PyrightChecker.PyrightCheckerDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the pyright type checker dialog. | |
| 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="#PyrightCheckerDialog">PyrightCheckerDialog</a></td> | |
| 25 <td>Class documentation goes here.</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="PyrightCheckerDialog" ID="PyrightCheckerDialog"></a> | |
| 36 <h2>PyrightCheckerDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class documentation goes here. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_PyrightCheckerDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>endRole</td></tr><tr><td>filenameRole</td></tr><tr><td>severityRole</td></tr><tr><td>startRole</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="#PyrightCheckerDialog.__init__">PyrightCheckerDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#PyrightCheckerDialog.__clear">__clear</a></td> | |
| 63 <td>Private method to clear the dialog.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PyrightCheckerDialog.__clearEditorErrors">__clearEditorErrors</a></td> | |
| 67 <td>Private method to clear all warning markers of an editor.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PyrightCheckerDialog.__clearErrors">__clearErrors</a></td> | |
| 71 <td>Private method to clear all warning markers of open editors to be checked.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PyrightCheckerDialog.__createResultItem">__createResultItem</a></td> | |
| 75 <td>Private method to create an entry in the result list.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PyrightCheckerDialog.__getConfigurationDict">__getConfigurationDict</a></td> | |
| 79 <td>Private method to assemble and return a dictionary containing the entered non-default configuration parameters.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PyrightCheckerDialog.__processResult">__processResult</a></td> | |
| 83 <td>Private method to process the pyright result.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PyrightCheckerDialog.__pyrightProcessFinished">__pyrightProcessFinished</a></td> | |
| 87 <td>Private slot to process the pyright result.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PyrightCheckerDialog.__readError">__readError</a></td> | |
| 91 <td>Private slot to get the output of the error channel and show it to the user.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PyrightCheckerDialog.__resort">__resort</a></td> | |
| 95 <td>Private method to resort the tree.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PyrightCheckerDialog.__updateSummary">__updateSummary</a></td> | |
| 99 <td>Private method to update the summary data of the dialog.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PyrightCheckerDialog.getDefaults">getDefaults</a></td> | |
| 103 <td>Public method to get a dictionary containing the default values.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PyrightCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td> | |
| 107 <td>Private slot to load the default configuration values.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PyrightCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td> | |
| 111 <td>Private slot to reset the configuration values to their default values.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PyrightCheckerDialog.on_restartButton_clicked">on_restartButton_clicked</a></td> | |
| 115 <td>Private slot to restart the configured check.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PyrightCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td> | |
| 119 <td>Private slot to handle the activation of an item.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#PyrightCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td> | |
| 123 <td>Private slot to handle the "Show" button press.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#PyrightCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td> | |
| 127 <td>Private slot to start the pyright type checking run.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#PyrightCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td> | |
| 131 <td>Private slot to store the current configuration values as default values.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#PyrightCheckerDialog.on_tomlButton_clicked">on_tomlButton_clicked</a></td> | |
| 135 <td>Private slot to generate a TOML snippet of the current configuration.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#PyrightCheckerDialog.prepare">prepare</a></td> | |
| 139 <td>Public method to prepare the dialog with a list of filenames.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#PyrightCheckerDialog.start">start</a></td> | |
| 143 <td>Public method to start a pyright type checking run.</td> | |
| 144 </tr> | |
| 145 </table> | |
| 146 <h3>Static Methods</h3> | |
| 147 | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 | |
| 152 <a NAME="PyrightCheckerDialog.__init__" ID="PyrightCheckerDialog.__init__"></a> | |
| 153 <h4>PyrightCheckerDialog (Constructor)</h4> | |
| 154 <b>PyrightCheckerDialog</b>(<i>plugin, parent=None</i>) | |
| 155 | |
| 156 <p> | |
| 157 Constructor | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>plugin</i> (PyrightPlugin)</dt> | |
| 162 <dd> | |
| 163 reference to the plugin object | |
| 164 </dd> | |
| 165 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 166 <dd> | |
| 167 reference to the parent widget (defaults to None) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <a NAME="PyrightCheckerDialog.__clear" ID="PyrightCheckerDialog.__clear"></a> | |
| 171 <h4>PyrightCheckerDialog.__clear</h4> | |
| 172 <b>__clear</b>(<i></i>) | |
| 173 | |
| 174 <p> | |
| 175 Private method to clear the dialog. | |
| 176 </p> | |
| 177 <a NAME="PyrightCheckerDialog.__clearEditorErrors" ID="PyrightCheckerDialog.__clearEditorErrors"></a> | |
| 178 <h4>PyrightCheckerDialog.__clearEditorErrors</h4> | |
| 179 <b>__clearEditorErrors</b>(<i>editor</i>) | |
| 180 | |
| 181 <p> | |
| 182 Private method to clear all warning markers of an editor. | |
| 183 </p> | |
| 184 <dl> | |
| 185 | |
| 186 <dt><i>editor</i> (Editor)</dt> | |
| 187 <dd> | |
| 188 reference to the editor to be cleared | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <a NAME="PyrightCheckerDialog.__clearErrors" ID="PyrightCheckerDialog.__clearErrors"></a> | |
| 192 <h4>PyrightCheckerDialog.__clearErrors</h4> | |
| 193 <b>__clearErrors</b>(<i>files=None</i>) | |
| 194 | |
| 195 <p> | |
| 196 Private method to clear all warning markers of open editors to be | |
| 197 checked. | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>files</i> (list of str (optional)</dt> | |
| 202 <dd> | |
| 203 list of files to be checked (defaults to None | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <a NAME="PyrightCheckerDialog.__createResultItem" ID="PyrightCheckerDialog.__createResultItem"></a> | |
| 207 <h4>PyrightCheckerDialog.__createResultItem</h4> | |
| 208 <b>__createResultItem</b>(<i>result</i>) | |
| 209 | |
| 210 <p> | |
| 211 Private method to create an entry in the result list. | |
| 212 </p> | |
| 213 <dl> | |
| 214 | |
| 215 <dt><i>result</i> (dict)</dt> | |
| 216 <dd> | |
| 217 dictionary containing check result data | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <a NAME="PyrightCheckerDialog.__getConfigurationDict" ID="PyrightCheckerDialog.__getConfigurationDict"></a> | |
| 221 <h4>PyrightCheckerDialog.__getConfigurationDict</h4> | |
| 222 <b>__getConfigurationDict</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Private method to assemble and return a dictionary containing the entered | |
| 226 non-default configuration parameters. | |
| 227 </p> | |
| 228 <p> | |
| 229 The configuration dictionary is amended with some common parameters not | |
| 230 accessible via the configuration tab. | |
| 231 </p> | |
| 232 <dl> | |
| 233 <dt>Return:</dt> | |
| 234 <dd> | |
| 235 dictionary containing the non-default configuration parameters | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <dl> | |
| 239 <dt>Return Type:</dt> | |
| 240 <dd> | |
| 241 dict | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <a NAME="PyrightCheckerDialog.__processResult" ID="PyrightCheckerDialog.__processResult"></a> | |
| 245 <h4>PyrightCheckerDialog.__processResult</h4> | |
| 246 <b>__processResult</b>(<i>result</i>) | |
| 247 | |
| 248 <p> | |
| 249 Private method to process the pyright result. | |
| 250 </p> | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>result</i> (dict)</dt> | |
| 254 <dd> | |
| 255 dictionary containing the type checking result. | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="PyrightCheckerDialog.__pyrightProcessFinished" ID="PyrightCheckerDialog.__pyrightProcessFinished"></a> | |
| 259 <h4>PyrightCheckerDialog.__pyrightProcessFinished</h4> | |
| 260 <b>__pyrightProcessFinished</b>(<i>exitCode, exitStatus</i>) | |
| 261 | |
| 262 <p> | |
| 263 Private slot to process the pyright result. | |
| 264 </p> | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>exitCode</i> (int)</dt> | |
| 268 <dd> | |
| 269 exit code of the pyright process | |
| 270 </dd> | |
| 271 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 272 <dd> | |
| 273 exit status | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="PyrightCheckerDialog.__readError" ID="PyrightCheckerDialog.__readError"></a> | |
| 277 <h4>PyrightCheckerDialog.__readError</h4> | |
| 278 <b>__readError</b>(<i></i>) | |
| 279 | |
| 280 <p> | |
| 281 Private slot to get the output of the error channel and show it to the user. | |
| 282 </p> | |
| 283 <a NAME="PyrightCheckerDialog.__resort" ID="PyrightCheckerDialog.__resort"></a> | |
| 284 <h4>PyrightCheckerDialog.__resort</h4> | |
| 285 <b>__resort</b>(<i></i>) | |
| 286 | |
| 287 <p> | |
| 288 Private method to resort the tree. | |
| 289 </p> | |
| 290 <a NAME="PyrightCheckerDialog.__updateSummary" ID="PyrightCheckerDialog.__updateSummary"></a> | |
| 291 <h4>PyrightCheckerDialog.__updateSummary</h4> | |
| 292 <b>__updateSummary</b>(<i>summary</i>) | |
| 293 | |
| 294 <p> | |
| 295 Private method to update the summary data of the dialog. | |
| 296 </p> | |
| 297 <dl> | |
| 298 | |
| 299 <dt><i>summary</i> (dict)</dt> | |
| 300 <dd> | |
| 301 dictionary containing the summary data | |
| 302 </dd> | |
| 303 </dl> | |
| 304 <a NAME="PyrightCheckerDialog.getDefaults" ID="PyrightCheckerDialog.getDefaults"></a> | |
| 305 <h4>PyrightCheckerDialog.getDefaults</h4> | |
| 306 <b>getDefaults</b>(<i></i>) | |
| 307 | |
| 308 <p> | |
| 309 Public method to get a dictionary containing the default values. | |
| 310 </p> | |
| 311 <dl> | |
| 312 <dt>Return:</dt> | |
| 313 <dd> | |
| 314 dictionary containing the default values | |
| 315 </dd> | |
| 316 </dl> | |
| 317 <dl> | |
| 318 <dt>Return Type:</dt> | |
| 319 <dd> | |
| 320 dict | |
| 321 </dd> | |
| 322 </dl> | |
| 323 <a NAME="PyrightCheckerDialog.on_loadDefaultButton_clicked" ID="PyrightCheckerDialog.on_loadDefaultButton_clicked"></a> | |
| 324 <h4>PyrightCheckerDialog.on_loadDefaultButton_clicked</h4> | |
| 325 <b>on_loadDefaultButton_clicked</b>(<i></i>) | |
| 326 | |
| 327 <p> | |
| 328 Private slot to load the default configuration values. | |
| 329 </p> | |
| 330 <a NAME="PyrightCheckerDialog.on_resetDefaultButton_clicked" ID="PyrightCheckerDialog.on_resetDefaultButton_clicked"></a> | |
| 331 <h4>PyrightCheckerDialog.on_resetDefaultButton_clicked</h4> | |
| 332 <b>on_resetDefaultButton_clicked</b>(<i></i>) | |
| 333 | |
| 334 <p> | |
| 335 Private slot to reset the configuration values to their default values. | |
| 336 </p> | |
| 337 <a NAME="PyrightCheckerDialog.on_restartButton_clicked" ID="PyrightCheckerDialog.on_restartButton_clicked"></a> | |
| 338 <h4>PyrightCheckerDialog.on_restartButton_clicked</h4> | |
| 339 <b>on_restartButton_clicked</b>(<i></i>) | |
| 340 | |
| 341 <p> | |
| 342 Private slot to restart the configured check. | |
| 343 </p> | |
| 344 <a NAME="PyrightCheckerDialog.on_resultList_itemActivated" ID="PyrightCheckerDialog.on_resultList_itemActivated"></a> | |
| 345 <h4>PyrightCheckerDialog.on_resultList_itemActivated</h4> | |
| 346 <b>on_resultList_itemActivated</b>(<i>item, column</i>) | |
| 347 | |
| 348 <p> | |
| 349 Private slot to handle the activation of an item. | |
| 350 </p> | |
| 351 <dl> | |
| 352 | |
| 353 <dt><i>item</i> (QTreeWidgetItem)</dt> | |
| 354 <dd> | |
| 355 reference to the activated item | |
| 356 </dd> | |
| 357 <dt><i>column</i> (int)</dt> | |
| 358 <dd> | |
| 359 column the item was activated in | |
| 360 </dd> | |
| 361 </dl> | |
| 362 <a NAME="PyrightCheckerDialog.on_showButton_clicked" ID="PyrightCheckerDialog.on_showButton_clicked"></a> | |
| 363 <h4>PyrightCheckerDialog.on_showButton_clicked</h4> | |
| 364 <b>on_showButton_clicked</b>(<i></i>) | |
| 365 | |
| 366 <p> | |
| 367 Private slot to handle the "Show" button press. | |
| 368 </p> | |
| 369 <a NAME="PyrightCheckerDialog.on_startButton_clicked" ID="PyrightCheckerDialog.on_startButton_clicked"></a> | |
| 370 <h4>PyrightCheckerDialog.on_startButton_clicked</h4> | |
| 371 <b>on_startButton_clicked</b>(<i></i>) | |
| 372 | |
| 373 <p> | |
| 374 Private slot to start the pyright type checking run. | |
| 375 </p> | |
| 376 <a NAME="PyrightCheckerDialog.on_storeDefaultButton_clicked" ID="PyrightCheckerDialog.on_storeDefaultButton_clicked"></a> | |
| 377 <h4>PyrightCheckerDialog.on_storeDefaultButton_clicked</h4> | |
| 378 <b>on_storeDefaultButton_clicked</b>(<i></i>) | |
| 379 | |
| 380 <p> | |
| 381 Private slot to store the current configuration values as | |
| 382 default values. | |
| 383 </p> | |
| 384 <a NAME="PyrightCheckerDialog.on_tomlButton_clicked" ID="PyrightCheckerDialog.on_tomlButton_clicked"></a> | |
| 385 <h4>PyrightCheckerDialog.on_tomlButton_clicked</h4> | |
| 386 <b>on_tomlButton_clicked</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Private slot to generate a TOML snippet of the current configuration. | |
| 390 </p> | |
| 391 <p> | |
| 392 Note: Only non-default values are included in this snippet. | |
| 393 </p> | |
| 394 <p> | |
| 395 The code snippet is copied to the clipboard and may be placed inside the | |
| 396 'pyproject.toml' file. | |
| 397 </p> | |
| 398 <a NAME="PyrightCheckerDialog.prepare" ID="PyrightCheckerDialog.prepare"></a> | |
| 399 <h4>PyrightCheckerDialog.prepare</h4> | |
| 400 <b>prepare</b>(<i>project</i>) | |
| 401 | |
| 402 <p> | |
| 403 Public method to prepare the dialog with a list of filenames. | |
| 404 </p> | |
| 405 <dl> | |
| 406 | |
| 407 <dt><i>project</i> (Project)</dt> | |
| 408 <dd> | |
| 409 reference to the project object | |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="PyrightCheckerDialog.start" ID="PyrightCheckerDialog.start"></a> | |
| 413 <h4>PyrightCheckerDialog.start</h4> | |
| 414 <b>start</b>(<i>files=None, save=False</i>) | |
| 415 | |
| 416 <p> | |
| 417 Public method to start a pyright type checking run. | |
| 418 </p> | |
| 419 <dl> | |
| 420 | |
| 421 <dt><i>files</i> (list of str (optional))</dt> | |
| 422 <dd> | |
| 423 list of files to be checked (defaults to None) | |
| 424 </dd> | |
| 425 <dt><i>save</i> (bool)</dt> | |
| 426 <dd> | |
| 427 flag indicating to save the given file/file list/directory | |
| 428 </dd> | |
| 429 </dl> | |
| 430 <div align="right"><a href="#top">Up</a></div> | |
| 431 <hr /> | |
| 432 </body></html> |
