eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html

Sat, 19 Dec 2020 15:22:26 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 19 Dec 2020 15:22:26 +0100
changeset 7900
72b88fb20261
parent 7624
6eabbcf3bdf8
child 7989
a21d673a8f99
permissions
-rw-r--r--

Corrected the use of '@keyparam' in the source documentation.

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
21 <body>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
22 <a NAME="top" ID="top"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
24
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 Module implementing the code style checker.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <h3>Global Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
29
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <h3>Classes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
34
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
36
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <td><a href="#CodeStyleCheckerReport">CodeStyleCheckerReport</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <td>Class implementing a special report to be used with our dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Functions</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
43
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
45
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
47 <td><a href="#__checkCodeStyle">__checkCodeStyle</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
48 <td>Private module function to perform the code style check and/or fix found errors.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
49 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
50 <tr>
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
51 <td><a href="#__checkSyntax">__checkSyntax</a></td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
52 <td>Private module function to perform a syntax check.</td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
53 </tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
54 <tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
55 <td><a href="#codeStyleBatchCheck">codeStyleBatchCheck</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
56 <td>Module function to check code style for a batch of files.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
57 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
58 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td><a href="#codeStyleCheck">codeStyleCheck</a></td>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
60 <td>Do the code style check and/or fix found errors.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
61 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
62 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#extractLineFlags">extractLineFlags</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Function to extract flags starting and ending with '__' from a line comment.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
65 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
66 <tr>
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
67 <td><a href="#ignoreCode">ignoreCode</a></td>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
68 <td>Function to check, if the given code should be ignored as per line flags.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
69 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
70 <tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
71 <td><a href="#initBatchService">initBatchService</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
72 <td>Initialize the batch service and return the entry point.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
73 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
74 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="#initService">initService</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Initialize the service and return the entry point.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
77 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
78 <tr>
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
79 <td><a href="#securityOk">securityOk</a></td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
80 <td>Function to check, if the given code is an acknowledged security report.</td>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
81 </tr>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
82 <tr>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
83 <td><a href="#worker">worker</a></td>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
84 <td>Module function acting as the parallel worker for the style check.</td>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
87 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
88 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <a NAME="CodeStyleCheckerReport" ID="CodeStyleCheckerReport"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <h2>CodeStyleCheckerReport</h2>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
91
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 Class implementing a special report to be used with our dialog.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <h3>Derived from</h3>
5147
d39dd5cee0c8 Renamed pep8.py to pycodestyle.py in order to track the upstream renaming.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4222
diff changeset
96 pycodestyle.BaseReport
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <h3>Class Attributes</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
98
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <h3>Class Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
103
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <h3>Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
108
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
110
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <td><a href="#CodeStyleCheckerReport.__init__">CodeStyleCheckerReport</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 <td>Constructor</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
114 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
115 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <td><a href="#CodeStyleCheckerReport.error_args">error_args</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <td>Public method to collect the error messages.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <h3>Static Methods</h3>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
121
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 <table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 <tr><td>None</td></tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
125
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <a NAME="CodeStyleCheckerReport.__init__" ID="CodeStyleCheckerReport.__init__"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <h4>CodeStyleCheckerReport (Constructor)</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 <b>CodeStyleCheckerReport</b>(<i>options</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
129
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 Constructor
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
132 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
133 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
134
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <dt><i>options</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 options for the report (optparse.Values)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
139 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
140 <a NAME="CodeStyleCheckerReport.error_args" ID="CodeStyleCheckerReport.error_args"></a>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 <h4>CodeStyleCheckerReport.error_args</h4>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 <b>error_args</b>(<i>line_number, offset, code, check, *args</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
143
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
145 Public method to collect the error messages.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
146 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
147 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
148
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 <dt><i>line_number</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 line number of the issue (integer)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
152 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
153 <dt><i>offset</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155 position within line of the issue (integer)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
156 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
157 <dt><i>code</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159 message code (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
160 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
161 <dt><i>check</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163 reference to the checker function (function)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
164 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
165 <dt><i>args</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 arguments for the message (list)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
169 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
170 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 error code (string)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
177 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
178 <hr />
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
179 <a NAME="__checkCodeStyle" ID="__checkCodeStyle"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
180 <h2>__checkCodeStyle</h2>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
181 <b>__checkCodeStyle</b>(<i>filename, source, args</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
182
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
183 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
184 Private module function to perform the code style check and/or fix
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
185 found errors.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
186 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
187 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
188
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
189 <dt><i>filename</i> (str)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
190 <dd>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
191 source filename
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
192 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
193 <dt><i>source</i> (str)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
194 <dd>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
195 string containing the code to check
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
196 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
197 <dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
198 <dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
199 arguments used by the codeStyleCheck function (list of
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
200 excludeMessages, includeMessages, repeatMessages, fixCodes,
6807
7e5eba19d86d Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6264
diff changeset
201 noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines,
7247
bf9379f964f3 Code Style Checker:
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
202 hangClosing, docType, codeComplexityArgs, miscellaneousArgs,
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
203 annotationArgs, securityArgs, errors, eol, encoding, backup)
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
204 bool, str, dict, dict, dict, list of str, str, str, bool)
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
205 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
206 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
207 <dl>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
208 <dt>Returns:</dt>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
209 <dd>
7610
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
210 tuple of statistics data and list of result dictionaries with
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
211 keys:
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
212 <ul>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
213 <li>file: file name</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
214 <li>line: line_number</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
215 <li>offset: offset within line</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
216 <li>code: message code</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
217 <li>args: list of arguments to format the message</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
218 <li>ignored: flag indicating this issue was ignored</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
219 <li>fixed: flag indicating this issue was fixed</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
220 <li>autofixing: flag indicating that a fix can be done</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
221 <li>fixcode: message code for the fix</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
222 <li>fixargs: list of arguments to format the fix message</li>
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
223 </ul>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
224 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
225 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
226 <dl>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
227 <dt>Return Type:</dt>
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
228 <dd>
7610
df7025fe26a3 Code Style Checker: reworked the API between frontend and backend to get some more flexibility for the future.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7273
diff changeset
229 tuple of (dict, list of dict)
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
230 </dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
231 </dl>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
232 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
233 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
234 <hr />
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
235 <a NAME="__checkSyntax" ID="__checkSyntax"></a>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
236 <h2>__checkSyntax</h2>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
237 <b>__checkSyntax</b>(<i>filename, source</i>)
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
238
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
239 <p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
240 Private module function to perform a syntax check.
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
241 </p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
242 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
243
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
244 <dt><i>filename</i> (str)</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
245 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
246 source filename
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
247 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
248 <dt><i>source</i> (str)</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
249 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
250 string containing the code to check
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
251 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
252 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
253 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
254 <dt>Returns:</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
255 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
256 tuple containing the error dictionary with syntax error details
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
257 and a statistics dictionary or a tuple containing two None
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
258 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
259 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
260 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
261 <dt>Return Type:</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
262 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
263 tuple of (dict, dict) or tuple of (None, None)
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
264 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
265 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
266 <div align="right"><a href="#top">Up</a></div>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
267 <hr />
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
268 <hr />
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
269 <a NAME="codeStyleBatchCheck" ID="codeStyleBatchCheck"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
270 <h2>codeStyleBatchCheck</h2>
5762
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
271 <b>codeStyleBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
272
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
273 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
274 Module function to check code style for a batch of files.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
275 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
276 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
277
5762
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
278 <dt><i>argumentsList</i> (list)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
279 <dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
280 list of arguments tuples as given for codeStyleCheck
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
281 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
282 <dt><i>send</i> (func)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
283 <dd>
5762
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
284 reference to send function
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
285 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
286 <dt><i>fx</i> (str)</dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
287 <dd>
5762
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
288 registered service name
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
289 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
290 <dt><i>cancelled</i> (func)</dt>
4222
1db92cbf62c9 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
291 <dd>
1db92cbf62c9 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4218
diff changeset
292 reference to function checking for a cancellation
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
293 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
294 <dt><i>maxProcesses</i> (int)</dt>
5762
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
295 <dd>
76ef5f340007 Added functionality to limit the number of processes used for bachground services.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5737
diff changeset
296 number of processes to be used
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
297 </dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
298 </dl>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
299 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
300 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
301 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
302 <a NAME="codeStyleCheck" ID="codeStyleCheck"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
303 <h2>codeStyleCheck</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
304 <b>codeStyleCheck</b>(<i>filename, source, args</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
305
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
306 <p>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
307 Do the code style check and/or fix found errors.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
308 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
309 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
310
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
311 <dt><i>filename</i> (str)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
312 <dd>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
313 source filename
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
314 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
315 <dt><i>source</i> (str)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
316 <dd>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
317 string containing the code to check
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
318 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
319 <dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
320 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
321 arguments used by the codeStyleCheck function (list of
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
322 excludeMessages, includeMessages, repeatMessages, fixCodes,
6807
7e5eba19d86d Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6264
diff changeset
323 noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines,
7e5eba19d86d Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6264
diff changeset
324 hangClosing, docType, codeComplexityArgs, miscellaneousArgs, errors,
7e5eba19d86d Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6264
diff changeset
325 eol, encoding, backup)
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
326 bool, str, dict, dict, list of str, str, str, bool)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
327 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
328 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
329 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
330 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
331 <dd>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
332 tuple of statistics (dict) and list of results (tuple for each
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
333 found violation of style (lineno, position, text, ignored, fixed,
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
334 autofixing, fixedMsg))
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
335 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
336 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
337 <dl>
6264
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
338 <dt>Return Type:</dt>
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
339 <dd>
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
340 tuple of (dict, list of tuples of (int, int, str, bool, bool, bool,
04a671fa4adb code style checker: extended the dialog to be able to define the number of blank lines before class and function/method definitions
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5762
diff changeset
341 str))
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
342 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
343 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
344 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
345 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
346 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
347 <a NAME="extractLineFlags" ID="extractLineFlags"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
348 <h2>extractLineFlags</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
349 <b>extractLineFlags</b>(<i>line, startComment="</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
350
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
351 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
352 Function to extract flags starting and ending with '__' from a line
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
353 comment.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
354 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
355 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
356
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
357 <dt><i>line</i></dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
358 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
359 line to extract flags from (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
360 </dd>
7900
72b88fb20261 Corrected the use of '@keyparam' in the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7624
diff changeset
361 <dt><i>startComment</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
362 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
363 string identifying the start of the comment (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
364 </dd>
7900
72b88fb20261 Corrected the use of '@keyparam' in the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7624
diff changeset
365 <dt><i>endComment</i></dt>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
366 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
367 string identifying the end of a comment (string)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
368 </dd>
7900
72b88fb20261 Corrected the use of '@keyparam' in the source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7624
diff changeset
369 <dt><i>flagsLine</i></dt>
5586
0e5421d679e7 Added capability to place line flags (e.g. __IGNORE...) on the line following the one to be ignored.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5147
diff changeset
370 <dd>
0e5421d679e7 Added capability to place line flags (e.g. __IGNORE...) on the line following the one to be ignored.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5147
diff changeset
371 flag indicating to check for a flags only line (bool)
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
372 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
373 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
374 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
375 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
376 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
377 list containing the extracted flags (list of strings)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
378 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
379 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
380 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
381 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
382 <hr />
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
383 <a NAME="ignoreCode" ID="ignoreCode"></a>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
384 <h2>ignoreCode</h2>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
385 <b>ignoreCode</b>(<i>code, lineFlags</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
386
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
387 <p>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
388 Function to check, if the given code should be ignored as per line flags.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
389 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
390 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
391
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
392 <dt><i>code</i> (str)</dt>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
393 <dd>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
394 error code to be checked
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
395 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
396 <dt><i>lineFlags</i> (list of str)</dt>
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
397 <dd>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
398 list of line flags to check against
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
399 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
400 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
401 <dl>
5737
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
402 <dt>Returns:</dt>
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
403 <dd>
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
404 flag indicating to ignore the code
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
405 </dd>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
406 </dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
407 <dl>
5737
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
408 <dt>Return Type:</dt>
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
409 <dd>
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
410 bool
6820ae39114e Fixed a source docu issue.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5727
diff changeset
411 </dd>
5727
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
412 </dl>
c8842a8d1167 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5662
diff changeset
413 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
414 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
415 <hr />
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
416 <a NAME="initBatchService" ID="initBatchService"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
417 <h2>initBatchService</h2>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
418 <b>initBatchService</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
419
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
420 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
421 Initialize the batch service and return the entry point.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
422 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
423 <dl>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
424 <dt>Returns:</dt>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
425 <dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
426 the entry point for the background client (function)
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
427 </dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
428 </dl>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
429 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
430 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
431 <hr />
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
432 <a NAME="initService" ID="initService"></a>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
433 <h2>initService</h2>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
434 <b>initService</b>(<i></i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
435
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
436 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
437 Initialize the service and return the entry point.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
438 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
439 <dl>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
440 <dt>Returns:</dt>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
441 <dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
442 the entry point for the background client (function)
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
443 </dd>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
444 </dl>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
445 <div align="right"><a href="#top">Up</a></div>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
446 <hr />
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
447 <hr />
7624
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
448 <a NAME="securityOk" ID="securityOk"></a>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
449 <h2>securityOk</h2>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
450 <b>securityOk</b>(<i>code, lineFlags</i>)
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
451
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
452 <p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
453 Function to check, if the given code is an acknowledged security report.
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
454 </p>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
455 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
456
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
457 <dt><i>code</i> (str)</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
458 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
459 error code to be checked
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
460 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
461 <dt><i>lineFlags</i> (list of str)</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
462 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
463 list of line flags to check against
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
464 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
465 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
466 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
467 <dt>Returns:</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
468 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
469 flag indicating an acknowledged security report
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
470 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
471 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
472 <dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
473 <dt>Return Type:</dt>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
474 <dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
475 bool
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
476 </dd>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
477 </dl>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
478 <div align="right"><a href="#top">Up</a></div>
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
479 <hr />
6eabbcf3bdf8 Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7610
diff changeset
480 <hr />
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
481 <a NAME="worker" ID="worker"></a>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
482 <h2>worker</h2>
5606
da305d172769 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5586
diff changeset
483 <b>worker</b>(<i>inputQueue, outputQueue</i>)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
484
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
485 <p>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
486 Module function acting as the parallel worker for the style check.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
487 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
488 <dl>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
489
5606
da305d172769 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5586
diff changeset
490 <dt><i>inputQueue</i></dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
491 <dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
492 input queue (multiprocessing.Queue)
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
493 </dd>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7247
diff changeset
494 <dt><i>outputQueue</i></dt>
4218
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
495 <dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
496 output queue (multiprocessing.Queue)
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
497 </dd>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
498 </dl>
f542ad1f76c5 Added a batch mode to the code style checker to make use of multiple CPUs/CPU-Cores.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
499 <div align="right"><a href="#top">Up</a></div>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
500 <hr />
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
501 </body></html>

eric ide

mercurial