src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</h1>
<p>
Module implementing the syntax check for YAML.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#__yamlSyntaxCheck">__yamlSyntaxCheck</a></td>
<td>Function to check a YAML source file for syntax errors.</td>
</tr>
<tr>
<td><a href="#initBatchService">initBatchService</a></td>
<td>Initialize the batch service and return the entry point.</td>
</tr>
<tr>
<td><a href="#initService">initService</a></td>
<td>Initialize the service and return the entry point.</td>
</tr>
<tr>
<td><a href="#workerTask">workerTask</a></td>
<td>Module function acting as the parallel worker for the syntax check.</td>
</tr>
<tr>
<td><a href="#yamlSyntaxBatchCheck">yamlSyntaxBatchCheck</a></td>
<td>Module function to check syntax for a batch of files.</td>
</tr>
<tr>
<td><a href="#yamlSyntaxCheck">yamlSyntaxCheck</a></td>
<td>Function to check a YAML source file for syntax errors.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="__yamlSyntaxCheck" ID="__yamlSyntaxCheck"></a>
<h2>__yamlSyntaxCheck</h2>
<b>__yamlSyntaxCheck</b>(<i>file, codestring</i>)
<p>
    Function to check a YAML source file for syntax errors.
</p>

<dl>

<dt><i>file</i> (str)</dt>
<dd>
source filename
</dd>
<dt><i>codestring</i> (str)</dt>
<dd>
string containing the code to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of dictionaries  with the key 'error' which contain a tuple with
        details about the syntax error. Each tuple contains the file name, line
        number, column, code string and the error message.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="initBatchService" ID="initBatchService"></a>
<h2>initBatchService</h2>
<b>initBatchService</b>(<i></i>)
<p>
    Initialize the batch service and return the entry point.
</p>

<dl>
<dt>Return:</dt>
<dd>
the entry point for the background client
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
function
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="initService" ID="initService"></a>
<h2>initService</h2>
<b>initService</b>(<i></i>)
<p>
    Initialize the service and return the entry point.
</p>

<dl>
<dt>Return:</dt>
<dd>
the entry point for the background client
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
function
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="workerTask" ID="workerTask"></a>
<h2>workerTask</h2>
<b>workerTask</b>(<i>inputQueue, outputQueue</i>)
<p>
    Module function acting as the parallel worker for the syntax check.
</p>

<dl>

<dt><i>inputQueue</i> (multiprocessing.Queue)</dt>
<dd>
input queue
</dd>
<dt><i>outputQueue</i> (multiprocessing.Queue)</dt>
<dd>
output queue
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="yamlSyntaxBatchCheck" ID="yamlSyntaxBatchCheck"></a>
<h2>yamlSyntaxBatchCheck</h2>
<b>yamlSyntaxBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
<p>
    Module function to check syntax for a batch of files.
</p>

<dl>

<dt><i>argumentsList</i> (list)</dt>
<dd>
list of arguments tuples as given for yamlSyntaxCheck
</dd>
<dt><i>send</i> (function)</dt>
<dd>
reference to send function
</dd>
<dt><i>fx</i> (str)</dt>
<dd>
registered service name
</dd>
<dt><i>cancelled</i> (function)</dt>
<dd>
reference to function checking for a cancellation
</dd>
<dt><i>maxProcesses</i> (int)</dt>
<dd>
number of processes to be used
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="yamlSyntaxCheck" ID="yamlSyntaxCheck"></a>
<h2>yamlSyntaxCheck</h2>
<b>yamlSyntaxCheck</b>(<i>file, codestring</i>)
<p>
    Function to check a YAML source file for syntax errors.
</p>

<dl>

<dt><i>file</i> (str)</dt>
<dd>
source filename
</dd>
<dt><i>codestring</i> (str)</dt>
<dd>
string containing the code to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of dictionaries  with the key 'error' which contain a tuple with
        details about the syntax error. Each tuple contains the file name, line
        number, column, code string and the error message.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>