diff -r a3a4760b59ec -r d5aff4fd0ef8 eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Sun May 31 17:23:49 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleCheckerDialog.html Thu Jun 04 17:57:20 2020 +0200
@@ -57,7 +57,7 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>availableFutures</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr>
+<tr><td>availableFutures</td></tr><tr><td>checkCategories</td></tr><tr><td>codeRole</td></tr><tr><td>filenameRole</td></tr><tr><td>fixableRole</td></tr><tr><td>hasResults</td></tr><tr><td>ignoredRole</td></tr><tr><td>lineRole</td></tr><tr><td>messageRole</td></tr><tr><td>noFiles</td></tr><tr><td>noResults</td></tr><tr><td>positionRole</td></tr>
</table>
<h3>Class Methods</h3>
@@ -73,10 +73,18 @@
<td>Constructor</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__assembleExcludeMessages">__assembleExcludeMessages</a></td>
+<td>Private method to assemble the list of excluded checks.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__batchFinished">__batchFinished</a></td>
<td>Private slot handling the completion of a batch job.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__cleanupData">__cleanupData</a></td>
+<td>Private method to clean the loaded/entered data of redundant entries.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__clearErrors">__clearErrors</a></td>
<td>Private method to clear all warning markers of open editors to be checked.</td>
</tr>
@@ -97,6 +105,10 @@
<td>Private method to get a dictionary containing the builtins assignments to be ignored.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__getCategories">__getCategories</a></td>
+<td>Private method to get the enabled or disabled checker categories.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__getEol">__getEol</a></td>
<td>Private method to get the applicable eol string.</td>
</tr>
@@ -113,6 +125,10 @@
<td>Private method to populate the list of shadowed builtins to be ignored.</td>
</tr>
<tr>
+<td><a href="#CodeStyleCheckerDialog.__initCategoriesList">__initCategoriesList</a></td>
+<td>Private method to set the enabled status of the checker categories.</td>
+</tr>
+<tr>
<td><a href="#CodeStyleCheckerDialog.__initFuturesList">__initFuturesList</a></td>
<td>Private method to set the selected status of the future imports.</td>
</tr>
@@ -260,14 +276,32 @@
</p>
<dl>
-<dt><i>styleCheckService</i></dt>
+<dt><i>styleCheckService</i> (CodeStyleCheckService)</dt>
<dd>
reference to the service
- (CodeStyleCheckService)
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
</dd>
-<dt><i>parent</i></dt>
+</dl>
+<a NAME="CodeStyleCheckerDialog.__assembleExcludeMessages" ID="CodeStyleCheckerDialog.__assembleExcludeMessages"></a>
+<h4>CodeStyleCheckerDialog.__assembleExcludeMessages</h4>
+<b>__assembleExcludeMessages</b>(<i></i>)
+
+<p>
+ Private method to assemble the list of excluded checks.
+</p>
+<dl>
+<dt>Returns:</dt>
<dd>
-reference to the parent widget (QWidget)
+list of excluded checks as a comma separated string.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__batchFinished" ID="CodeStyleCheckerDialog.__batchFinished"></a>
@@ -277,6 +311,13 @@
<p>
Private slot handling the completion of a batch job.
</p>
+<a NAME="CodeStyleCheckerDialog.__cleanupData" ID="CodeStyleCheckerDialog.__cleanupData"></a>
+<h4>CodeStyleCheckerDialog.__cleanupData</h4>
+<b>__cleanupData</b>(<i></i>)
+
+<p>
+ Private method to clean the loaded/entered data of redundant entries.
+</p>
<a NAME="CodeStyleCheckerDialog.__clearErrors" ID="CodeStyleCheckerDialog.__clearErrors"></a>
<h4>CodeStyleCheckerDialog.__clearErrors</h4>
<b>__clearErrors</b>(<i>files</i>)
@@ -287,9 +328,9 @@
</p>
<dl>
-<dt><i>files</i></dt>
+<dt><i>files</i> (list of str)</dt>
<dd>
-list of files to be checked (list of string)
+list of files to be checked
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__createErrorItem" ID="CodeStyleCheckerDialog.__createErrorItem"></a>
@@ -319,40 +360,46 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-file name of the file (string)
+file name of the file
</dd>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int or str)</dt>
<dd>
-line number of issue (integer or string)
+line number of issue
</dd>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int or str)</dt>
<dd>
-character position of issue (integer or string)
+character position of issue
</dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
<dd>
-message text (string)
+message text
</dd>
-<dt><i>fixed</i></dt>
+<dt><i>fixed</i> (bool)</dt>
<dd>
-flag indicating a fixed issue (boolean)
+flag indicating a fixed issue
</dd>
-<dt><i>autofixing</i></dt>
+<dt><i>autofixing</i> (bool)</dt>
<dd>
flag indicating, that we are fixing issues
- automatically (boolean)
+ automatically
</dd>
-<dt><i>ignored</i></dt>
+<dt><i>ignored</i> (bool)</dt>
<dd>
-flag indicating an ignored issue (boolean)
+flag indicating an ignored issue
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-reference to the created item (QTreeWidgetItem)
+reference to the created item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__finish" ID="CodeStyleCheckerDialog.__finish"></a>
@@ -383,6 +430,37 @@
dict of list of str
</dd>
</dl>
+<a NAME="CodeStyleCheckerDialog.__getCategories" ID="CodeStyleCheckerDialog.__getCategories"></a>
+<h4>CodeStyleCheckerDialog.__getCategories</h4>
+<b>__getCategories</b>(<i>enabled, asList=False</i>)
+
+<p>
+ Private method to get the enabled or disabled checker categories.
+</p>
+<dl>
+
+<dt><i>enabled</i> (bool)</dt>
+<dd>
+flag indicating to return enabled categories
+</dd>
+<dt><i>asList</i> (bool)</dt>
+<dd>
+flag indicating to return the checker categories as a
+ Python list
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+checker categories as a list or comma separated string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or list of str
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__getEol" ID="CodeStyleCheckerDialog.__getEol"></a>
<h4>CodeStyleCheckerDialog.__getEol</h4>
<b>__getEol</b>(<i>fn</i>)
@@ -392,15 +470,21 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename where to determine the line ending (str)
+filename where to determine the line ending
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-eol string (string)
+eol string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__getSelectedFixableItems" ID="CodeStyleCheckerDialog.__getSelectedFixableItems"></a>
@@ -413,7 +497,13 @@
<dl>
<dt>Returns:</dt>
<dd>
-selected items for fixable issues (list of QTreeWidgetItem)
+selected items for fixable issues
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__getSelectedFutureImports" ID="CodeStyleCheckerDialog.__getSelectedFutureImports"></a>
@@ -450,6 +540,21 @@
assignments to be ignored
</dd>
</dl>
+<a NAME="CodeStyleCheckerDialog.__initCategoriesList" ID="CodeStyleCheckerDialog.__initCategoriesList"></a>
+<h4>CodeStyleCheckerDialog.__initCategoriesList</h4>
+<b>__initCategoriesList</b>(<i>enabledCategories</i>)
+
+<p>
+ Private method to set the enabled status of the checker categories.
+</p>
+<dl>
+
+<dt><i>enabledCategories</i> (str)</dt>
+<dd>
+comma separated list of enabled checker
+ categories
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__initFuturesList" ID="CodeStyleCheckerDialog.__initFuturesList"></a>
<h4>CodeStyleCheckerDialog.__initFuturesList</h4>
<b>__initFuturesList</b>(<i>selectedFutures</i>)
@@ -473,15 +578,21 @@
</p>
<dl>
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
<dd>
-item to be checked (QTreeWidgetItem)
+item to be checked
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-flag indicating a fixable issue (boolean)
+flag indicating a fixable issue
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__modifyFixedResultItem" ID="CodeStyleCheckerDialog.__modifyFixedResultItem"></a>
@@ -494,17 +605,17 @@
</p>
<dl>
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the item to modify (QTreeWidgetItem)
+reference to the item to modify
</dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-text to be appended (string)
+text to be appended
</dd>
-<dt><i>fixed</i></dt>
+<dt><i>fixed</i> (bool)</dt>
<dd>
-flag indicating a fixed issue (boolean)
+flag indicating a fixed issue
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__modifyOptions" ID="CodeStyleCheckerDialog.__modifyOptions"></a>
@@ -521,9 +632,9 @@
</p>
<dl>
-<dt><i>source</i></dt>
+<dt><i>source</i> (list of str or str)</dt>
<dd>
-source text (list of str or str)
+source text
</dd>
</dl>
<dl>
@@ -532,6 +643,12 @@
list of checker options
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list
+</dd>
+</dl>
<a NAME="CodeStyleCheckerDialog.__processError" ID="CodeStyleCheckerDialog.__processError"></a>
<h4>CodeStyleCheckerDialog.__processError</h4>
<b>__processError</b>(<i>fn, msg</i>)
@@ -559,23 +676,22 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of the just checked file (str)
+filename of the just checked file
</dd>
-<dt><i>codeStyleCheckerStats</i></dt>
+<dt><i>codeStyleCheckerStats</i> (dict)</dt>
<dd>
-stats of style and name check (dict)
+stats of style and name check
</dd>
-<dt><i>fixes</i></dt>
+<dt><i>fixes</i> (int)</dt>
<dd>
-number of applied fixes (int)
+number of applied fixes
</dd>
-<dt><i>results</i></dt>
+<dt><i>results</i> (tuplt of tuple of (int, int, str, bool, bool, bool))</dt>
<dd>
tuple for each found violation of style (tuple of
- lineno (int), position (int), text (str), ignored (bool),
- fixed (bool), autofixing (bool))
+ lineno, position, text, ignored, fixed, autofixing)
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__resetStatistics" ID="CodeStyleCheckerDialog.__resetStatistics"></a>
@@ -594,21 +710,25 @@
</p>
<a NAME="CodeStyleCheckerDialog.__selectCodes" ID="CodeStyleCheckerDialog.__selectCodes"></a>
<h4>CodeStyleCheckerDialog.__selectCodes</h4>
-<b>__selectCodes</b>(<i>edit, showFixCodes</i>)
+<b>__selectCodes</b>(<i>edit, categories, showFixCodes</i>)
<p>
Private method to select message codes via a selection dialog.
</p>
<dl>
-<dt><i>edit</i></dt>
+<dt><i>edit</i> (QLineEdit)</dt>
<dd>
-reference of the line edit to be populated (QLineEdit)
+reference of the line edit to be populated
</dd>
-<dt><i>showFixCodes</i></dt>
+<dt><i>categories</i> (list of str)</dt>
+<dd>
+list of message categories to omit
+</dd>
+<dt><i>showFixCodes</i> (bool)</dt>
<dd>
flag indicating to show a list of fixable
- issues (boolean)
+ issues
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__updateFixerStatistics" ID="CodeStyleCheckerDialog.__updateFixerStatistics"></a>
@@ -620,9 +740,9 @@
</p>
<dl>
-<dt><i>fixer</i></dt>
+<dt><i>fixer</i> (CodeStyleFixer)</dt>
<dd>
-reference to the code style fixer (CodeStyleFixer)
+reference to the code style fixer
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.__updateStatistics" ID="CodeStyleCheckerDialog.__updateStatistics"></a>
@@ -634,18 +754,18 @@
</p>
<dl>
-<dt><i>statistics</i></dt>
+<dt><i>statistics</i> (dict)</dt>
<dd>
dictionary of statistical data with
message code as key and message count as value
</dd>
-<dt><i>fixer</i></dt>
+<dt><i>fixer</i> (CodeStyleFixer)</dt>
<dd>
-reference to the code style fixer (CodeStyleFixer)
+reference to the code style fixer
</dd>
-<dt><i>ignoredErrors</i></dt>
+<dt><i>ignoredErrors</i> (int)</dt>
<dd>
-number of ignored errors (integer)
+number of ignored errors
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.check" ID="CodeStyleCheckerDialog.check"></a>
@@ -660,9 +780,9 @@
</p>
<dl>
-<dt><i>codestring=</i></dt>
+<dt><i>codestring</i> (str)</dt>
<dd>
-optional sourcestring (str)
+optional sourcestring
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.checkBatch" ID="CodeStyleCheckerDialog.checkBatch"></a>
@@ -698,9 +818,9 @@
</p>
<dl>
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
<dd>
-button that was clicked (QAbstractButton)
+button that was clicked
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked" ID="CodeStyleCheckerDialog.on_deleteBuiltinButton_clicked"></a>
@@ -727,7 +847,7 @@
</p>
<p>
Build a dictionary of issues to fix. Update the initialized __options.
- Then call check with the dict as keyparam to fix selected issues.
+ Then call check with the dict as keyparam to fix selected issues.
</p>
<a NAME="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked" ID="CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked"></a>
<h4>CodeStyleCheckerDialog.on_fixIssuesSelectButton_clicked</h4>
@@ -783,13 +903,13 @@
</p>
<dl>
-<dt><i>item</i></dt>
+<dt><i>item</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the activated item (QTreeWidgetItem)
+reference to the activated item
</dd>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
<dd>
-column the item was activated in (integer)
+column the item was activated in
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged" ID="CodeStyleCheckerDialog.on_resultList_itemSelectionChanged"></a>
@@ -837,13 +957,13 @@
</p>
<dl>
-<dt><i>fileList</i></dt>
+<dt><i>fileList</i> (list of str)</dt>
<dd>
-list of filenames (list of strings)
+list of filenames
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
-reference to the project object (Project)
+reference to the project object
</dd>
</dl>
<a NAME="CodeStyleCheckerDialog.start" ID="CodeStyleCheckerDialog.start"></a>
@@ -855,20 +975,17 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str or list of str)</dt>
<dd>
file or list of files or directory to be checked
- (string or list of strings)
</dd>
-<dt><i>save=</i></dt>
+<dt><i>save</i> (bool)</dt>
<dd>
-flag indicating to save the given
- file/file list/directory (boolean)
+flag indicating to save the given file/file list/directory
</dd>
-<dt><i>repeat=</i></dt>
+<dt><i>repeat</i> (None or bool)</dt>
<dd>
state of the repeat check box if it is not None
- (None or boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
