Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.CodeFormatting.IsortFormattingDialog.html

src/eric7/Documentation/Source/eric7.CodeFormatting.IsortFormattingDialog.html

branch
eric7
changeset 9456
94c606dba5d8
parent 9454
f3cf935c0c66
child 9461
24c0c1066090
equal deleted inserted replaced
9455:5f138ee215a5 9456:94c606dba5d8
24 <td><a href="#IsortFormattingDialog">IsortFormattingDialog</a></td> 24 <td><a href="#IsortFormattingDialog">IsortFormattingDialog</a></td>
25 <td>Class implementing a dialog showing the isort code formatting progress and the results.</td> 25 <td>Class implementing a dialog showing the isort code formatting progress and the results.</td>
26 </tr> 26 </tr>
27 <tr> 27 <tr>
28 <td><a href="#IsortResult">IsortResult</a></td> 28 <td><a href="#IsortResult">IsortResult</a></td>
29 <td>Class containing the isort reformatting result data.</td> 29 <td>Class containing the isort result data.</td>
30 </tr> 30 </tr>
31 <tr> 31 <tr>
32 <td><a href="#IsortStatistics">IsortStatistics</a></td> 32 <td><a href="#IsortStatistics">IsortStatistics</a></td>
33 <td>Class containing the isort reformatting statistic data.</td> 33 <td>Class containing the isort statistic data.</td>
34 </tr> 34 </tr>
35 </table> 35 </table>
36 <h3>Functions</h3> 36 <h3>Functions</h3>
37 37
38 <table> 38 <table>
74 <tr> 74 <tr>
75 <td><a href="#IsortFormattingDialog.__finish">__finish</a></td> 75 <td><a href="#IsortFormattingDialog.__finish">__finish</a></td>
76 <td>Private method to perform some actions after the run was performed or canceled.</td> 76 <td>Private method to perform some actions after the run was performed or canceled.</td>
77 </tr> 77 </tr>
78 <tr> 78 <tr>
79 <td><a href="#IsortFormattingDialog.__formatManyFiles">__formatManyFiles</a></td>
80 <td>Private method to format the list of files according the configuration using multiple processes in parallel.</td>
81 </tr>
82 <tr>
83 <td><a href="#IsortFormattingDialog.__formatOneFile">__formatOneFile</a></td>
84 <td>Private method to format the list of files according the configuration.</td>
85 </tr>
86 <tr>
87 <td><a href="#IsortFormattingDialog.__handleIsortResult">__handleIsortResult</a></td> 79 <td><a href="#IsortFormattingDialog.__handleIsortResult">__handleIsortResult</a></td>
88 <td>Private method to handle an isort formatting result.</td> 80 <td>Private method to handle an isort sorting result.</td>
89 </tr> 81 </tr>
90 <tr> 82 <tr>
91 <td><a href="#IsortFormattingDialog.__performAction">__performAction</a></td> 83 <td><a href="#IsortFormattingDialog.__performAction">__performAction</a></td>
92 <td>Private method to execute the requested formatting action.</td> 84 <td>Private method to execute the requested sorting action.</td>
93 </tr> 85 </tr>
94 <tr> 86 <tr>
95 <td><a href="#IsortFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td> 87 <td><a href="#IsortFormattingDialog.__populateStatusFilterCombo">__populateStatusFilterCombo</a></td>
96 <td>Private method to populate the status filter combo box with allowed selections.</td> 88 <td>Private method to populate the status filter combo box with allowed selections.</td>
97 </tr> 89 </tr>
106 <tr> 98 <tr>
107 <td><a href="#IsortFormattingDialog.__sortImportsButtonClicked">__sortImportsButtonClicked</a></td> 99 <td><a href="#IsortFormattingDialog.__sortImportsButtonClicked">__sortImportsButtonClicked</a></td>
108 <td>Private slot handling the selection of the 'Sort Imports' button.</td> 100 <td>Private slot handling the selection of the 'Sort Imports' button.</td>
109 </tr> 101 </tr>
110 <tr> 102 <tr>
103 <td><a href="#IsortFormattingDialog.__sortManyFiles">__sortManyFiles</a></td>
104 <td>Private method to sort imports of the list of files according the configuration using multiple processes in parallel.</td>
105 </tr>
106 <tr>
107 <td><a href="#IsortFormattingDialog.__sortOneFile">__sortOneFile</a></td>
108 <td>Private method to sort the imports of the list of files according the configuration.</td>
109 </tr>
110 <tr>
111 <td><a href="#IsortFormattingDialog.__updateStatistics">__updateStatistics</a></td> 111 <td><a href="#IsortFormattingDialog.__updateStatistics">__updateStatistics</a></td>
112 <td>Private method to update the statistics about the recent formatting run and make them visible.</td> 112 <td>Private method to update the statistics about the recent sorting run and make them visible.</td>
113 </tr> 113 </tr>
114 <tr> 114 <tr>
115 <td><a href="#IsortFormattingDialog.closeEvent">closeEvent</a></td> 115 <td><a href="#IsortFormattingDialog.closeEvent">closeEvent</a></td>
116 <td>Protected slot implementing a close event handler.</td> 116 <td>Protected slot implementing a close event handler.</td>
117 </tr> 117 </tr>
139 <tr> 139 <tr>
140 <td><a href="#IsortFormattingDialog.__isortSortFile">__isortSortFile</a></td> 140 <td><a href="#IsortFormattingDialog.__isortSortFile">__isortSortFile</a></td>
141 <td>Static method to sort the import statements of a file.</td> 141 <td>Static method to sort the import statements of a file.</td>
142 </tr> 142 </tr>
143 <tr> 143 <tr>
144 <td><a href="#IsortFormattingDialog.formattingWorkerTask">formattingWorkerTask</a></td> 144 <td><a href="#IsortFormattingDialog.sortingWorkerTask">sortingWorkerTask</a></td>
145 <td>Static method acting as the parallel worker for the formatting task.</td> 145 <td>Static method acting as the parallel worker for the formatting task.</td>
146 </tr> 146 </tr>
147 </table> 147 </table>
148 148
149 <a NAME="IsortFormattingDialog.__init__" ID="IsortFormattingDialog.__init__"></a> 149 <a NAME="IsortFormattingDialog.__init__" ID="IsortFormattingDialog.__init__"></a>
208 <b>__finish</b>(<i></i>) 208 <b>__finish</b>(<i></i>)
209 209
210 <p> 210 <p>
211 Private method to perform some actions after the run was performed or canceled. 211 Private method to perform some actions after the run was performed or canceled.
212 </p> 212 </p>
213 <a NAME="IsortFormattingDialog.__formatManyFiles" ID="IsortFormattingDialog.__formatManyFiles"></a>
214 <h4>IsortFormattingDialog.__formatManyFiles</h4>
215 <b>__formatManyFiles</b>(<i>files</i>)
216
217 <p>
218 Private method to format the list of files according the configuration using
219 multiple processes in parallel.
220 </p>
221 <dl>
222
223 <dt><i>files</i> (list of str)</dt>
224 <dd>
225 list of files to be processed
226 </dd>
227 </dl>
228 <a NAME="IsortFormattingDialog.__formatOneFile" ID="IsortFormattingDialog.__formatOneFile"></a>
229 <h4>IsortFormattingDialog.__formatOneFile</h4>
230 <b>__formatOneFile</b>(<i>file</i>)
231
232 <p>
233 Private method to format the list of files according the configuration.
234 </p>
235 <dl>
236
237 <dt><i>file</i> (str)</dt>
238 <dd>
239 name of the file to be processed
240 </dd>
241 </dl>
242 <a NAME="IsortFormattingDialog.__handleIsortResult" ID="IsortFormattingDialog.__handleIsortResult"></a> 213 <a NAME="IsortFormattingDialog.__handleIsortResult" ID="IsortFormattingDialog.__handleIsortResult"></a>
243 <h4>IsortFormattingDialog.__handleIsortResult</h4> 214 <h4>IsortFormattingDialog.__handleIsortResult</h4>
244 <b>__handleIsortResult</b>(<i>filename, status, data=""</i>) 215 <b>__handleIsortResult</b>(<i>filename, status, data=""</i>)
245 216
246 <p> 217 <p>
247 Private method to handle an isort formatting result. 218 Private method to handle an isort sorting result.
248 </p> 219 </p>
249 <dl> 220 <dl>
250 221
251 <dt><i>filename</i> (str)</dt> 222 <dt><i>filename</i> (str)</dt>
252 <dd> 223 <dd>
265 <a NAME="IsortFormattingDialog.__performAction" ID="IsortFormattingDialog.__performAction"></a> 236 <a NAME="IsortFormattingDialog.__performAction" ID="IsortFormattingDialog.__performAction"></a>
266 <h4>IsortFormattingDialog.__performAction</h4> 237 <h4>IsortFormattingDialog.__performAction</h4>
267 <b>__performAction</b>(<i></i>) 238 <b>__performAction</b>(<i></i>)
268 239
269 <p> 240 <p>
270 Private method to execute the requested formatting action. 241 Private method to execute the requested sorting action.
271 </p> 242 </p>
272 <a NAME="IsortFormattingDialog.__populateStatusFilterCombo" ID="IsortFormattingDialog.__populateStatusFilterCombo"></a> 243 <a NAME="IsortFormattingDialog.__populateStatusFilterCombo" ID="IsortFormattingDialog.__populateStatusFilterCombo"></a>
273 <h4>IsortFormattingDialog.__populateStatusFilterCombo</h4> 244 <h4>IsortFormattingDialog.__populateStatusFilterCombo</h4>
274 <b>__populateStatusFilterCombo</b>(<i></i>) 245 <b>__populateStatusFilterCombo</b>(<i></i>)
275 246
295 <b>__sortImportsButtonClicked</b>(<i></i>) 266 <b>__sortImportsButtonClicked</b>(<i></i>)
296 267
297 <p> 268 <p>
298 Private slot handling the selection of the 'Sort Imports' button. 269 Private slot handling the selection of the 'Sort Imports' button.
299 </p> 270 </p>
271 <a NAME="IsortFormattingDialog.__sortManyFiles" ID="IsortFormattingDialog.__sortManyFiles"></a>
272 <h4>IsortFormattingDialog.__sortManyFiles</h4>
273 <b>__sortManyFiles</b>(<i>files</i>)
274
275 <p>
276 Private method to sort imports of the list of files according the configuration
277 using multiple processes in parallel.
278 </p>
279 <dl>
280
281 <dt><i>files</i> (list of str)</dt>
282 <dd>
283 list of files to be processed
284 </dd>
285 </dl>
286 <a NAME="IsortFormattingDialog.__sortOneFile" ID="IsortFormattingDialog.__sortOneFile"></a>
287 <h4>IsortFormattingDialog.__sortOneFile</h4>
288 <b>__sortOneFile</b>(<i>file</i>)
289
290 <p>
291 Private method to sort the imports of the list of files according the
292 configuration.
293 </p>
294 <dl>
295
296 <dt><i>file</i> (str)</dt>
297 <dd>
298 name of the file to be processed
299 </dd>
300 </dl>
300 <a NAME="IsortFormattingDialog.__updateStatistics" ID="IsortFormattingDialog.__updateStatistics"></a> 301 <a NAME="IsortFormattingDialog.__updateStatistics" ID="IsortFormattingDialog.__updateStatistics"></a>
301 <h4>IsortFormattingDialog.__updateStatistics</h4> 302 <h4>IsortFormattingDialog.__updateStatistics</h4>
302 <b>__updateStatistics</b>(<i></i>) 303 <b>__updateStatistics</b>(<i></i>)
303 304
304 <p> 305 <p>
305 Private method to update the statistics about the recent formatting run and 306 Private method to update the statistics about the recent sorting run and
306 make them visible. 307 make them visible.
307 </p> 308 </p>
308 <a NAME="IsortFormattingDialog.closeEvent" ID="IsortFormattingDialog.closeEvent"></a> 309 <a NAME="IsortFormattingDialog.closeEvent" ID="IsortFormattingDialog.closeEvent"></a>
309 <h4>IsortFormattingDialog.closeEvent</h4> 310 <h4>IsortFormattingDialog.closeEvent</h4>
310 <b>closeEvent</b>(<i>evt</i>) 311 <b>closeEvent</b>(<i>evt</i>)
428 <dt>Return Type:</dt> 429 <dt>Return Type:</dt>
429 <dd> 430 <dd>
430 IsortResult 431 IsortResult
431 </dd> 432 </dd>
432 </dl> 433 </dl>
433 <a NAME="IsortFormattingDialog.formattingWorkerTask" ID="IsortFormattingDialog.formattingWorkerTask"></a> 434 <a NAME="IsortFormattingDialog.sortingWorkerTask" ID="IsortFormattingDialog.sortingWorkerTask"></a>
434 <h4>IsortFormattingDialog.formattingWorkerTask (static)</h4> 435 <h4>IsortFormattingDialog.sortingWorkerTask (static)</h4>
435 <b>formattingWorkerTask</b>(<i>outputQueue, isortConfig</i>) 436 <b>sortingWorkerTask</b>(<i>outputQueue, isortConfig</i>)
436 437
437 <p> 438 <p>
438 Static method acting as the parallel worker for the formatting task. 439 Static method acting as the parallel worker for the formatting task.
439 </p> 440 </p>
440 <dl> 441 <dl>
457 <hr /> 458 <hr />
458 <a NAME="IsortResult" ID="IsortResult"></a> 459 <a NAME="IsortResult" ID="IsortResult"></a>
459 <h2>IsortResult</h2> 460 <h2>IsortResult</h2>
460 461
461 <p> 462 <p>
462 Class containing the isort reformatting result data. 463 Class containing the isort result data.
463 </p> 464 </p>
464 <h3>Derived from</h3> 465 <h3>Derived from</h3>
465 None 466 None
466 <h3>Class Attributes</h3> 467 <h3>Class Attributes</h3>
467 468
489 <hr /> 490 <hr />
490 <a NAME="IsortStatistics" ID="IsortStatistics"></a> 491 <a NAME="IsortStatistics" ID="IsortStatistics"></a>
491 <h2>IsortStatistics</h2> 492 <h2>IsortStatistics</h2>
492 493
493 <p> 494 <p>
494 Class containing the isort reformatting statistic data. 495 Class containing the isort statistic data.
495 </p> 496 </p>
496 <h3>Derived from</h3> 497 <h3>Derived from</h3>
497 None 498 None
498 <h3>Class Attributes</h3> 499 <h3>Class Attributes</h3>
499 500

Mercurial Repository: eric

eric ide

mercurial