Documentation/Source/eric6.Plugins.PluginCodeStyleChecker.html

changeset 6264
04a671fa4adb
parent 4503
d68dcbe1deb3
equal deleted inserted replaced
6263:4dd53711d869 6264:04a671fa4adb
338 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4> 338 <h4>CodeStyleCheckerPlugin.styleBatchCheck</h4>
339 <b>styleBatchCheck</b>(<i>argumentsList</i>) 339 <b>styleBatchCheck</b>(<i>argumentsList</i>)
340 <p> 340 <p>
341 Public method to prepare a style check on multiple Python source files. 341 Public method to prepare a style check on multiple Python source files.
342 </p><dl> 342 </p><dl>
343 <dt><i>argumentsList</i></dt> 343 <dt><i>argumentsList</i> (list of tuple of (str, str, list))</dt>
344 <dd> 344 <dd>
345 list of arguments tuples with each tuple 345 list of arguments tuples with each tuple
346 containing filename, source and args as given in styleCheck() 346 containing filename, source and args as given in styleCheck()
347 method 347 method
348 </dd> 348 </dd>
350 <h4>CodeStyleCheckerPlugin.styleCheck</h4> 350 <h4>CodeStyleCheckerPlugin.styleCheck</h4>
351 <b>styleCheck</b>(<i>lang, filename, source, args</i>) 351 <b>styleCheck</b>(<i>lang, filename, source, args</i>)
352 <p> 352 <p>
353 Public method to prepare a style check on one Python source file. 353 Public method to prepare a style check on one Python source file.
354 </p><dl> 354 </p><dl>
355 <dt><i>lang</i></dt> 355 <dt><i>lang</i> (str or None)</dt>
356 <dd> 356 <dd>
357 language of the file or None to determine by internal 357 language of the file or None to determine by internal
358 algorithm (str or None) 358 algorithm
359 </dd><dt><i>filename</i></dt> 359 </dd><dt><i>filename</i> (str)</dt>
360 <dd> 360 <dd>
361 source filename (string) 361 source filename
362 </dd><dt><i>source</i></dt> 362 </dd><dt><i>source</i> (str)</dt>
363 <dd> 363 <dd>
364 string containing the code to check (string) 364 string containing the code to check
365 </dd><dt><i>args</i></dt> 365 </dd><dt><i>args</i> (list of (str, str, bool, str, str, bool, int, list of (int, int),)</dt>
366 <dd> 366 <dd>
367 arguments used by the codeStyleCheck function (list of 367 arguments used by the codeStyleCheck function (list of
368 excludeMessages (str), includeMessages (str), repeatMessages 368 excludeMessages, includeMessages, repeatMessages, fixCodes,
369 (bool), fixCodes (str), noFixCodes (str), fixIssues (bool), 369 noFixCodes, fixIssues, maxLineLength, blankLines, hangClosing,
370 maxLineLength (int), hangClosing (bool), docType (str), errors 370 docType, codeComplexityArgs, miscellaneousArgs, errors, eol,
371 (list of str), eol (str), encoding (str)) 371 encoding, backup)
372 bool, str, dict, dict, list of str, str, str, bool)
372 </dd> 373 </dd>
373 </dl> 374 </dl>
374 <div align="right"><a href="#top">Up</a></div> 375 <div align="right"><a href="#top">Up</a></div>
375 <hr /> 376 <hr />
376 </body></html> 377 </body></html>

eric ide

mercurial