Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10437
2f70ca07f0af
--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html	Fri Oct 27 14:09:40 2023 +0200
@@ -84,11 +84,11 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixD111">__fixD111</a></td>
-<td></td>
+<td>Private method to fix docstring enclosed in wrong quotes.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixD112">__fixD112</a></td>
-<td></td>
+<td>Private method to fix docstring 'r' in leading quotes.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixD121">__fixD121</a></td>
@@ -96,7 +96,7 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixD131">__fixD131</a></td>
-<td></td>
+<td>Private method to fix a docstring summary not ending with a period.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixD141">__fixD141</a></td>
@@ -136,7 +136,7 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE101">__fixE101</a></td>
-<td></td>
+<td>Private method to fix obsolete tab usage and indentation errors.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE121">__fixE121</a></td>
@@ -164,27 +164,27 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE201">__fixE201</a></td>
-<td></td>
+<td>Private method to fix extraneous whitespace.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE221">__fixE221</a></td>
-<td></td>
+<td>Private method to fix extraneous whitespace around operator or keyword.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE225">__fixE225</a></td>
-<td></td>
+<td>Private method to fix extraneous whitespaces around operator.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE231">__fixE231</a></td>
-<td></td>
+<td>Private method to fix missing whitespace after ',;:'.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE251">__fixE251</a></td>
-<td></td>
+<td>Private method to fix extraneous whitespace around keyword and default parameter equals.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE261">__fixE261</a></td>
-<td></td>
+<td>Private method to fix whitespace before or after inline comment.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE304">__fixE304</a></td>
@@ -200,7 +200,7 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE502">__fixE502</a></td>
-<td></td>
+<td>Private method to fix redundant backslash within brackets.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE701">__fixE701</a></td>
@@ -212,7 +212,7 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixE711">__fixE711</a></td>
-<td></td>
+<td>Private method to fix comparison with None.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixN804">__fixN804</a></td>
@@ -224,23 +224,23 @@
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixReindent">__fixReindent</a></td>
-<td></td>
+<td>Private method to fix a badly indented line.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixW291">__fixW291</a></td>
-<td></td>
+<td>Private method to fix trailing whitespace.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixW292">__fixW292</a></td>
-<td></td>
+<td>Private method to fix a missing newline at the end of file.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixW391">__fixW391</a></td>
-<td></td>
+<td>Private method to fix trailing blank lines.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixW603">__fixW603</a></td>
-<td></td>
+<td>Private method to fix the not equal notation.</td>
 </tr>
 <tr>
 <td><a href="#CodeStyleFixer.__fixWhitespace">__fixWhitespace</a></td>
@@ -423,10 +423,80 @@
 <h4>CodeStyleFixer.__fixD111</h4>
 <b>__fixD111</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix docstring enclosed in wrong quotes.
+</p>
+<p>
+        Codes: D111
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixD112" ID="CodeStyleFixer.__fixD112"></a>
 <h4>CodeStyleFixer.__fixD112</h4>
 <b>__fixD112</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix docstring 'r' in leading quotes.
+</p>
+<p>
+        Codes: D112
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixD121" ID="CodeStyleFixer.__fixD121"></a>
 <h4>CodeStyleFixer.__fixD121</h4>
 <b>__fixD121</b>(<i>code, line, pos, apply=False</i>)
@@ -474,6 +544,42 @@
 <h4>CodeStyleFixer.__fixD131</h4>
 <b>__fixD131</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix a docstring summary not ending with a
+        period.
+</p>
+<p>
+        Codes: D131
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixD141" ID="CodeStyleFixer.__fixD141"></a>
 <h4>CodeStyleFixer.__fixD141</h4>
 <b>__fixD141</b>(<i>code, line, pos, apply=False</i>)
@@ -874,6 +980,41 @@
 <h4>CodeStyleFixer.__fixE101</h4>
 <b>__fixE101</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix obsolete tab usage and indentation errors.
+</p>
+<p>
+        Codes: E101, E111, W191
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE121" ID="CodeStyleFixer.__fixE121"></a>
 <h4>CodeStyleFixer.__fixE121</h4>
 <b>__fixE121</b>(<i>code, line, pos, apply=False</i>)
@@ -1139,26 +1280,238 @@
 <h4>CodeStyleFixer.__fixE201</h4>
 <b>__fixE201</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix extraneous whitespace.
+</p>
+<p>
+        Codes: E201, E202, E203, E211
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE221" ID="CodeStyleFixer.__fixE221"></a>
 <h4>CodeStyleFixer.__fixE221</h4>
 <b>__fixE221</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix extraneous whitespace around operator or
