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

changeset 7989
a21d673a8f99
parent 7784
3257703e10c5
child 8215
fc5d68a6889e
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
183 <dd> 183 <dd>
184 list of parent nodes 184 list of parent nodes
185 </dd> 185 </dd>
186 </dl> 186 </dl>
187 <dl> 187 <dl>
188 <dt>Returns:</dt> 188 <dt>Yield:</dt>
189 <dd> 189 <dd>
190 tuple giving line number, offset within line and error code 190 tuple giving line number, offset within line and error code
191 (integer, integer, string) 191 </dd>
192 </dl>
193 <dl>
194 <dt>Yield Type:</dt>
195 <dd>
196 tuple of (int, int, str)
192 </dd> 197 </dd>
193 </dl> 198 </dl>
194 <a NAME="NamingStyleChecker.__checkFunctionArgumentNames" ID="NamingStyleChecker.__checkFunctionArgumentNames"></a> 199 <a NAME="NamingStyleChecker.__checkFunctionArgumentNames" ID="NamingStyleChecker.__checkFunctionArgumentNames"></a>
195 <h4>NamingStyleChecker.__checkFunctionArgumentNames</h4> 200 <h4>NamingStyleChecker.__checkFunctionArgumentNames</h4>
196 <b>__checkFunctionArgumentNames</b>(<i>node, parents</i>) 201 <b>__checkFunctionArgumentNames</b>(<i>node, parents</i>)
214 <dd> 219 <dd>
215 list of parent nodes 220 list of parent nodes
216 </dd> 221 </dd>
217 </dl> 222 </dl>
218 <dl> 223 <dl>
219 <dt>Returns:</dt> 224 <dt>Yield:</dt>
220 <dd> 225 <dd>
221 tuple giving line number, offset within line and error code 226 tuple giving line number, offset within line and error code
222 (integer, integer, string) 227 </dd>
228 </dl>
229 <dl>
230 <dt>Yield Type:</dt>
231 <dd>
232 tuple of (int, int, str)
223 </dd> 233 </dd>
224 </dl> 234 </dl>
225 <a NAME="NamingStyleChecker.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a> 235 <a NAME="NamingStyleChecker.__checkFunctionName" ID="NamingStyleChecker.__checkFunctionName"></a>
226 <h4>NamingStyleChecker.__checkFunctionName</h4> 236 <h4>NamingStyleChecker.__checkFunctionName</h4>
227 <b>__checkFunctionName</b>(<i>node, parents</i>) 237 <b>__checkFunctionName</b>(<i>node, parents</i>)
247 <dd> 257 <dd>
248 list of parent nodes 258 list of parent nodes
249 </dd> 259 </dd>
250 </dl> 260 </dl>
251 <dl> 261 <dl>
252 <dt>Returns:</dt> 262 <dt>Yield:</dt>
253 <dd> 263 <dd>
254 tuple giving line number, offset within line and error code 264 tuple giving line number, offset within line and error code
255 (integer, integer, string) 265 </dd>
266 </dl>
267 <dl>
268 <dt>Yield Type:</dt>
269 <dd>
270 tuple of (int, int, str)
256 </dd> 271 </dd>
257 </dl> 272 </dl>
258 <a NAME="NamingStyleChecker.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a> 273 <a NAME="NamingStyleChecker.__checkImportAs" ID="NamingStyleChecker.__checkImportAs"></a>
259 <h4>NamingStyleChecker.__checkImportAs</h4> 274 <h4>NamingStyleChecker.__checkImportAs</h4>
260 <b>__checkImportAs</b>(<i>node, parents</i>) 275 <b>__checkImportAs</b>(<i>node, parents</i>)
273 <dd> 288 <dd>
274 list of parent nodes 289 list of parent nodes
275 </dd> 290 </dd>
276 </dl> 291 </dl>
277 <dl> 292 <dl>
278 <dt>Returns:</dt> 293 <dt>Yield:</dt>
279 <dd> 294 <dd>
280 tuple giving line number, offset within line and error code 295 tuple giving line number, offset within line and error code
281 (integer, integer, string) 296 </dd>
297 </dl>
298 <dl>
299 <dt>Yield Type:</dt>
300 <dd>
301 tuple of (int, int, str)
282 </dd> 302 </dd>
283 </dl> 303 </dl>
284 <a NAME="NamingStyleChecker.__checkModule" ID="NamingStyleChecker.__checkModule"></a> 304 <a NAME="NamingStyleChecker.__checkModule" ID="NamingStyleChecker.__checkModule"></a>
285 <h4>NamingStyleChecker.__checkModule</h4> 305 <h4>NamingStyleChecker.__checkModule</h4>
286 <b>__checkModule</b>(<i>node, parents</i>) 306 <b>__checkModule</b>(<i>node, parents</i>)
301 <dd> 321 <dd>
302 list of parent nodes 322 list of parent nodes
303 </dd> 323 </dd>
304 </dl> 324 </dl>
305 <dl> 325 <dl>
306 <dt>Returns:</dt> 326 <dt>Yield:</dt>
307 <dd> 327 <dd>
308 tuple giving line number, offset within line and error code 328 tuple giving line number, offset within line and error code
309 (integer, integer, string) 329 </dd>
330 </dl>
331 <dl>
332 <dt>Yield Type:</dt>
333 <dd>
334 tuple of (int, int, str)
310 </dd> 335 </dd>
311 </dl> 336 </dl>
312 <a NAME="NamingStyleChecker.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a> 337 <a NAME="NamingStyleChecker.__checkNameToBeAvoided" ID="NamingStyleChecker.__checkNameToBeAvoided"></a>
313 <h4>NamingStyleChecker.__checkNameToBeAvoided</h4> 338 <h4>NamingStyleChecker.__checkNameToBeAvoided</h4>
314 <b>__checkNameToBeAvoided</b>(<i>node, parents</i>) 339 <b>__checkNameToBeAvoided</b>(<i>node, parents</i>)
326 <dd> 351 <dd>
327 list of parent nodes 352 list of parent nodes
328 </dd> 353 </dd>
329 </dl> 354 </dl>
330 <dl> 355 <dl>
331 <dt>Returns:</dt> 356 <dt>Yield:</dt>
332 <dd> 357 <dd>
333 tuple giving line number, offset within line and error code 358 tuple giving line number, offset within line and error code
334 (integer, integer, string) 359 </dd>
360 </dl>
361 <dl>
362 <dt>Yield Type:</dt>
363 <dd>
364 tuple of (int, int, str)
335 </dd> 365 </dd>
336 </dl> 366 </dl>
337 <a NAME="NamingStyleChecker.__checkVariablesInFunction" ID="NamingStyleChecker.__checkVariablesInFunction"></a> 367 <a NAME="NamingStyleChecker.__checkVariablesInFunction" ID="NamingStyleChecker.__checkVariablesInFunction"></a>
338 <h4>NamingStyleChecker.__checkVariablesInFunction</h4> 368 <h4>NamingStyleChecker.__checkVariablesInFunction</h4>
339 <b>__checkVariablesInFunction</b>(<i>node, parents</i>) 369 <b>__checkVariablesInFunction</b>(<i>node, parents</i>)
354 <dd> 384 <dd>
355 list of parent nodes 385 list of parent nodes
356 </dd> 386 </dd>
357 </dl> 387 </dl>
358 <dl> 388 <dl>
359 <dt>Returns:</dt> 389 <dt>Yield:</dt>
360 <dd> 390 <dd>
361 tuple giving line number, offset within line and error code 391 tuple giving line number, offset within line and error code
362 (integer, integer, string) 392 </dd>
393 </dl>
394 <dl>
395 <dt>Yield Type:</dt>
396 <dd>
397 tuple of (int, int, str)
363 </dd> 398 </dd>
364 </dl> 399 </dl>
365 <a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a> 400 <a NAME="NamingStyleChecker.__error" ID="NamingStyleChecker.__error"></a>
366 <h4>NamingStyleChecker.__error</h4> 401 <h4>NamingStyleChecker.__error</h4>
367 <b>__error</b>(<i>node, code</i>) 402 <b>__error</b>(<i>node, code</i>)
379 <dd> 414 <dd>
380 error code to report (string) 415 error code to report (string)
381 </dd> 416 </dd>
382 </dl> 417 </dl>
383 <dl> 418 <dl>
384 <dt>Returns:</dt> 419 <dt>Return:</dt>
385 <dd> 420 <dd>
386 tuple giving line number, offset within line and error code 421 tuple giving line number, offset within line and error code
387 (integer, integer, string) 422 (integer, integer, string)
388 </dd> 423 </dd>
389 </dl> 424 </dl>
414 <dd> 449 <dd>
415 AST node to extract arguments names from 450 AST node to extract arguments names from
416 </dd> 451 </dd>
417 </dl> 452 </dl>
418 <dl> 453 <dl>
419 <dt>Returns:</dt> 454 <dt>Return:</dt>
420 <dd> 455 <dd>
421 list of argument names (list of string) 456 list of argument names (list of string)
422 </dd> 457 </dd>
423 </dl> 458 </dl>
424 <a NAME="NamingStyleChecker.__isNameToBeAvoided" ID="NamingStyleChecker.__isNameToBeAvoided"></a> 459 <a NAME="NamingStyleChecker.__isNameToBeAvoided" ID="NamingStyleChecker.__isNameToBeAvoided"></a>
434 <dd> 469 <dd>
435 name to be checked (string) 470 name to be checked (string)
436 </dd> 471 </dd>
437 </dl> 472 </dl>
438 <dl> 473 <dl>
439 <dt>Returns:</dt> 474 <dt>Return:</dt>
440 <dd> 475 <dd>
441 flag indicating to avoid it (boolen) 476 flag indicating to avoid it (boolen)
442 </dd> 477 </dd>
443 </dl> 478 </dl>
444 <a NAME="NamingStyleChecker.__tagClassFunctions" ID="NamingStyleChecker.__tagClassFunctions"></a> 479 <a NAME="NamingStyleChecker.__tagClassFunctions" ID="NamingStyleChecker.__tagClassFunctions"></a>
469 <dd> 504 <dd>
470 AST tree node to inspect 505 AST tree node to inspect
471 </dd> 506 </dd>
472 </dl> 507 </dl>
473 <dl> 508 <dl>
474 <dt>Returns:</dt> 509 <dt>Yield:</dt>
475 <dd> 510 <dd>
476 tuple giving line number, offset within line, code and 511 tuple giving line number, offset within line and error code
477 checker function 512 </dd>
513 </dl>
514 <dl>
515 <dt>Yield Type:</dt>
516 <dd>
517 tuple of (int, int, str)
478 </dd> 518 </dd>
479 </dl> 519 </dl>
480 <a NAME="NamingStyleChecker.__visitTree" ID="NamingStyleChecker.__visitTree"></a> 520 <a NAME="NamingStyleChecker.__visitTree" ID="NamingStyleChecker.__visitTree"></a>
481 <h4>NamingStyleChecker.__visitTree</h4> 521 <h4>NamingStyleChecker.__visitTree</h4>
482 <b>__visitTree</b>(<i>node</i>) 522 <b>__visitTree</b>(<i>node</i>)
490 <dd> 530 <dd>
491 AST tree node to scan 531 AST tree node to scan
492 </dd> 532 </dd>
493 </dl> 533 </dl>
494 <dl> 534 <dl>
495 <dt>Returns:</dt> 535 <dt>Yield:</dt>
496 <dd> 536 <dd>
497 tuple giving line number, offset within line, code and 537 tuple giving line number, offset within line and error code
498 checker function 538 </dd>
539 </dl>
540 <dl>
541 <dt>Yield Type:</dt>
542 <dd>
543 tuple of (int, int, str)
499 </dd> 544 </dd>
500 </dl> 545 </dl>
501 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a> 546 <a NAME="NamingStyleChecker.run" ID="NamingStyleChecker.run"></a>
502 <h4>NamingStyleChecker.run</h4> 547 <h4>NamingStyleChecker.run</h4>
503 <b>run</b>(<i></i>) 548 <b>run</b>(<i></i>)
504 549
505 <p> 550 <p>
506 Public method run by the pycodestyle.py checker. 551 Public method run by the pycodestyle.py checker.
507 </p> 552 </p>
508 <dl> 553 <dl>
509 <dt>Returns:</dt> 554 <dt>Return:</dt>
510 <dd> 555 <dd>
511 tuple giving line number, offset within line, code and 556 tuple giving line number, offset within line, code and
512 checker function 557 checker function
513 </dd> 558 </dd>
514 </dl> 559 </dl>

eric ide

mercurial