Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html

changeset 2867
eb325d7f7335
parent 2387
2d119e79ab54
child 2929
28ab0bc63d69
diff -r c77e08c38a5c -r eb325d7f7335 Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html
--- a/Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html	Sat Aug 24 14:44:55 2013 +0200
+++ b/Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html	Sat Aug 24 15:05:05 2013 +0200
@@ -30,8 +30,8 @@
 <h3>Classes</h3>
 <table>
 <tr>
-<td><a href="#Pep8Checker">Pep8Checker</a></td>
-<td>Class implementing the PEP 8 checker for Python2.</td>
+<td><a href="#Pep8Report">Pep8Report</a></td>
+<td>Class implementing a special report to be used with our dialog.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -39,16 +39,16 @@
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
-<a NAME="Pep8Checker" ID="Pep8Checker"></a>
-<h2>Pep8Checker</h2>
+<a NAME="Pep8Report" ID="Pep8Report"></a>
+<h2>Pep8Report</h2>
 <p>
-    Class implementing the PEP 8 checker for Python2.
+    Class implementing a special report to be used with our dialog.
 </p>
 <h3>Derived from</h3>
-pep8.Checker
+pep8.BaseReport
 <h3>Class Attributes</h3>
 <table>
-<tr><td>filename</td></tr><tr><td>ignore</td></tr><tr><td>repeat</td></tr><tr><td>select</td></tr>
+<tr><td>filename</td></tr><tr><td>hang_closing</td></tr><tr><td>ignore</td></tr><tr><td>max_line_length</td></tr><tr><td>repeat</td></tr><tr><td>select</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -57,13 +57,10 @@
 <h3>Methods</h3>
 <table>
 <tr>
-<td><a href="#Pep8Checker.__init__">Pep8Checker</a></td>
+<td><a href="#Pep8Report.__init__">Pep8Report</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#Pep8Checker.__ignore_code">__ignore_code</a></td>
-<td>Private method to check, if the message for the given code should be ignored.</td>
-</tr><tr>
-<td><a href="#Pep8Checker.report_error_args">report_error_args</a></td>
+<td><a href="#Pep8Report.error_args">error_args</a></td>
 <td>Public method to collect the error messages.</td>
 </tr>
 </table>
@@ -71,55 +68,19 @@
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="Pep8Checker.__init__" ID="Pep8Checker.__init__"></a>
-<h4>Pep8Checker (Constructor)</h4>
-<b>Pep8Checker</b>(<i>filename, lines, repeat=False, select="", ignore=""</i>)
+<a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a>
+<h4>Pep8Report (Constructor)</h4>
+<b>Pep8Report</b>(<i>options</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>filename</i></dt>
-<dd>
-name of the file to check (string)
-</dd><dt><i>lines</i></dt>
-<dd>
-source of the file (list of strings)
-</dd><dt><i>repeat=</i></dt>
+<dt><i>options</i></dt>
 <dd>
-flag indicating to repeat message categories (boolean)
-</dd><dt><i>select=</i></dt>
-<dd>
-list of message IDs to check for
-            (comma separated string)
-</dd><dt><i>ignore=</i></dt>
-<dd>
-list of message IDs to ignore
-            (comma separated string)
+options for the report (optparse.Values)
 </dd>
-</dl><a NAME="Pep8Checker.__ignore_code" ID="Pep8Checker.__ignore_code"></a>
-<h4>Pep8Checker.__ignore_code</h4>
-<b>__ignore_code</b>(<i>code</i>)
-<p>
-        Private method to check, if the message for the given code should
-        be ignored.
-</p><p>
-        If codes are selected and the code has a selected prefix and does not
-        have an ignored prefix, it is not ignored. If codes are selected and
-        the code does not have a selected prefix, it is ignored. If no codes
-        are selected, the code is ignored, if it has a prefix, that is
-        contained in the ignored codes.
-</p><dl>
-<dt><i>code</i></dt>
-<dd>
-code to be checked (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating, that the code should be ignored (boolean)
-</dd>
-</dl><a NAME="Pep8Checker.report_error_args" ID="Pep8Checker.report_error_args"></a>
-<h4>Pep8Checker.report_error_args</h4>
-<b>report_error_args</b>(<i>line_number, offset, code, check, *args</i>)
+</dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a>
+<h4>Pep8Report.error_args</h4>
+<b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
 <p>
         Public method to collect the error messages.
 </p><dl>

eric ide

mercurial