Home ⌂Doc Index ◂Up ▴

eric6.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax

Module implementing the syntax check for YAML.

Global Attributes

None

Classes

None

Functions

__yamlSyntaxCheck Function to check a YAML source file for syntax errors.
initBatchService Initialize the batch service and return the entry point.
initService Initialize the service and return the entry point.
normalizeCode Function to normalize the given code.
worker Module function acting as the parallel worker for the syntax check.
yamlSyntaxBatchCheck Module function to check syntax for a batch of files.
yamlSyntaxCheck Function to check a YAML source file for syntax errors.


__yamlSyntaxCheck

__yamlSyntaxCheck(file, codestring)

Function to check a YAML source file for syntax errors.

file (str)
source filename
codestring (str)
string containing the code to check
Returns:
dictionary with the keys 'error' and 'warnings' which hold a list containing details about the error/ warnings (file name, line number, column, codestring (only at syntax errors), the message, a list with arguments for the message)
Return Type:
dict
Up


initBatchService

initBatchService()

Initialize the batch service and return the entry point.

Returns:
the entry point for the background client
Return Type:
func
Up


initService

initService()

Initialize the service and return the entry point.

Returns:
the entry point for the background client
Return Type:
func
Up


normalizeCode

normalizeCode(codestring)

Function to normalize the given code.

codestring (str)
code to be normalized
Returns:
normalized code
Return Type:
str
Up


worker

worker(inputQueue, outputQueue)

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

inputQueue (multiprocessing.Queue)
input queue
outputQueue (multiprocessing.Queue)
output queue
Up


yamlSyntaxBatchCheck

yamlSyntaxBatchCheck(argumentsList, send, fx, cancelled, maxProcesses=0)

Module function to check syntax for a batch of files.

argumentsList (list)
list of arguments tuples as given for yamlSyntaxCheck
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
Up


yamlSyntaxCheck

yamlSyntaxCheck(file, codestring)

Function to check a YAML source file for syntax errors.

file (str)
source filename
codestring (str)
string containing the code to check
Returns:
dictionary with the keys 'error' and 'warnings' which hold a list containing details about the error/ warnings (file name, line number, column, codestring (only at syntax errors), the message, a list with arguments for the message)
Return Type:
dict
Up



Home ⌂Doc Index ◂Up ▴