eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.CheckerPlugins.SyntaxChecker.yamlCheckSyntax</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.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="#normalizeCode">normalizeCode</a></td>
<td>Function to normalize the given code.</td>
</tr>
<tr>
<td><a href="#worker">worker</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>
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)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
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>
func
</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>
func
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="normalizeCode" ID="normalizeCode"></a>
<h2>normalizeCode</h2>
<b>normalizeCode</b>(<i>codestring</i>)

<p>
    Function to normalize the given code.
</p>
<dl>

<dt><i>codestring</i> (str)</dt>
<dd>
code to be normalized
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
normalized code
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="worker" ID="worker"></a>
<h2>worker</h2>
<b>worker</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> (func)</dt>
<dd>
reference to send function
</dd>
<dt><i>fx</i> (str)</dt>
<dd>
registered service name
</dd>
<dt><i>cancelled</i> (func)</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>
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)
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>