eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker

Module implementing the code style checker.

Global Attributes

Classes

Functions

CodeStyleCheckerReport

Class implementing a special report to be used with our dialog.

Derived from

Class Attributes

Class Methods

Methods

Static Methods

CodeStyleCheckerReport (Constructor)

Constructor

options

options for the report (optparse.Values)

CodeStyleCheckerReport.error_args

Public method to collect the error messages.

line_number

line number of the issue (integer)

offset

position within line of the issue (integer)

code

message code (string)

check

reference to the checker function (function)

args

arguments for the message (list)

Returns:

error code (string)

__checkCodeStyle

Private module function to perform the code style check and/or fix found errors.

filename (str)

source filename

source (str)

string containing the code to check

args (list of (str, str, bool, str, str, bool, int, list of (int, int),)

arguments used by the codeStyleCheck function (list of excludeMessages, includeMessages, repeatMessages, fixCodes, noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines, hangClosing, docType, codeComplexityArgs, miscellaneousArgs, annotationArgs, securityArgs, errors, eol, encoding, backup) bool, str, dict, dict, dict, list of str, str, str, bool)

Returns:

tuple of statistics data and list of result dictionaries with keys:

• file: file name
• line: line_number
• offset: offset within line
• code: message code
• args: list of arguments to format the message
• ignored: flag indicating this issue was ignored
• fixed: flag indicating this issue was fixed
• autofixing: flag indicating that a fix can be done
• fixcode: message code for the fix
• fixargs: list of arguments to format the fix message

Return Type:

tuple of (dict, list of dict)

__checkSyntax

Private module function to perform a syntax check.

filename (str)

source filename

source (str)

string containing the code to check

Returns:

tuple containing the error dictionary with syntax error details and a statistics dictionary or a tuple containing two None

Return Type:

tuple of (dict, dict) or tuple of (None, None)

codeStyleBatchCheck

Module function to check code style for a batch of files.

argumentsList (list)

list of arguments tuples as given for codeStyleCheck

send (func)

reference to send function

fx (str)

registered service name

cancelled (func)

reference to function checking for a cancellation

maxProcesses (int)

number of processes to be used

codeStyleCheck

Do the code style check and/or fix found errors.

filename (str)

source filename

source (str)

string containing the code to check

args (list of (str, str, bool, str, str, bool, int, list of (int, int),)

arguments used by the codeStyleCheck function (list of excludeMessages, includeMessages, repeatMessages, fixCodes, noFixCodes, fixIssues, maxLineLength, maxDocLineLength, blankLines, hangClosing, docType, codeComplexityArgs, miscellaneousArgs, errors, eol, encoding, backup) bool, str, dict, dict, list of str, str, str, bool)

Returns:

tuple of statistics (dict) and list of results (tuple for each found violation of style (lineno, position, text, ignored, fixed, autofixing, fixedMsg))

Return Type:

tuple of (dict, list of tuples of (int, int, str, bool, bool, bool, str))

extractLineFlags

Function to extract flags starting and ending with '__' from a line comment.

line

line to extract flags from (string)

startComment=

string identifying the start of the comment (string)

endComment=

string identifying the end of a comment (string)

flagsLine=

flag indicating to check for a flags only line (bool)

Returns:

list containing the extracted flags (list of strings)

ignoreCode

Function to check, if the given code should be ignored as per line flags.

code (str)

error code to be checked

lineFlags (list of str)

list of line flags to check against

Returns:

flag indicating to ignore the code

Return Type:

bool

initBatchService

Initialize the batch service and return the entry point.

Returns:

the entry point for the background client (function)

initService

Initialize the service and return the entry point.

Returns:

the entry point for the background client (function)

securityOk

Function to check, if the given code is an acknowledged security report.

code (str)

error code to be checked

lineFlags (list of str)

list of line flags to check against

Returns:

flag indicating an acknowledged security report

Return Type:

bool

worker

Module function acting as the parallel worker for the style check.

inputQueue

input queue (multiprocessing.Queue)

outputQueue

output queue (multiprocessing.Queue)