Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html

changeset 845
0e937d523b70
child 1228
7afaf2fca55b
child 1278
fb0460fd00b9
diff -r 9508a1f87bc3 -r 0e937d523b70 Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html	Wed Jan 12 19:58:37 2011 +0100
@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.UtilitiesPython2.Pep8Checker</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.UtilitiesPython2.Pep8Checker</h1>
+<p>
+Class implementing the PEP 8 checker for Python2.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Pep8Checker">Pep8Checker</a></td>
+<td>Class implementing the PEP 8 checker for Python2.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Pep8Checker" ID="Pep8Checker"></a>
+<h2>Pep8Checker</h2>
+<p>
+    Class implementing the PEP 8 checker for Python2.
+</p>
+<h3>Derived from</h3>
+pep8.Checker
+<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>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pep8Checker.__init__">Pep8Checker</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>Public method to collect the error messages.</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>)
+<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>
+<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)
+</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>)
+<p>
+        Public method to collect the error messages.
+</p><dl>
+<dt><i>line_number</i></dt>
+<dd>
+line number of the issue (integer)
+</dd><dt><i>offset</i></dt>
+<dd>
+position within line of the issue (integer)
+</dd><dt><i>code</i></dt>
+<dd>
+message code (string)
+</dd><dt><i>check</i></dt>
+<dd>
+reference to the checker function (function)
+</dd><dt><i>args</i></dt>
+<dd>
+arguments for the message (list)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial