31 <tr> |
29 <tr> |
32 <td><a href="#IsortStatistics">IsortStatistics</a></td> |
30 <td><a href="#IsortStatistics">IsortStatistics</a></td> |
33 <td>Class containing the isort statistic data.</td> |
31 <td>Class containing the isort statistic data.</td> |
34 </tr> |
32 </tr> |
35 </table> |
33 </table> |
|
34 |
36 <h3>Functions</h3> |
35 <h3>Functions</h3> |
37 |
36 <table> |
38 <table> |
37 <tr><td>None</td></tr> |
39 <tr><td>None</td></tr> |
38 </table> |
40 </table> |
39 |
41 <hr /> |
40 <hr /> |
42 <hr /> |
41 <hr /> |
43 <a NAME="IsortFormattingDialog" ID="IsortFormattingDialog"></a> |
42 <a NAME="IsortFormattingDialog" ID="IsortFormattingDialog"></a> |
44 <h2>IsortFormattingDialog</h2> |
43 <h2>IsortFormattingDialog</h2> |
45 |
|
46 <p> |
44 <p> |
47 Class implementing a dialog showing the isort code formatting progress and the |
45 Class implementing a dialog showing the isort code formatting progress and the |
48 results. |
46 results. |
49 </p> |
47 </p> |
|
48 |
50 <h3>Derived from</h3> |
49 <h3>Derived from</h3> |
51 QDialog, Ui_IsortFormattingDialog |
50 QDialog, Ui_IsortFormattingDialog |
52 <h3>Class Attributes</h3> |
51 <h3>Class Attributes</h3> |
53 |
52 <table> |
54 <table> |
53 <tr><td>DataRole</td></tr> |
55 <tr><td>DataRole</td></tr><tr><td>DataTypeRole</td></tr><tr><td>FileNameColumn</td></tr><tr><td>FileNameRole</td></tr><tr><td>StatusColumn</td></tr><tr><td>StatusRole</td></tr> |
54 <tr><td>DataTypeRole</td></tr> |
56 </table> |
55 <tr><td>FileNameColumn</td></tr> |
|
56 <tr><td>FileNameRole</td></tr> |
|
57 <tr><td>StatusColumn</td></tr> |
|
58 <tr><td>StatusRole</td></tr> |
|
59 </table> |
|
60 |
57 <h3>Class Methods</h3> |
61 <h3>Class Methods</h3> |
58 |
62 <table> |
59 <table> |
63 <tr><td>None</td></tr> |
60 <tr><td>None</td></tr> |
64 </table> |
61 </table> |
65 |
62 <h3>Methods</h3> |
66 <h3>Methods</h3> |
63 |
67 <table> |
64 <table> |
|
65 |
|
66 <tr> |
68 <tr> |
67 <td><a href="#IsortFormattingDialog.__init__">IsortFormattingDialog</a></td> |
69 <td><a href="#IsortFormattingDialog.__init__">IsortFormattingDialog</a></td> |
68 <td>Constructor</td> |
70 <td>Constructor</td> |
69 </tr> |
71 </tr> |
70 <tr> |
72 <tr> |
234 </dd> |
236 </dd> |
235 </dl> |
237 </dl> |
236 <a NAME="IsortFormattingDialog.__performAction" ID="IsortFormattingDialog.__performAction"></a> |
238 <a NAME="IsortFormattingDialog.__performAction" ID="IsortFormattingDialog.__performAction"></a> |
237 <h4>IsortFormattingDialog.__performAction</h4> |
239 <h4>IsortFormattingDialog.__performAction</h4> |
238 <b>__performAction</b>(<i></i>) |
240 <b>__performAction</b>(<i></i>) |
239 |
|
240 <p> |
241 <p> |
241 Private method to execute the requested sorting action. |
242 Private method to execute the requested sorting action. |
242 </p> |
243 </p> |
|
244 |
243 <a NAME="IsortFormattingDialog.__populateStatusFilterCombo" ID="IsortFormattingDialog.__populateStatusFilterCombo"></a> |
245 <a NAME="IsortFormattingDialog.__populateStatusFilterCombo" ID="IsortFormattingDialog.__populateStatusFilterCombo"></a> |
244 <h4>IsortFormattingDialog.__populateStatusFilterCombo</h4> |
246 <h4>IsortFormattingDialog.__populateStatusFilterCombo</h4> |
245 <b>__populateStatusFilterCombo</b>(<i></i>) |
247 <b>__populateStatusFilterCombo</b>(<i></i>) |
246 |
|
247 <p> |
248 <p> |
248 Private method to populate the status filter combo box with allowed selections. |
249 Private method to populate the status filter combo box with allowed selections. |
249 </p> |
250 </p> |
|
251 |
250 <a NAME="IsortFormattingDialog.__resizeColumns" ID="IsortFormattingDialog.__resizeColumns"></a> |
252 <a NAME="IsortFormattingDialog.__resizeColumns" ID="IsortFormattingDialog.__resizeColumns"></a> |
251 <h4>IsortFormattingDialog.__resizeColumns</h4> |
253 <h4>IsortFormattingDialog.__resizeColumns</h4> |
252 <b>__resizeColumns</b>(<i></i>) |
254 <b>__resizeColumns</b>(<i></i>) |
253 |
|
254 <p> |
255 <p> |
255 Private method to resize the columns of the result list. |
256 Private method to resize the columns of the result list. |
256 </p> |
257 </p> |
|
258 |
257 <a NAME="IsortFormattingDialog.__resort" ID="IsortFormattingDialog.__resort"></a> |
259 <a NAME="IsortFormattingDialog.__resort" ID="IsortFormattingDialog.__resort"></a> |
258 <h4>IsortFormattingDialog.__resort</h4> |
260 <h4>IsortFormattingDialog.__resort</h4> |
259 <b>__resort</b>(<i></i>) |
261 <b>__resort</b>(<i></i>) |
260 |
|
261 <p> |
262 <p> |
262 Private method to resort the result list. |
263 Private method to resort the result list. |
263 </p> |
264 </p> |
|
265 |
264 <a NAME="IsortFormattingDialog.__sortImportsButtonClicked" ID="IsortFormattingDialog.__sortImportsButtonClicked"></a> |
266 <a NAME="IsortFormattingDialog.__sortImportsButtonClicked" ID="IsortFormattingDialog.__sortImportsButtonClicked"></a> |
265 <h4>IsortFormattingDialog.__sortImportsButtonClicked</h4> |
267 <h4>IsortFormattingDialog.__sortImportsButtonClicked</h4> |
266 <b>__sortImportsButtonClicked</b>(<i></i>) |
268 <b>__sortImportsButtonClicked</b>(<i></i>) |
267 |
|
268 <p> |
269 <p> |
269 Private slot handling the selection of the 'Sort Imports' button. |
270 Private slot handling the selection of the 'Sort Imports' button. |
270 </p> |
271 </p> |
|
272 |
271 <a NAME="IsortFormattingDialog.__sortManyFiles" ID="IsortFormattingDialog.__sortManyFiles"></a> |
273 <a NAME="IsortFormattingDialog.__sortManyFiles" ID="IsortFormattingDialog.__sortManyFiles"></a> |
272 <h4>IsortFormattingDialog.__sortManyFiles</h4> |
274 <h4>IsortFormattingDialog.__sortManyFiles</h4> |
273 <b>__sortManyFiles</b>(<i>files</i>) |
275 <b>__sortManyFiles</b>(<i>files</i>) |
274 |
|
275 <p> |
276 <p> |
276 Private method to sort imports of the list of files according the configuration |
277 Private method to sort imports of the list of files according the configuration |
277 using multiple processes in parallel. |
278 using multiple processes in parallel. |
278 </p> |
279 </p> |
|
280 |
279 <dl> |
281 <dl> |
280 |
282 |
281 <dt><i>files</i> (list of str)</dt> |
283 <dt><i>files</i> (list of str)</dt> |
282 <dd> |
284 <dd> |
283 list of files to be processed |
285 list of files to be processed |
284 </dd> |
286 </dd> |
285 </dl> |
287 </dl> |
286 <a NAME="IsortFormattingDialog.__sortOneFile" ID="IsortFormattingDialog.__sortOneFile"></a> |
288 <a NAME="IsortFormattingDialog.__sortOneFile" ID="IsortFormattingDialog.__sortOneFile"></a> |
287 <h4>IsortFormattingDialog.__sortOneFile</h4> |
289 <h4>IsortFormattingDialog.__sortOneFile</h4> |
288 <b>__sortOneFile</b>(<i>file</i>) |
290 <b>__sortOneFile</b>(<i>file</i>) |
289 |
|
290 <p> |
291 <p> |
291 Private method to sort the imports of the list of files according the |
292 Private method to sort the imports of the list of files according the |
292 configuration. |
293 configuration. |
293 </p> |
294 </p> |
|
295 |
294 <dl> |
296 <dl> |
295 |
297 |
296 <dt><i>file</i> (str)</dt> |
298 <dt><i>file</i> (str)</dt> |
297 <dd> |
299 <dd> |
298 name of the file to be processed |
300 name of the file to be processed |
299 </dd> |
301 </dd> |
300 </dl> |
302 </dl> |
301 <a NAME="IsortFormattingDialog.__updateStatistics" ID="IsortFormattingDialog.__updateStatistics"></a> |
303 <a NAME="IsortFormattingDialog.__updateStatistics" ID="IsortFormattingDialog.__updateStatistics"></a> |
302 <h4>IsortFormattingDialog.__updateStatistics</h4> |
304 <h4>IsortFormattingDialog.__updateStatistics</h4> |
303 <b>__updateStatistics</b>(<i></i>) |
305 <b>__updateStatistics</b>(<i></i>) |
304 |
|
305 <p> |
306 <p> |
306 Private method to update the statistics about the recent sorting run and |
307 Private method to update the statistics about the recent sorting run and |
307 make them visible. |
308 make them visible. |
308 </p> |
309 </p> |
|
310 |
309 <a NAME="IsortFormattingDialog.closeEvent" ID="IsortFormattingDialog.closeEvent"></a> |
311 <a NAME="IsortFormattingDialog.closeEvent" ID="IsortFormattingDialog.closeEvent"></a> |
310 <h4>IsortFormattingDialog.closeEvent</h4> |
312 <h4>IsortFormattingDialog.closeEvent</h4> |
311 <b>closeEvent</b>(<i>evt</i>) |
313 <b>closeEvent</b>(<i>evt</i>) |
312 |
|
313 <p> |
314 <p> |
314 Protected slot implementing a close event handler. |
315 Protected slot implementing a close event handler. |
315 </p> |
316 </p> |
|
317 |
316 <dl> |
318 <dl> |
317 |
319 |
318 <dt><i>evt</i> (QCloseEvent)</dt> |
320 <dt><i>evt</i> (QCloseEvent)</dt> |
319 <dd> |
321 <dd> |
320 reference to the close event |
322 reference to the close event |
321 </dd> |
323 </dd> |
322 </dl> |
324 </dl> |
323 <a NAME="IsortFormattingDialog.on_buttonBox_clicked" ID="IsortFormattingDialog.on_buttonBox_clicked"></a> |
325 <a NAME="IsortFormattingDialog.on_buttonBox_clicked" ID="IsortFormattingDialog.on_buttonBox_clicked"></a> |
324 <h4>IsortFormattingDialog.on_buttonBox_clicked</h4> |
326 <h4>IsortFormattingDialog.on_buttonBox_clicked</h4> |
325 <b>on_buttonBox_clicked</b>(<i>button</i>) |
327 <b>on_buttonBox_clicked</b>(<i>button</i>) |
326 |
|
327 <p> |
328 <p> |
328 Private slot to handle button presses of the dialog buttons. |
329 Private slot to handle button presses of the dialog buttons. |
329 </p> |
330 </p> |
|
331 |
330 <dl> |
332 <dl> |
331 |
333 |
332 <dt><i>button</i> (QAbstractButton)</dt> |
334 <dt><i>button</i> (QAbstractButton)</dt> |
333 <dd> |
335 <dd> |
334 reference to the pressed button |
336 reference to the pressed button |
335 </dd> |
337 </dd> |
336 </dl> |
338 </dl> |
337 <a NAME="IsortFormattingDialog.on_resultsList_itemDoubleClicked" ID="IsortFormattingDialog.on_resultsList_itemDoubleClicked"></a> |
339 <a NAME="IsortFormattingDialog.on_resultsList_itemDoubleClicked" ID="IsortFormattingDialog.on_resultsList_itemDoubleClicked"></a> |
338 <h4>IsortFormattingDialog.on_resultsList_itemDoubleClicked</h4> |
340 <h4>IsortFormattingDialog.on_resultsList_itemDoubleClicked</h4> |
339 <b>on_resultsList_itemDoubleClicked</b>(<i>item, column</i>) |
341 <b>on_resultsList_itemDoubleClicked</b>(<i>item, column</i>) |
340 |
|
341 <p> |
342 <p> |
342 Private slot handling a double click of a result item. |
343 Private slot handling a double click of a result item. |
343 </p> |
344 </p> |
|
345 |
344 <dl> |
346 <dl> |
345 |
347 |
346 <dt><i>item</i> (QTreeWidgetItem)</dt> |
348 <dt><i>item</i> (QTreeWidgetItem)</dt> |
347 <dd> |
349 <dd> |
348 reference to the double clicked item |
350 reference to the double clicked item |
353 </dd> |
355 </dd> |
354 </dl> |
356 </dl> |
355 <a NAME="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged" ID="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged"></a> |
357 <a NAME="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged" ID="IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged"></a> |
356 <h4>IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged</h4> |
358 <h4>IsortFormattingDialog.on_statusFilterComboBox_currentTextChanged</h4> |
357 <b>on_statusFilterComboBox_currentTextChanged</b>(<i>status</i>) |
359 <b>on_statusFilterComboBox_currentTextChanged</b>(<i>status</i>) |
358 |
|
359 <p> |
360 <p> |
360 Private slot handling the selection of a status for items to be shown. |
361 Private slot handling the selection of a status for items to be shown. |
361 </p> |
362 </p> |
|
363 |
362 <dl> |
364 <dl> |
363 |
365 |
364 <dt><i>status</i> (str)</dt> |
366 <dt><i>status</i> (str)</dt> |
365 <dd> |
367 <dd> |
366 selected status |
368 selected status |
367 </dd> |
369 </dd> |
368 </dl> |
370 </dl> |
369 <a NAME="IsortFormattingDialog.__isortCheckFile" ID="IsortFormattingDialog.__isortCheckFile"></a> |
371 <a NAME="IsortFormattingDialog.__isortCheckFile" ID="IsortFormattingDialog.__isortCheckFile"></a> |
370 <h4>IsortFormattingDialog.__isortCheckFile (static)</h4> |
372 <h4>IsortFormattingDialog.__isortCheckFile (static)</h4> |
371 <b>__isortCheckFile</b>(<i>isortConfig, withDiff=True</i>) |
373 <b>__isortCheckFile</b>(<i>isortConfig, withDiff=True</i>) |
372 |
|
373 <p> |
374 <p> |
374 Static method to check, if a file's import statements need to be changed. |
375 Static method to check, if a file's import statements need to be changed. |
375 </p> |
376 </p> |
|
377 |
376 <dl> |
378 <dl> |
377 |
379 |
378 <dt><i>filename</i> (str)</dt> |
380 <dt><i>filename</i> (str)</dt> |
379 <dd> |
381 <dd> |
380 name of the file to be processed |
382 name of the file to be processed |
456 <div align="right"><a href="#top">Up</a></div> |
458 <div align="right"><a href="#top">Up</a></div> |
457 <hr /> |
459 <hr /> |
458 <hr /> |
460 <hr /> |
459 <a NAME="IsortResult" ID="IsortResult"></a> |
461 <a NAME="IsortResult" ID="IsortResult"></a> |
460 <h2>IsortResult</h2> |
462 <h2>IsortResult</h2> |
461 |
|
462 <p> |
463 <p> |
463 Class containing the isort result data. |
464 Class containing the isort result data. |
464 </p> |
465 </p> |
|
466 |
465 <h3>Derived from</h3> |
467 <h3>Derived from</h3> |
466 None |
468 None |
467 <h3>Class Attributes</h3> |
469 <h3>Class Attributes</h3> |
468 |
470 <table> |
469 <table> |
471 <tr><td>data</td></tr> |
470 <tr><td>data</td></tr><tr><td>filename</td></tr><tr><td>status</td></tr> |
472 <tr><td>filename</td></tr> |
471 </table> |
473 <tr><td>status</td></tr> |
|
474 </table> |
|
475 |
472 <h3>Class Methods</h3> |
476 <h3>Class Methods</h3> |
473 |
477 <table> |
474 <table> |
478 <tr><td>None</td></tr> |
475 <tr><td>None</td></tr> |
479 </table> |
476 </table> |
480 |
477 <h3>Methods</h3> |
481 <h3>Methods</h3> |
478 |
482 <table> |
479 <table> |
483 <tr><td>None</td></tr> |
480 <tr><td>None</td></tr> |
484 </table> |
481 </table> |
485 |
482 <h3>Static Methods</h3> |
486 <h3>Static Methods</h3> |
483 |
487 <table> |
484 <table> |
488 <tr><td>None</td></tr> |
485 <tr><td>None</td></tr> |
489 </table> |
486 </table> |
490 |
487 |
491 |
488 <div align="right"><a href="#top">Up</a></div> |
492 <div align="right"><a href="#top">Up</a></div> |
489 <hr /> |
493 <hr /> |
490 <hr /> |
494 <hr /> |
491 <a NAME="IsortStatistics" ID="IsortStatistics"></a> |
495 <a NAME="IsortStatistics" ID="IsortStatistics"></a> |
492 <h2>IsortStatistics</h2> |
496 <h2>IsortStatistics</h2> |
493 |
|
494 <p> |
497 <p> |
495 Class containing the isort statistic data. |
498 Class containing the isort statistic data. |
496 </p> |
499 </p> |
|
500 |
497 <h3>Derived from</h3> |
501 <h3>Derived from</h3> |
498 None |
502 None |
499 <h3>Class Attributes</h3> |
503 <h3>Class Attributes</h3> |
500 |
504 <table> |
501 <table> |
505 <tr><td>changeCount</td></tr> |
502 <tr><td>changeCount</td></tr><tr><td>failureCount</td></tr><tr><td>processedCount</td></tr><tr><td>sameCount</td></tr><tr><td>skippedCount</td></tr> |
506 <tr><td>failureCount</td></tr> |
503 </table> |
507 <tr><td>processedCount</td></tr> |
|
508 <tr><td>sameCount</td></tr> |
|
509 <tr><td>skippedCount</td></tr> |
|
510 </table> |
|
511 |
504 <h3>Class Methods</h3> |
512 <h3>Class Methods</h3> |
505 |
513 <table> |
506 <table> |
514 <tr><td>None</td></tr> |
507 <tr><td>None</td></tr> |
515 </table> |
508 </table> |
516 |
509 <h3>Methods</h3> |
517 <h3>Methods</h3> |
510 |
518 <table> |
511 <table> |
519 <tr><td>None</td></tr> |
512 <tr><td>None</td></tr> |
520 </table> |
513 </table> |
521 |
514 <h3>Static Methods</h3> |
522 <h3>Static Methods</h3> |
515 |
523 <table> |
516 <table> |
524 <tr><td>None</td></tr> |
517 <tr><td>None</td></tr> |
525 </table> |
518 </table> |
526 |
519 |
527 |
520 <div align="right"><a href="#top">Up</a></div> |
528 <div align="right"><a href="#top">Up</a></div> |
521 <hr /> |
529 <hr /> |
522 </body></html> |
530 </body></html> |