--- a/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleFixer</h1>
-
<p>
Module implementing a class to fix certain code style issues.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>FixableCodeStyleIssues</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodeStyleFixer">CodeStyleFixer</a></td>
<td>Class implementing a fixer for certain code style issues.</td>
@@ -37,35 +35,34 @@
<td>Class to reindent badly-indented code to uniformly use four-space indentation.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="CodeStyleFixer" ID="CodeStyleFixer"></a>
<h2>CodeStyleFixer</h2>
-
<p>
Class implementing a fixer for certain code style issues.
</p>
+
<h3>Derived from</h3>
None
<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="#CodeStyleFixer.__init__">CodeStyleFixer</a></td>
<td>Constructor</td>
@@ -283,19 +280,20 @@
<td>Public method to save the modified file.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodeStyleFixer.__init__" ID="CodeStyleFixer.__init__"></a>
<h4>CodeStyleFixer (Constructor)</h4>
<b>CodeStyleFixer</b>(<i>filename, sourceLines, fixCodes, noFixCodes, maxLineLength, blankLines, inPlace, eol, backup=False, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -343,10 +341,10 @@
<a NAME="CodeStyleFixer.__codeMatch" ID="CodeStyleFixer.__codeMatch"></a>
<h4>CodeStyleFixer.__codeMatch</h4>
<b>__codeMatch</b>(<i>code</i>)
-
<p>
Private method to check, if the code should be fixed.
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -369,11 +367,11 @@
<a NAME="CodeStyleFixer.__findLogical" ID="CodeStyleFixer.__findLogical"></a>
<h4>CodeStyleFixer.__findLogical</h4>
<b>__findLogical</b>(<i></i>)
-
<p>
Private method to extract the index of all the starts and ends of
lines.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -390,7 +388,6 @@
<a NAME="CodeStyleFixer.__fixBlankLinesBefore" ID="CodeStyleFixer.__fixBlankLinesBefore"></a>
<h4>CodeStyleFixer.__fixBlankLinesBefore</h4>
<b>__fixBlankLinesBefore</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the need for blank lines before class, function
and method definitions.
@@ -398,6 +395,7 @@
<p>
Codes: E301, E302, E303, E305, E306, E307, E308
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -434,13 +432,13 @@
<a NAME="CodeStyleFixer.__fixD111" ID="CodeStyleFixer.__fixD111"></a>
<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>
@@ -473,13 +471,13 @@
<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>
@@ -512,13 +510,13 @@
<a NAME="CodeStyleFixer.__fixD121" ID="CodeStyleFixer.__fixD121"></a>
<h4>CodeStyleFixer.__fixD121</h4>
<b>__fixD121</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a single line docstring on multiple lines.
</p>
<p>
Codes: D121
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -555,7 +553,6 @@
<a NAME="CodeStyleFixer.__fixD131" ID="CodeStyleFixer.__fixD131"></a>
<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.
@@ -563,6 +560,7 @@
<p>
Codes: D131
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -595,7 +593,6 @@
<a NAME="CodeStyleFixer.__fixD141" ID="CodeStyleFixer.__fixD141"></a>
<h4>CodeStyleFixer.__fixD141</h4>
<b>__fixD141</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a function/method docstring preceded by a
blank line.
@@ -603,6 +600,7 @@
<p>
Codes: D141
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -639,7 +637,6 @@
<a NAME="CodeStyleFixer.__fixD142" ID="CodeStyleFixer.__fixD142"></a>
<h4>CodeStyleFixer.__fixD142</h4>
<b>__fixD142</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a class docstring not preceded by a
blank line.
@@ -647,6 +644,7 @@
<p>
Codes: D142
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -683,7 +681,6 @@
<a NAME="CodeStyleFixer.__fixD143" ID="CodeStyleFixer.__fixD143"></a>
<h4>CodeStyleFixer.__fixD143</h4>
<b>__fixD143</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a class docstring not followed by a
blank line.
@@ -691,6 +688,7 @@
<p>
Codes: D143
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -727,7 +725,6 @@
<a NAME="CodeStyleFixer.__fixD144" ID="CodeStyleFixer.__fixD144"></a>
<h4>CodeStyleFixer.__fixD144</h4>
<b>__fixD144</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a docstring summary not followed by a
blank line.
@@ -735,6 +732,7 @@
<p>
Codes: D144
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -771,7 +769,6 @@
<a NAME="CodeStyleFixer.__fixD145" ID="CodeStyleFixer.__fixD145"></a>
<h4>CodeStyleFixer.__fixD145</h4>
<b>__fixD145</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the last paragraph of a multi-line docstring
not followed by a blank line.
@@ -779,6 +776,7 @@
<p>
Codes: D143
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -815,7 +813,6 @@
<a NAME="CodeStyleFixer.__fixD221" ID="CodeStyleFixer.__fixD221"></a>
<h4>CodeStyleFixer.__fixD221</h4>
<b>__fixD221</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix leading and trailing quotes of docstring
not on separate lines.
@@ -823,6 +820,7 @@
<p>
Codes: D221, D222
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -859,7 +857,6 @@
<a NAME="CodeStyleFixer.__fixD242" ID="CodeStyleFixer.__fixD242"></a>
<h4>CodeStyleFixer.__fixD242</h4>
<b>__fixD242</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a class or function/method docstring preceded
by a blank line.
@@ -867,6 +864,7 @@
<p>
Codes: D242, D244
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -903,7 +901,6 @@
<a NAME="CodeStyleFixer.__fixD243" ID="CodeStyleFixer.__fixD243"></a>
<h4>CodeStyleFixer.__fixD243</h4>
<b>__fixD243</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a class or function/method docstring followed
by a blank line.
@@ -911,6 +908,7 @@
<p>
Codes: D243, D245
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -947,7 +945,6 @@
<a NAME="CodeStyleFixer.__fixD247" ID="CodeStyleFixer.__fixD247"></a>
<h4>CodeStyleFixer.__fixD247</h4>
<b>__fixD247</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a last paragraph of a docstring followed
by a blank line.
@@ -955,6 +952,7 @@
<p>
Codes: D247
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -991,13 +989,13 @@
<a NAME="CodeStyleFixer.__fixE101" ID="CodeStyleFixer.__fixE101"></a>
<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>
@@ -1030,7 +1028,6 @@
<a NAME="CodeStyleFixer.__fixE121" ID="CodeStyleFixer.__fixE121"></a>
<h4>CodeStyleFixer.__fixE121</h4>
<b>__fixE121</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the indentation of continuation lines and
closing brackets.
@@ -1038,6 +1035,7 @@
<p>
Codes: E121, E124
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1074,13 +1072,13 @@
<a NAME="CodeStyleFixer.__fixE122" ID="CodeStyleFixer.__fixE122"></a>
<h4>CodeStyleFixer.__fixE122</h4>
<b>__fixE122</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a missing indentation of continuation lines.
</p>
<p>
Codes: E122
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1117,13 +1115,13 @@
<a NAME="CodeStyleFixer.__fixE123" ID="CodeStyleFixer.__fixE123"></a>
<h4>CodeStyleFixer.__fixE123</h4>
<b>__fixE123</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the indentation of a closing bracket lines.
</p>
<p>
Codes: E123
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1160,7 +1158,6 @@
<a NAME="CodeStyleFixer.__fixE125" ID="CodeStyleFixer.__fixE125"></a>
<h4>CodeStyleFixer.__fixE125</h4>
<b>__fixE125</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the indentation of continuation lines not
distinguishable from next logical line.
@@ -1168,6 +1165,7 @@
<p>
Codes: E125
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1204,7 +1202,6 @@
<a NAME="CodeStyleFixer.__fixE126" ID="CodeStyleFixer.__fixE126"></a>
<h4>CodeStyleFixer.__fixE126</h4>
<b>__fixE126</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix over-indented/under-indented hanging
indentation.
@@ -1212,6 +1209,7 @@
<p>
Codes: E126, E133
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1248,13 +1246,13 @@
<a NAME="CodeStyleFixer.__fixE127" ID="CodeStyleFixer.__fixE127"></a>
<h4>CodeStyleFixer.__fixE127</h4>
<b>__fixE127</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix over/under indented lines.
</p>
<p>
Codes: E127, E128
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1291,13 +1289,13 @@
<a NAME="CodeStyleFixer.__fixE201" ID="CodeStyleFixer.__fixE201"></a>
<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>
@@ -1330,7 +1328,6 @@
<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.
@@ -1338,6 +1335,7 @@
<p>
Codes: E221, E222, E223, E224, E241, E242, E271, E272, E273, E274
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1370,13 +1368,13 @@
<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>
@@ -1409,13 +1407,13 @@
<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>
@@ -1448,7 +1446,6 @@
<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.
@@ -1456,6 +1453,7 @@
<p>
Codes: E251
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1488,13 +1486,13 @@
<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>
@@ -1527,7 +1525,6 @@
<a NAME="CodeStyleFixer.__fixE304" ID="CodeStyleFixer.__fixE304"></a>
<h4>CodeStyleFixer.__fixE304</h4>
<b>__fixE304</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix superfluous blank lines after a function
decorator.
@@ -1535,6 +1532,7 @@
<p>
Codes: E304
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1571,13 +1569,13 @@
<a NAME="CodeStyleFixer.__fixE401" ID="CodeStyleFixer.__fixE401"></a>
<h4>CodeStyleFixer.__fixE401</h4>
<b>__fixE401</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix multiple imports on one line.
</p>
<p>
Codes: E401
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1614,13 +1612,13 @@
<a NAME="CodeStyleFixer.__fixE501" ID="CodeStyleFixer.__fixE501"></a>
<h4>CodeStyleFixer.__fixE501</h4>
<b>__fixE501</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix the long lines by breaking them.
</p>
<p>
Codes: E501
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1657,13 +1655,13 @@
<a NAME="CodeStyleFixer.__fixE502" ID="CodeStyleFixer.__fixE502"></a>
<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>
@@ -1696,13 +1694,13 @@
<a NAME="CodeStyleFixer.__fixE701" ID="CodeStyleFixer.__fixE701"></a>
<h4>CodeStyleFixer.__fixE701</h4>
<b>__fixE701</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix colon-separated compound statements.
</p>
<p>
Codes: E701
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1739,13 +1737,13 @@
<a NAME="CodeStyleFixer.__fixE702" ID="CodeStyleFixer.__fixE702"></a>
<h4>CodeStyleFixer.__fixE702</h4>
<b>__fixE702</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix semicolon-separated compound statements.
</p>
<p>
Codes: E702, E703
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1782,13 +1780,13 @@
<a NAME="CodeStyleFixer.__fixE711" ID="CodeStyleFixer.__fixE711"></a>
<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>
@@ -1821,7 +1819,6 @@
<a NAME="CodeStyleFixer.__fixN804" ID="CodeStyleFixer.__fixN804"></a>
<h4>CodeStyleFixer.__fixN804</h4>
<b>__fixN804</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a wrong first argument of normal and
class methods.
@@ -1829,6 +1826,7 @@
<p>
Codes: N804, N805
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1865,13 +1863,13 @@
<a NAME="CodeStyleFixer.__fixN806" ID="CodeStyleFixer.__fixN806"></a>
<h4>CodeStyleFixer.__fixN806</h4>
<b>__fixN806</b>(<i>code, line, pos, apply=False</i>)
-
<p>
Private method to fix a wrong first argument of static methods.
</p>
<p>
Codes: N806
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -1908,13 +1906,13 @@
<a NAME="CodeStyleFixer.__fixReindent" ID="CodeStyleFixer.__fixReindent"></a>
<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> (int)</dt>
@@ -1952,13 +1950,13 @@
<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>
@@ -1991,13 +1989,13 @@
<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>
@@ -2030,13 +2028,13 @@
<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>
@@ -2069,13 +2067,13 @@
<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>
@@ -2108,10 +2106,10 @@
<a NAME="CodeStyleFixer.__fixWhitespace" ID="CodeStyleFixer.__fixWhitespace"></a>
<h4>CodeStyleFixer.__fixWhitespace</h4>
<b>__fixWhitespace</b>(<i>line, offset, replacement</i>)
-
<p>
Private method to correct whitespace at the given offset.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2142,10 +2140,10 @@
<a NAME="CodeStyleFixer.__getID" ID="CodeStyleFixer.__getID"></a>
<h4>CodeStyleFixer.__getID</h4>
<b>__getID</b>(<i></i>)
-
<p>
Private method to get the ID for a deferred fix.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2161,10 +2159,10 @@
<a NAME="CodeStyleFixer.__getIndent" ID="CodeStyleFixer.__getIndent"></a>
<h4>CodeStyleFixer.__getIndent</h4>
<b>__getIndent</b>(<i>line</i>)
-
<p>
Private method to get the indentation string.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2187,10 +2185,10 @@
<a NAME="CodeStyleFixer.__getIndentWord" ID="CodeStyleFixer.__getIndentWord"></a>
<h4>CodeStyleFixer.__getIndentWord</h4>
<b>__getIndentWord</b>(<i></i>)
-
<p>
Private method to determine the indentation type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2206,11 +2204,11 @@
<a NAME="CodeStyleFixer.__getLogical" ID="CodeStyleFixer.__getLogical"></a>
<h4>CodeStyleFixer.__getLogical</h4>
<b>__getLogical</b>(<i>line, pos</i>)
-
<p>
Private method to get the logical line corresponding to the given
position.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -2240,11 +2238,11 @@
<a NAME="CodeStyleFixer.__multilineStringLines" ID="CodeStyleFixer.__multilineStringLines"></a>
<h4>CodeStyleFixer.__multilineStringLines</h4>
<b>__multilineStringLines</b>(<i></i>)
-
<p>
Private method to determine the line numbers that are within multi line
strings and these which are part of a documentation string.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2262,10 +2260,10 @@
<a NAME="CodeStyleFixer.finalize" ID="CodeStyleFixer.finalize"></a>
<h4>CodeStyleFixer.finalize</h4>
<b>finalize</b>(<i></i>)
-
<p>
Public method to apply all deferred fixes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2281,10 +2279,10 @@
<a NAME="CodeStyleFixer.fixIssue" ID="CodeStyleFixer.fixIssue"></a>
<h4>CodeStyleFixer.fixIssue</h4>
<b>fixIssue</b>(<i>line, pos, code</i>)
-
<p>
Public method to fix the fixable issues.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -2317,11 +2315,11 @@
<a NAME="CodeStyleFixer.mutualStartswith" ID="CodeStyleFixer.mutualStartswith"></a>
<h4>CodeStyleFixer.mutualStartswith</h4>
<b>mutualStartswith</b>(<i>b</i>)
-
<p>
Local helper method to compare the beginnings of two strings
against each other.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2337,10 +2335,10 @@
<a NAME="CodeStyleFixer.saveFile" ID="CodeStyleFixer.saveFile"></a>
<h4>CodeStyleFixer.saveFile</h4>
<b>saveFile</b>(<i>encoding</i>)
-
<p>
Public method to save the modified file.
</p>
+
<dl>
<dt><i>encoding</i> (str)</dt>
@@ -2365,29 +2363,27 @@
<hr />
<a NAME="IndentationWrapper" ID="IndentationWrapper"></a>
<h2>IndentationWrapper</h2>
-
<p>
Class used by fixers dealing with indentation.
</p>
<p>
Each instance operates on a single logical line.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
<tr><td>SKIP_TOKENS</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#IndentationWrapper.__init__">IndentationWrapper</a></td>
<td>Constructor</td>
@@ -2401,19 +2397,20 @@
<td>Public method to replicate logic in pycodestyle.py, to know what level to indent things to.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="IndentationWrapper.__init__" ID="IndentationWrapper.__init__"></a>
<h4>IndentationWrapper (Constructor)</h4>
<b>IndentationWrapper</b>(<i>physical_lines</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>physical_lines</i> (list of str)</dt>
@@ -2424,10 +2421,10 @@
<a NAME="IndentationWrapper.__buildTokensLogical" ID="IndentationWrapper.__buildTokensLogical"></a>
<h4>IndentationWrapper.__buildTokensLogical</h4>
<b>__buildTokensLogical</b>(<i>tokens</i>)
-
<p>
Private method to build a logical line from a list of tokens.
</p>
+
<dl>
<dt><i>tokens</i> (list of Token)</dt>
@@ -2450,11 +2447,11 @@
<a NAME="IndentationWrapper.pep8Expected" ID="IndentationWrapper.pep8Expected"></a>
<h4>IndentationWrapper.pep8Expected</h4>
<b>pep8Expected</b>(<i></i>)
-
<p>
Public method to replicate logic in pycodestyle.py, to know what level
to indent things to.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2474,26 +2471,24 @@
<hr />
<a NAME="LineShortener" ID="LineShortener"></a>
<h2>LineShortener</h2>
-
<p>
Class used to shorten lines to a given maximum of characters.
</p>
+
<h3>Derived from</h3>
None
<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="#LineShortener.__init__">LineShortener</a></td>
<td>Constructor</td>
@@ -2539,19 +2534,20 @@
<td>Public method to shorten the line wrapped by the class instance.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="LineShortener.__init__" ID="LineShortener.__init__"></a>
<h4>LineShortener (Constructor)</h4>
<b>LineShortener</b>(<i>curLine, prevLine, nextLine, maxLength=88, eol="\n", indentWord=" ", isDocString=False, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>curLine</i> (str)</dt>
@@ -2587,10 +2583,10 @@
<a NAME="LineShortener.__breakMultiline" ID="LineShortener.__breakMultiline"></a>
<h4>LineShortener.__breakMultiline</h4>
<b>__breakMultiline</b>(<i></i>)
-
<p>
Private method to break multi line strings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2606,10 +2602,10 @@
<a NAME="LineShortener.__checkSyntax" ID="LineShortener.__checkSyntax"></a>
<h4>LineShortener.__checkSyntax</h4>
<b>__checkSyntax</b>(<i>code</i>)
-
<p>
Private method to check the syntax of the given code fragment.
</p>
+
<dl>
<dt><i>code</i> (str)</dt>
@@ -2632,11 +2628,11 @@
<a NAME="LineShortener.__countUnbalancedBrackets" ID="LineShortener.__countUnbalancedBrackets"></a>
<h4>LineShortener.__countUnbalancedBrackets</h4>
<b>__countUnbalancedBrackets</b>(<i>line</i>)
-
<p>
Private method to determine the number of unmatched open/close
brackets.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2659,10 +2655,10 @@
<a NAME="LineShortener.__getIndent" ID="LineShortener.__getIndent"></a>
<h4>LineShortener.__getIndent</h4>
<b>__getIndent</b>(<i>line</i>)
-
<p>
Private method to get the indentation string.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2685,11 +2681,11 @@
<a NAME="LineShortener.__isProbablyInsideStringOrComment" ID="LineShortener.__isProbablyInsideStringOrComment"></a>
<h4>LineShortener.__isProbablyInsideStringOrComment</h4>
<b>__isProbablyInsideStringOrComment</b>(<i>line, index</i>)
-
<p>
Private method to check, if the given string might be inside a string
or comment.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2717,10 +2713,10 @@
<a NAME="LineShortener.__lineShorteningRank" ID="LineShortener.__lineShorteningRank"></a>
<h4>LineShortener.__lineShorteningRank</h4>
<b>__lineShorteningRank</b>(<i>candidate</i>)
-
<p>
Private method to rank a candidate.
</p>
+
<dl>
<dt><i>candidate</i> (str)</dt>
@@ -2743,11 +2739,11 @@
<a NAME="LineShortener.__normalizeMultiline" ID="LineShortener.__normalizeMultiline"></a>
<h4>LineShortener.__normalizeMultiline</h4>
<b>__normalizeMultiline</b>(<i>text</i>)
-
<p>
Private method to remove multiline-related code that will cause syntax
error.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -2770,10 +2766,10 @@
<a NAME="LineShortener.__shortenComment" ID="LineShortener.__shortenComment"></a>
<h4>LineShortener.__shortenComment</h4>
<b>__shortenComment</b>(<i>isLast</i>)
-
<p>
Private method to shorten a comment line.
</p>
+
<dl>
<dt><i>isLast</i> (bool)</dt>
@@ -2796,10 +2792,10 @@
<a NAME="LineShortener.__shortenLine" ID="LineShortener.__shortenLine"></a>
<h4>LineShortener.__shortenLine</h4>
<b>__shortenLine</b>(<i>tokens, source, indent</i>)
-
<p>
Private method to shorten a line of code at an operator.
</p>
+
<dl>
<dt><i>tokens</i> (list of Token)</dt>
@@ -2830,10 +2826,10 @@
<a NAME="LineShortener.shorten" ID="LineShortener.shorten"></a>
<h4>LineShortener.shorten</h4>
<b>shorten</b>(<i></i>)
-
<p>
Public method to shorten the line wrapped by the class instance.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2852,7 +2848,6 @@
<hr />
<a NAME="Reindenter" ID="Reindenter"></a>
<h2>Reindenter</h2>
-
<p>
Class to reindent badly-indented code to uniformly use four-space
indentation.
@@ -2860,22 +2855,21 @@
<p>
Released to the public domain, by Tim Peters, 03 October 2000.
</p>
+
<h3>Derived from</h3>
None
<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="#Reindenter.__init__">Reindenter</a></td>
<td>Constructor</td>
@@ -2901,19 +2895,20 @@
<td>Public method to run the re-indenter.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Reindenter.__init__" ID="Reindenter.__init__"></a>
<h4>Reindenter (Constructor)</h4>
<b>Reindenter</b>(<i>sourceLines</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>sourceLines</i> (list of str)</dt>
@@ -2924,10 +2919,10 @@
<a NAME="Reindenter.__genStats" ID="Reindenter.__genStats"></a>
<h4>Reindenter.__genStats</h4>
<b>__genStats</b>(<i>tokens</i>)
-
<p>
Private method to generate the re-indent statistics.
</p>
+
<dl>
<dt><i>tokens</i> (function)</dt>
@@ -2950,10 +2945,10 @@
<a NAME="Reindenter.__getlspace" ID="Reindenter.__getlspace"></a>
<h4>Reindenter.__getlspace</h4>
<b>__getlspace</b>(<i>line</i>)
-
<p>
Private method to count number of leading blanks.
</p>
+
<dl>
<dt><i>line</i> (str)</dt>
@@ -2976,10 +2971,10 @@
<a NAME="Reindenter.fixedLine" ID="Reindenter.fixedLine"></a>
<h4>Reindenter.fixedLine</h4>
<b>fixedLine</b>(<i>line</i>)
-
<p>
Public method to get a fixed line.
</p>
+
<dl>
<dt><i>line</i> (int)</dt>
@@ -3002,10 +2997,10 @@
<a NAME="Reindenter.getline" ID="Reindenter.getline"></a>
<h4>Reindenter.getline</h4>
<b>getline</b>(<i></i>)
-
<p>
Public method to get a line of text for tokenize.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3021,10 +3016,10 @@
<a NAME="Reindenter.run" ID="Reindenter.run"></a>
<h4>Reindenter.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public method to run the re-indenter.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3039,4 +3034,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
