Mercurial Repositories > Vulture Checker / file comparison

comparison: VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html

VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.VultureCheckerService.html

changeset 62
4a69da851bd2
parent 51
cf5c3ddc1de3
child 69
3c2922b45a9f
equal deleted inserted replaced
61:9d01e990bb27 62:4a69da851bd2
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerService</h1> 23 <h1>Plugin_Checker_Vulture.VultureChecker.VultureCheckerService</h1>
24
23 <p> 25 <p>
24 Module implementing the cyclomatic complexity service. 26 Module implementing the cyclomatic complexity service.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#EricVulture">EricVulture</a></td> 38 <td><a href="#EricVulture">EricVulture</a></td>
34 <td>Class to adopt the Vulture class to the eric plug-in functionality.</td> 39 <td>Class to adopt the Vulture class to the eric plug-in functionality.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#__analyze">__analyze</a></td> 47 <td><a href="#__analyze">__analyze</a></td>
41 <td>Private function to analyze one Python file.</td> 48 <td>Private function to analyze one Python file.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#batchVultureCheck">batchVultureCheck</a></td> 51 <td><a href="#batchVultureCheck">batchVultureCheck</a></td>
44 <td>Module function to analyze a batch of files.</td> 52 <td>Module function to analyze a batch of files.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#initBatchService">initBatchService</a></td> 55 <td><a href="#initBatchService">initBatchService</a></td>
47 <td>Initialize the batch service and return the entry point.</td> 56 <td>Initialize the batch service and return the entry point.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#initService">initService</a></td> 59 <td><a href="#initService">initService</a></td>
50 <td>Initialize the service and return the entry point.</td> 60 <td>Initialize the service and return the entry point.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#vultureCheck">vultureCheck</a></td> 63 <td><a href="#vultureCheck">vultureCheck</a></td>
53 <td>Private function to analyze one file.</td> 64 <td>Private function to analyze one file.</td>
54 </tr><tr> 65 </tr>
66 <tr>
55 <td><a href="#worker">worker</a></td> 67 <td><a href="#worker">worker</a></td>
56 <td>Module function acting as the parallel worker for the cyclomatic complexity calculation.</td> 68 <td>Module function acting as the parallel worker for the cyclomatic complexity calculation.</td>
57 </tr> 69 </tr>
58 </table> 70 </table>
59 <hr /><hr /> 71 <hr />
72 <hr />
60 <a NAME="EricVulture" ID="EricVulture"></a> 73 <a NAME="EricVulture" ID="EricVulture"></a>
61 <h2>EricVulture</h2> 74 <h2>EricVulture</h2>
75
62 <p> 76 <p>
63 Class to adopt the Vulture class to the eric plug-in functionality. 77 Class to adopt the Vulture class to the eric plug-in functionality.
64 </p> 78 </p>
65 <h3>Derived from</h3> 79 <h3>Derived from</h3>
66 Vulture 80 Vulture
67 <h3>Class Attributes</h3> 81 <h3>Class Attributes</h3>
82
68 <table> 83 <table>
69 <tr><td>None</td></tr> 84 <tr><td>None</td></tr>
70 </table> 85 </table>
71 <h3>Class Methods</h3> 86 <h3>Class Methods</h3>
87
72 <table> 88 <table>
73 <tr><td>None</td></tr> 89 <tr><td>None</td></tr>
74 </table> 90 </table>
75 <h3>Methods</h3> 91 <h3>Methods</h3>
76 <table> 92
93 <table>
94
77 <tr> 95 <tr>
78 <td><a href="#EricVulture.__item2Dict">__item2Dict</a></td> 96 <td><a href="#EricVulture.__item2Dict">__item2Dict</a></td>
79 <td>Private method to convert a vulture item to a dictionary.</td> 97 <td>Private method to convert a vulture item to a dictionary.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#EricVulture.getResults">getResults</a></td> 100 <td><a href="#EricVulture.getResults">getResults</a></td>
82 <td>Public method to get the scan results.</td> 101 <td>Public method to get the scan results.</td>
83 </tr> 102 </tr>
84 </table> 103 </table>
85 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
105
86 <table> 106 <table>
87 <tr><td>None</td></tr> 107 <tr><td>None</td></tr>
88 </table> 108 </table>
109
89 <a NAME="EricVulture.__item2Dict" ID="EricVulture.__item2Dict"></a> 110 <a NAME="EricVulture.__item2Dict" ID="EricVulture.__item2Dict"></a>
90 <h4>EricVulture.__item2Dict</h4> 111 <h4>EricVulture.__item2Dict</h4>
91 <b>__item2Dict</b>(<i>item</i>) 112 <b>__item2Dict</b>(<i>item</i>)
113
92 <p> 114 <p>
93 Private method to convert a vulture item to a dictionary. 115 Private method to convert a vulture item to a dictionary.
94 </p><dl> 116 </p>
117 <dl>
118
95 <dt><i>item</i> (vulture.Item)</dt> 119 <dt><i>item</i> (vulture.Item)</dt>
96 <dd> 120 <dd>
97 vulture item 121 vulture item
98 </dd> 122 </dd>
99 </dl><dl> 123 </dl>
124 <dl>
100 <dt>Returns:</dt> 125 <dt>Returns:</dt>
101 <dd> 126 <dd>
102 item dictionary 127 item dictionary
103 </dd> 128 </dd>
104 </dl><dl> 129 </dl>
130 <dl>
105 <dt>Return Type:</dt> 131 <dt>Return Type:</dt>
106 <dd> 132 <dd>
107 dict 133 dict
108 </dd> 134 </dd>
109 </dl><a NAME="EricVulture.getResults" ID="EricVulture.getResults"></a> 135 </dl>
136 <a NAME="EricVulture.getResults" ID="EricVulture.getResults"></a>
110 <h4>EricVulture.getResults</h4> 137 <h4>EricVulture.getResults</h4>
111 <b>getResults</b>(<i></i>) 138 <b>getResults</b>(<i></i>)
139
112 <p> 140 <p>
113 Public method to get the scan results. 141 Public method to get the scan results.
114 </p><dl> 142 </p>
143 <dl>
115 <dt>Returns:</dt> 144 <dt>Returns:</dt>
116 <dd> 145 <dd>
117 scan results 146 scan results
118 </dd> 147 </dd>
119 </dl><dl> 148 </dl>
149 <dl>
120 <dt>Return Type:</dt> 150 <dt>Return Type:</dt>
121 <dd> 151 <dd>
122 dict 152 dict
123 </dd> 153 </dd>
124 </dl> 154 </dl>
125 <div align="right"><a href="#top">Up</a></div> 155 <div align="right"><a href="#top">Up</a></div>
126 <hr /><hr /> 156 <hr />
157 <hr />
127 <a NAME="__analyze" ID="__analyze"></a> 158 <a NAME="__analyze" ID="__analyze"></a>
128 <h2>__analyze</h2> 159 <h2>__analyze</h2>
129 <b>__analyze</b>(<i>filename, text=""</i>) 160 <b>__analyze</b>(<i>filename, text=""</i>)
161
130 <p> 162 <p>
131 Private function to analyze one Python file. 163 Private function to analyze one Python file.
132 </p><dl> 164 </p>
165 <dl>
166
133 <dt><i>filename</i> (str)</dt> 167 <dt><i>filename</i> (str)</dt>
134 <dd> 168 <dd>
135 source file name 169 source file name
136 </dd><dt><i>text</i> (str)</dt> 170 </dd>
171 <dt><i>text</i> (str)</dt>
137 <dd> 172 <dd>
138 source text 173 source text
139 </dd> 174 </dd>
140 </dl><dl> 175 </dl>
176 <dl>
141 <dt>Returns:</dt> 177 <dt>Returns:</dt>
142 <dd> 178 <dd>
143 tuple containing the result dictionary 179 tuple containing the result dictionary
144 </dd> 180 </dd>
145 </dl><dl> 181 </dl>
182 <dl>
146 <dt>Return Type:</dt> 183 <dt>Return Type:</dt>
147 <dd> 184 <dd>
148 (tuple of dict) 185 (tuple of dict)
149 </dd> 186 </dd>
150 </dl> 187 </dl>
151 <div align="right"><a href="#top">Up</a></div> 188 <div align="right"><a href="#top">Up</a></div>
152 <hr /><hr /> 189 <hr />
190 <hr />
153 <a NAME="batchVultureCheck" ID="batchVultureCheck"></a> 191 <a NAME="batchVultureCheck" ID="batchVultureCheck"></a>
154 <h2>batchVultureCheck</h2> 192 <h2>batchVultureCheck</h2>
155 <b>batchVultureCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>) 193 <b>batchVultureCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
194
156 <p> 195 <p>
157 Module function to analyze a batch of files. 196 Module function to analyze a batch of files.
158 </p><dl> 197 </p>
198 <dl>
199
159 <dt><i>argumentsList</i> (list)</dt> 200 <dt><i>argumentsList</i> (list)</dt>
160 <dd> 201 <dd>
161 list of arguments tuples as given for vultureCheck 202 list of arguments tuples as given for vultureCheck
162 </dd><dt><i>send</i> (function)</dt> 203 </dd>
204 <dt><i>send</i> (function)</dt>
163 <dd> 205 <dd>
164 reference to send function 206 reference to send function
165 </dd><dt><i>fx</i> (str)</dt> 207 </dd>
208 <dt><i>fx</i> (str)</dt>
166 <dd> 209 <dd>
167 registered service name 210 registered service name
168 </dd><dt><i>cancelled</i> (function)</dt> 211 </dd>
212 <dt><i>cancelled</i> (function)</dt>
169 <dd> 213 <dd>
170 reference to function checking for a cancellation 214 reference to function checking for a cancellation
171 </dd><dt><i>maxProcesses</i> (int)</dt> 215 </dd>
216 <dt><i>maxProcesses</i> (int)</dt>
172 <dd> 217 <dd>
173 number of processes to be used 218 number of processes to be used
174 </dd> 219 </dd>
175 </dl> 220 </dl>
176 <div align="right"><a href="#top">Up</a></div> 221 <div align="right"><a href="#top">Up</a></div>
177 <hr /><hr /> 222 <hr />
223 <hr />
178 <a NAME="initBatchService" ID="initBatchService"></a> 224 <a NAME="initBatchService" ID="initBatchService"></a>
179 <h2>initBatchService</h2> 225 <h2>initBatchService</h2>
180 <b>initBatchService</b>(<i></i>) 226 <b>initBatchService</b>(<i></i>)
227
181 <p> 228 <p>
182 Initialize the batch service and return the entry point. 229 Initialize the batch service and return the entry point.
183 </p><dl> 230 </p>
231 <dl>
184 <dt>Returns:</dt> 232 <dt>Returns:</dt>
185 <dd> 233 <dd>
186 the entry point for the background client (function) 234 the entry point for the background client (function)
187 </dd> 235 </dd>
188 </dl> 236 </dl>
189 <div align="right"><a href="#top">Up</a></div> 237 <div align="right"><a href="#top">Up</a></div>
190 <hr /><hr /> 238 <hr />
239 <hr />
191 <a NAME="initService" ID="initService"></a> 240 <a NAME="initService" ID="initService"></a>
192 <h2>initService</h2> 241 <h2>initService</h2>
193 <b>initService</b>(<i></i>) 242 <b>initService</b>(<i></i>)
243
194 <p> 244 <p>
195 Initialize the service and return the entry point. 245 Initialize the service and return the entry point.
196 </p><dl> 246 </p>
247 <dl>
197 <dt>Returns:</dt> 248 <dt>Returns:</dt>
198 <dd> 249 <dd>
199 the entry point for the background client (function) 250 the entry point for the background client (function)
200 </dd> 251 </dd>
201 </dl> 252 </dl>
202 <div align="right"><a href="#top">Up</a></div> 253 <div align="right"><a href="#top">Up</a></div>
203 <hr /><hr /> 254 <hr />
255 <hr />
204 <a NAME="vultureCheck" ID="vultureCheck"></a> 256 <a NAME="vultureCheck" ID="vultureCheck"></a>
205 <h2>vultureCheck</h2> 257 <h2>vultureCheck</h2>
206 <b>vultureCheck</b>(<i>file, text=""</i>) 258 <b>vultureCheck</b>(<i>file, text=""</i>)
259
207 <p> 260 <p>
208 Private function to analyze one file. 261 Private function to analyze one file.
209 </p><dl> 262 </p>
263 <dl>
264
210 <dt><i>file</i> (str)</dt> 265 <dt><i>file</i> (str)</dt>
211 <dd> 266 <dd>
212 source filename 267 source filename
213 </dd><dt><i>text</i> (str)</dt> 268 </dd>
269 <dt><i>text</i> (str)</dt>
214 <dd> 270 <dd>
215 source text 271 source text
216 </dd> 272 </dd>
217 </dl><dl> 273 </dl>
274 <dl>
218 <dt>Returns:</dt> 275 <dt>Returns:</dt>
219 <dd> 276 <dd>
220 tuple containing the result dictionary 277 tuple containing the result dictionary
221 </dd> 278 </dd>
222 </dl><dl> 279 </dl>
280 <dl>
223 <dt>Return Type:</dt> 281 <dt>Return Type:</dt>
224 <dd> 282 <dd>
225 (tuple of dict) 283 (tuple of dict)
226 </dd> 284 </dd>
227 </dl> 285 </dl>
228 <div align="right"><a href="#top">Up</a></div> 286 <div align="right"><a href="#top">Up</a></div>
229 <hr /><hr /> 287 <hr />
288 <hr />
230 <a NAME="worker" ID="worker"></a> 289 <a NAME="worker" ID="worker"></a>
231 <h2>worker</h2> 290 <h2>worker</h2>
232 <b>worker</b>(<i>inputQueue, outputQueue</i>) 291 <b>worker</b>(<i>inputQueue, outputQueue</i>)
292
233 <p> 293 <p>
234 Module function acting as the parallel worker for the cyclomatic 294 Module function acting as the parallel worker for the cyclomatic
235 complexity calculation. 295 complexity calculation.
236 </p><dl> 296 </p>
297 <dl>
298
237 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt> 299 <dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
238 <dd> 300 <dd>
239 input queue 301 input queue
240 </dd><dt><i>outputQueue</i> (multiprocessing.Queue)</dt> 302 </dd>
303 <dt><i>outputQueue</i> (multiprocessing.Queue)</dt>
241 <dd> 304 <dd>
242 output queue 305 output queue
243 </dd> 306 </dd>
244 </dl> 307 </dl>
245 <div align="right"><a href="#top">Up</a></div> 308 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: Vulture Checker

eric ide

mercurial