+        keyword.
+</p>
+<p>
+        Codes: E221, E222, E223, E224, E241, E242, E271, E272, E273, E274
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE225" ID="CodeStyleFixer.__fixE225"></a>
 <h4>CodeStyleFixer.__fixE225</h4>
 <b>__fixE225</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix extraneous whitespaces around operator.
+</p>
+<p>
+        Codes: E225, E226, E227, E228
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE231" ID="CodeStyleFixer.__fixE231"></a>
 <h4>CodeStyleFixer.__fixE231</h4>
 <b>__fixE231</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix missing whitespace after ',;:'.
+</p>
+<p>
+        Codes: E231
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE251" ID="CodeStyleFixer.__fixE251"></a>
 <h4>CodeStyleFixer.__fixE251</h4>
 <b>__fixE251</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix extraneous whitespace around keyword and
+        default parameter equals.
+</p>
+<p>
+        Codes: E251
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE261" ID="CodeStyleFixer.__fixE261"></a>
 <h4>CodeStyleFixer.__fixE261</h4>
 <b>__fixE261</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix whitespace before or after inline comment.
+</p>
+<p>
+        Codes: E261, E262
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE304" ID="CodeStyleFixer.__fixE304"></a>
 <h4>CodeStyleFixer.__fixE304</h4>
 <b>__fixE304</b>(<i>code, line, pos, apply=False</i>)
@@ -1293,6 +1646,41 @@
 <h4>CodeStyleFixer.__fixE502</h4>
 <b>__fixE502</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix redundant backslash within brackets.
+</p>
+<p>
+        Codes: E502
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixE701" ID="CodeStyleFixer.__fixE701"></a>
 <h4>CodeStyleFixer.__fixE701</h4>
 <b>__fixE701</b>(<i>code, line, pos, apply=False</i>)
@@ -1383,6 +1771,41 @@
 <h4>CodeStyleFixer.__fixE711</h4>
 <b>__fixE711</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix comparison with None.
+</p>
+<p>
+        Codes: E711, E712
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixN804" ID="CodeStyleFixer.__fixN804"></a>
 <h4>CodeStyleFixer.__fixN804</h4>
 <b>__fixN804</b>(<i>code, line, pos, apply=False</i>)
@@ -1474,22 +1897,196 @@
 <h4>CodeStyleFixer.__fixReindent</h4>
 <b>__fixReindent</b>(<i>line, pos, logical</i>)
 
+<p>
+        Private method to fix a badly indented line.
+</p>
+<p>
+        This is done by adding or removing from its initial indent only.
+</p>
+<dl>
+
+<dt><i>line</i></dt>
+<dd>
+line number of the issue (integer)
+</dd>
+<dt><i>pos</i></dt>
+<dd>
+position inside line (integer)
+</dd>
+<dt><i>logical</i></dt>
+<dd>
+logical line structure
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a change was done (boolean)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate a bad 'logical' parameter
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixW291" ID="CodeStyleFixer.__fixW291"></a>
 <h4>CodeStyleFixer.__fixW291</h4>
 <b>__fixW291</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix trailing whitespace.
+</p>
+<p>
+        Codes: W291, W293
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixW292" ID="CodeStyleFixer.__fixW292"></a>
 <h4>CodeStyleFixer.__fixW292</h4>
 <b>__fixW292</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix a missing newline at the end of file.
+</p>
+<p>
+        Codes: W292
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixW391" ID="CodeStyleFixer.__fixW391"></a>
 <h4>CodeStyleFixer.__fixW391</h4>
 <b>__fixW391</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix trailing blank lines.
+</p>
+<p>
+        Codes: W391
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixW603" ID="CodeStyleFixer.__fixW603"></a>
 <h4>CodeStyleFixer.__fixW603</h4>
 <b>__fixW603</b>(<i>code, line, pos</i>)
 
+<p>
+        Private method to fix the not equal notation.
+</p>
+<p>
+        Codes: W603
+</p>
+<dl>
+
+<dt><i>code</i> (str)</dt>
+<dd>
+code of the issue
+</dd>
+<dt><i>line</i> (int)</dt>
+<dd>
+line number of the issue
+</dd>
+<dt><i>pos</i> (int)</dt>
+<dd>
+position inside line
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value indicating an applied/deferred fix (-1, 0, 1),
+            a message code for the fix, a list of arguments for the
+            message and an ID for a deferred fix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, list or int, int)
+</dd>
+</dl>
 <a NAME="CodeStyleFixer.__fixWhitespace" ID="CodeStyleFixer.__fixWhitespace"></a>
 <h4>CodeStyleFixer.__fixWhitespace</h4>
 <b>__fixWhitespace</b>(<i>line, offset, replacement</i>)

Mercurial Repository: eric

eric ide

mercurial