diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html
--- a/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.CodeFormatting.BlackFormattingDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CodeFormatting.BlackFormattingDialog</h1>
-
<p>
Module implementing a dialog showing the Black code formatting progress and the results.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#BlackFormattingDialog">BlackFormattingDialog</a></td>
<td>Class implementing a dialog showing the Black code formatting progress and the results.</td>
@@ -41,36 +39,40 @@
<td>Class containing the reformatting statistic data.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="BlackFormattingDialog" ID="BlackFormattingDialog"></a>
<h2>BlackFormattingDialog</h2>
-
<p>
Class implementing a dialog showing the Black code formatting progress and the
results.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_BlackFormattingDialog
<h3>Class Attributes</h3>
+<table>
+<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>
+</table>
-<table>
-<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>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BlackFormattingDialog.__init__">BlackFormattingDialog</a></td>
<td>Constructor</td>
@@ -136,10 +138,9 @@
<td>Private slot handling the selection of a status for items to be shown.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
-
<tr>
<td><a href="#BlackFormattingDialog.__diffFormatFile">__diffFormatFile</a></td>
<td>Static method to check, if the given files need to be reformatted, and generate a unified diff.</td>
@@ -150,13 +151,14 @@
</tr>
</table>
+
<a NAME="BlackFormattingDialog.__init__" ID="BlackFormattingDialog.__init__"></a>
<h4>BlackFormattingDialog (Constructor)</h4>
<b>BlackFormattingDialog</b>(<i>configuration, filesList, project=None, action=BlackFormattingAction.Format, parent=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>configuration</i> (dict)</dt>
@@ -183,11 +185,11 @@
<a NAME="BlackFormattingDialog.__filterFiles" ID="BlackFormattingDialog.__filterFiles"></a>
<h4>BlackFormattingDialog.__filterFiles</h4>
<b>__filterFiles</b>(<i>filesList</i>)
-
<p>
Private method to filter the given list of files according the
configuration parameters.
</p>
+
<dl>
<dt><i>filesList</i> (list of str)</dt>
@@ -210,25 +212,25 @@
<a NAME="BlackFormattingDialog.__finish" ID="BlackFormattingDialog.__finish"></a>
<h4>BlackFormattingDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private method to perform some actions after the run was performed or canceled.
</p>
+
<a NAME="BlackFormattingDialog.__formatButtonClicked" ID="BlackFormattingDialog.__formatButtonClicked"></a>
<h4>BlackFormattingDialog.__formatButtonClicked</h4>
<b>__formatButtonClicked</b>(<i></i>)
-
<p>
Private slot handling the selection of the 'Format Code' button.
</p>
+
<a NAME="BlackFormattingDialog.__formatManyFiles" ID="BlackFormattingDialog.__formatManyFiles"></a>
<h4>BlackFormattingDialog.__formatManyFiles</h4>
<b>__formatManyFiles</b>(<i>files</i>)
-
<p>
Private method to format the list of files according the configuration using
multiple processes in parallel.
</p>
+
<dl>
<dt><i>files</i> (list of str)</dt>
@@ -239,10 +241,10 @@
<a NAME="BlackFormattingDialog.__formatOneFile" ID="BlackFormattingDialog.__formatOneFile"></a>
<h4>BlackFormattingDialog.__formatOneFile</h4>
<b>__formatOneFile</b>(<i>file</i>)
-
<p>
Private method to format the list of files according the configuration.
</p>
+
<dl>
<dt><i>file</i> (str)</dt>
@@ -253,10 +255,10 @@
<a NAME="BlackFormattingDialog.__handleBlackFormattingResult" ID="BlackFormattingDialog.__handleBlackFormattingResult"></a>
<h4>BlackFormattingDialog.__handleBlackFormattingResult</h4>
<b>__handleBlackFormattingResult</b>(<i>status, filename, data</i>)
-
<p>
Private slot to handle the result of a black reformatting action.
</p>
+
<dl>
<dt><i>status</i> (str)</dt>
@@ -276,46 +278,46 @@
<a NAME="BlackFormattingDialog.__performAction" ID="BlackFormattingDialog.__performAction"></a>
<h4>BlackFormattingDialog.__performAction</h4>
<b>__performAction</b>(<i></i>)
-
<p>
Private method to execute the requested formatting action.
</p>
+
<a NAME="BlackFormattingDialog.__populateStatusFilterCombo" ID="BlackFormattingDialog.__populateStatusFilterCombo"></a>
<h4>BlackFormattingDialog.__populateStatusFilterCombo</h4>
<b>__populateStatusFilterCombo</b>(<i></i>)
-
<p>
Private method to populate the status filter combo box with allowed selections.
</p>
+
<a NAME="BlackFormattingDialog.__resizeColumns" ID="BlackFormattingDialog.__resizeColumns"></a>
<h4>BlackFormattingDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
-
<p>
Private method to resize the columns of the result list.
</p>
+
<a NAME="BlackFormattingDialog.__resort" ID="BlackFormattingDialog.__resort"></a>
<h4>BlackFormattingDialog.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the result list.
</p>
+
<a NAME="BlackFormattingDialog.__updateStatistics" ID="BlackFormattingDialog.__updateStatistics"></a>
<h4>BlackFormattingDialog.__updateStatistics</h4>
<b>__updateStatistics</b>(<i></i>)
-
<p>
Private method to update the statistics about the recent formatting run and
make them visible.
</p>
+
<a NAME="BlackFormattingDialog.closeEvent" ID="BlackFormattingDialog.closeEvent"></a>
<h4>BlackFormattingDialog.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)
-
<p>
Protected slot implementing a close event handler.
</p>
+
<dl>
<dt><i>evt</i> (QCloseEvent)</dt>
@@ -326,10 +328,10 @@
<a NAME="BlackFormattingDialog.on_buttonBox_clicked" ID="BlackFormattingDialog.on_buttonBox_clicked"></a>
<h4>BlackFormattingDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot to handle button presses of the dialog buttons.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -340,10 +342,10 @@
<a NAME="BlackFormattingDialog.on_resultsList_itemDoubleClicked" ID="BlackFormattingDialog.on_resultsList_itemDoubleClicked"></a>
<h4>BlackFormattingDialog.on_resultsList_itemDoubleClicked</h4>
<b>on_resultsList_itemDoubleClicked</b>(<i>item, column</i>)
-
<p>
Private slot handling a double click of a result item.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -358,10 +360,10 @@
<a NAME="BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged" ID="BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged"></a>
<h4>BlackFormattingDialog.on_statusFilterComboBox_currentTextChanged</h4>
<b>on_statusFilterComboBox_currentTextChanged</b>(<i>status</i>)
-
<p>
Private slot handling the selection of a status for items to be shown.
</p>
+
<dl>
<dt><i>status</i> (str)</dt>
@@ -372,11 +374,11 @@
<a NAME="BlackFormattingDialog.__diffFormatFile" ID="BlackFormattingDialog.__diffFormatFile"></a>
<h4>BlackFormattingDialog.__diffFormatFile (static)</h4>
<b>__diffFormatFile</b>(<i>fast, mode, report, relSrc=""</i>)
-
<p>
Static method to check, if the given files need to be reformatted, and generate
a unified diff.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path)</dt>
@@ -403,10 +405,10 @@
<a NAME="BlackFormattingDialog.formattingWorkerTask" ID="BlackFormattingDialog.formattingWorkerTask"></a>
<h4>BlackFormattingDialog.formattingWorkerTask (static)</h4>
<b>formattingWorkerTask</b>(<i>outputQueue, config</i>)
-
<p>
Static method acting as the parallel worker for the formatting task.
</p>
+
<dl>
<dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
@@ -427,26 +429,24 @@
<hr />
<a NAME="BlackMultiprocessingReport" ID="BlackMultiprocessingReport"></a>
<h2>BlackMultiprocessingReport</h2>
-
<p>
Class extending the black Report to work with multiprocessing.
</p>
+
<h3>Derived from</h3>
black.Report
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BlackMultiprocessingReport.__init__">BlackMultiprocessingReport</a></td>
<td>Constructor</td>
@@ -464,19 +464,20 @@
<td>Public method handling an ignored path.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BlackMultiprocessingReport.__init__" ID="BlackMultiprocessingReport.__init__"></a>
<h4>BlackMultiprocessingReport (Constructor)</h4>
<b>BlackMultiprocessingReport</b>(<i>resultQueue</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>resultQueue</i> (multiprocessing.Queue)</dt>
@@ -487,10 +488,10 @@
<a NAME="BlackMultiprocessingReport.done" ID="BlackMultiprocessingReport.done"></a>
<h4>BlackMultiprocessingReport.done</h4>
<b>done</b>(<i>src, changed, diff=""</i>)
-
<p>
Public method to handle the end of a reformat.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path)</dt>
@@ -509,10 +510,10 @@
<a NAME="BlackMultiprocessingReport.failed" ID="BlackMultiprocessingReport.failed"></a>
<h4>BlackMultiprocessingReport.failed</h4>
<b>failed</b>(<i>src, message</i>)
-
<p>
Public method to handle a reformat failure.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path)</dt>
@@ -527,10 +528,10 @@
<a NAME="BlackMultiprocessingReport.path_ignored" ID="BlackMultiprocessingReport.path_ignored"></a>
<h4>BlackMultiprocessingReport.path_ignored</h4>
<b>path_ignored</b>(<i>src, message=""</i>)
-
<p>
Public method handling an ignored path.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path or str)</dt>
@@ -547,45 +548,47 @@
<hr />
<a NAME="BlackMultiprocessingResult" ID="BlackMultiprocessingResult"></a>
<h2>BlackMultiprocessingResult</h2>
-
<p>
Class containing the reformatting result data.
</p>
<p>
This class is used when reformatting multiple files in parallel using processes.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>data</td></tr>
+<tr><td>filename</td></tr>
+<tr><td>status</td></tr>
+</table>
-<table>
-<tr><td>data</td></tr><tr><td>filename</td></tr><tr><td>status</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="BlackReport" ID="BlackReport"></a>
<h2>BlackReport</h2>
-
<p>
Class extending the black Report to work with our dialog.
</p>
+
<h3>Signals</h3>
<dl>
@@ -599,19 +602,17 @@
<h3>Derived from</h3>
QObject, black.Report
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#BlackReport.__init__">BlackReport</a></td>
<td>Constructor</td>
@@ -629,19 +630,20 @@
<td>Public method handling an ignored path.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BlackReport.__init__" ID="BlackReport.__init__"></a>
<h4>BlackReport (Constructor)</h4>
<b>BlackReport</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject (optional))</dt>
@@ -652,10 +654,10 @@
<a NAME="BlackReport.done" ID="BlackReport.done"></a>
<h4>BlackReport.done</h4>
<b>done</b>(<i>src, changed, diff=""</i>)
-
<p>
Public method to handle the end of a reformat.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path)</dt>
@@ -674,10 +676,10 @@
<a NAME="BlackReport.failed" ID="BlackReport.failed"></a>
<h4>BlackReport.failed</h4>
<b>failed</b>(<i>src, message</i>)
-
<p>
Public method to handle a reformat failure.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path)</dt>
@@ -692,10 +694,10 @@
<a NAME="BlackReport.path_ignored" ID="BlackReport.path_ignored"></a>
<h4>BlackReport.path_ignored</h4>
<b>path_ignored</b>(<i>src, message=""</i>)
-
<p>
Public method handling an ignored path.
</p>
+
<dl>
<dt><i>src</i> (pathlib.Path or str)</dt>
@@ -712,33 +714,37 @@
<hr />
<a NAME="BlackStatistics" ID="BlackStatistics"></a>
<h2>BlackStatistics</h2>
-
<p>
Class containing the reformatting statistic data.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
-<tr><td>changeCount</td></tr><tr><td>failureCount</td></tr><tr><td>ignoreCount</td></tr><tr><td>processedCount</td></tr><tr><td>sameCount</td></tr>
+<tr><td>changeCount</td></tr>
+<tr><td>failureCount</td></tr>
+<tr><td>ignoreCount</td></tr>
+<tr><td>processedCount</td></tr>
+<tr><td>sameCount</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
