Mercurial Repositories > eric / file diff

diff: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7336
0095e231ddaf
--- a/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,70 +18,91 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheck</h1>
+
 <p>
 Module implementing the syntax check for Python 2/3.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>VcsConflictMarkerRegExpList</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Functions</h3>
+
 <table>
+
 <tr>
 <td><a href="#__syntaxAndPyflakesCheck">__syntaxAndPyflakesCheck</a></td>
 <td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#extractLineFlags">extractLineFlags</a></td>
 <td>Function to extract flags starting and ending with '__' from a line comment.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#initBatchService">initBatchService</a></td>
 <td>Initialize the batch service and return the entry point.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#initService">initService</a></td>
 <td>Initialize the service and return the entry point.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#normalizeCode">normalizeCode</a></td>
 <td>Function to normalize the given code.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#syntaxAndPyflakesBatchCheck">syntaxAndPyflakesBatchCheck</a></td>
 <td>Module function to check syntax for a batch of files.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#syntaxAndPyflakesCheck">syntaxAndPyflakesCheck</a></td>
 <td>Function to compile one Python source file to Python bytecode and to perform a pyflakes check.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#worker">worker</a></td>
 <td>Module function acting as the parallel worker for the style check.</td>
 </tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="__syntaxAndPyflakesCheck" ID="__syntaxAndPyflakesCheck"></a>
 <h2>__syntaxAndPyflakesCheck</h2>
 <b>__syntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False</i>)
+
 <p>
     Function to compile one Python source file to Python bytecode
     and to perform a pyflakes check.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>filename</i></dt>
 <dd>
 source filename (string)
-</dd><dt><i>codestring</i></dt>
+</dd>
+<dt><i>codestring</i></dt>
 <dd>
 string containing the code to compile (string)
-</dd><dt><i>checkFlakes=</i></dt>
+</dd>
+<dt><i>checkFlakes=</i></dt>
 <dd>
 flag indicating to do a pyflakes check (boolean)
-</dd><dt><i>ignoreStarImportWarnings=</i></dt>
+</dd>
+<dt><i>ignoreStarImportWarnings=</i></dt>
 <dd>
 flag indicating to
         ignore 'star import' warnings (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 dictionary with the keys 'error' and 'warnings' which
@@ -91,127 +112,162 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="extractLineFlags" ID="extractLineFlags"></a>
 <h2>extractLineFlags</h2>
 <b>extractLineFlags</b>(<i>line, startComment="</i>)
+
 <p>
     Function to extract flags starting and ending with '__' from a line
     comment.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>line</i></dt>
 <dd>
 line to extract flags from (string)
-</dd><dt><i>startComment=</i></dt>
+</dd>
+<dt><i>startComment=</i></dt>
 <dd>
 string identifying the start of the comment (string)
-</dd><dt><i>endComment=</i></dt>
+</dd>
+<dt><i>endComment=</i></dt>
 <dd>
 string identifying the end of a comment (string)
-</dd><dt><i>flagsLine=</i></dt>
+</dd>
+<dt><i>flagsLine=</i></dt>
 <dd>
 flag indicating to check for a flags only line (bool)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 list containing the extracted flags (list of strings)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 the entry point for the background client (function)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 the entry point for the background client (function)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
+
 <dt><i>codestring</i></dt>
 <dd>
 code to be normalized (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 normalized code (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="syntaxAndPyflakesBatchCheck" ID="syntaxAndPyflakesBatchCheck"></a>
 <h2>syntaxAndPyflakesBatchCheck</h2>
 <b>syntaxAndPyflakesBatchCheck</b>(<i>argumentsList, send, fx, cancelled, maxProcesses=0</i>)
+
 <p>
     Module function to check syntax for a batch of files.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>argumentsList</i> (list)</dt>
 <dd>
 list of arguments tuples as given for
         syntaxAndPyflakesCheck
-</dd><dt><i>send</i> (func)</dt>
+</dd>
+<dt><i>send</i> (func)</dt>
 <dd>
 reference to send function
-</dd><dt><i>fx</i> (str)</dt>
+</dd>
+<dt><i>fx</i> (str)</dt>
 <dd>
 registered service name
-</dd><dt><i>cancelled</i> (func)</dt>
+</dd>
+<dt><i>cancelled</i> (func)</dt>
 <dd>
 reference to function checking for a cancellation
-</dd><dt><i>maxProcesses</i> (int)</dt>
+</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 />
+<hr />
+<hr />
 <a NAME="syntaxAndPyflakesCheck" ID="syntaxAndPyflakesCheck"></a>
 <h2>syntaxAndPyflakesCheck</h2>
 <b>syntaxAndPyflakesCheck</b>(<i>filename, codestring, checkFlakes=True, ignoreStarImportWarnings=False</i>)
+
 <p>
     Function to compile one Python source file to Python bytecode
     and to perform a pyflakes check.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>filename</i></dt>
 <dd>
 source filename (string)
-</dd><dt><i>codestring</i></dt>
+</dd>
+<dt><i>codestring</i></dt>
 <dd>
 string containing the code to compile (string)
-</dd><dt><i>checkFlakes=</i></dt>
+</dd>
+<dt><i>checkFlakes=</i></dt>
 <dd>
 flag indicating to do a pyflakes check (boolean)
-</dd><dt><i>ignoreStarImportWarnings=</i></dt>
+</dd>
+<dt><i>ignoreStarImportWarnings=</i></dt>
 <dd>
 flag indicating to
         ignore 'star import' warnings (boolean)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 dictionary with the keys 'error' and 'warnings' which
@@ -221,17 +277,22 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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 style check.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>inputQueue</i></dt>
 <dd>
 input queue (multiprocessing.Queue)
-</dd><dt><i>outputQueue</i></dt>
+</dd>
+<dt><i>outputQueue</i></dt>
 <dd>
 output queue (multiprocessing.Queue)
 </dd>

Mercurial Repository: eric

eric ide

mercurial