Documentation/Source/eric5.UtilitiesPython2.Pep8Checker.html

Mon, 23 Sep 2013 19:32:25 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 23 Sep 2013 19:32:25 +0200
changeset 2929
28ab0bc63d69
parent 2867
eb325d7f7335
child 2966
f85f686981ad
permissions
-rw-r--r--

Finished enhancing the docstring checker to include the eric docstring style.

2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
1 <!DOCTYPE html>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric5.UtilitiesPython2.Pep8Checker</title>
2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
4 <meta charset="UTF-8">
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric5.UtilitiesPython2.Pep8Checker</h1>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 Class implementing the PEP 8 checker for Python2.
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
33 <td><a href="#Pep8Report">Pep8Report</a></td>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
34 <td>Class implementing a special report to be used with our dialog.</td>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
42 <a NAME="Pep8Report" ID="Pep8Report"></a>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
43 <h2>Pep8Report</h2>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
45 Class implementing a special report to be used with our dialog.
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
48 pep8.BaseReport
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
2929
28ab0bc63d69 Finished enhancing the docstring checker to include the eric docstring style.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2867
diff changeset
51 <tr><td>docType</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>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
53 <h3>Class Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
54 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
55 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
56 </table>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <tr>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
60 <td><a href="#Pep8Report.__init__">Pep8Report</a></td>
1229
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
61 <td>Constructor</td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
62 </tr><tr>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
63 <td><a href="#Pep8Report.error_args">error_args</a></td>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Public method to collect the error messages.</td>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
67 <h3>Static Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
68 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
69 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 845
diff changeset
70 </table>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
71 <a NAME="Pep8Report.__init__" ID="Pep8Report.__init__"></a>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
72 <h4>Pep8Report (Constructor)</h4>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
73 <b>Pep8Report</b>(<i>options</i>)
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <p>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 Constructor
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </p><dl>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
77 <dt><i>options</i></dt>
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <dd>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
79 options for the report (optparse.Values)
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </dd>
2867
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
81 </dl><a NAME="Pep8Report.error_args" ID="Pep8Report.error_args"></a>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
82 <h4>Pep8Report.error_args</h4>
eb325d7f7335 Updated translations and regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
83 <b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
845
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <p>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 Public method to collect the error messages.
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </p><dl>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <dt><i>line_number</i></dt>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 line number of the issue (integer)
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </dd><dt><i>offset</i></dt>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 position within line of the issue (integer)
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </dd><dt><i>code</i></dt>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 message code (string)
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 </dd><dt><i>check</i></dt>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 reference to the checker function (function)
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 </dd><dt><i>args</i></dt>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 arguments for the message (list)
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 </dd>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </dl>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <div align="right"><a href="#top">Up</a></div>
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <hr />
0e937d523b70 Finished the PEP8 checker job.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 </body></html>

eric ide

mercurial