eric: Documentation/Source/eric5.UtilitiesPython2.Py2SyntaxChecker.html@e8882d16384c

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.UtilitiesPython2.Py2SyntaxChecker</title>
<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>eric5.UtilitiesPython2.Py2SyntaxChecker</h1>
<p>
Module implementing the syntax check for Python 2.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>coding_regexps</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#compile">compile</a></td>
<td>Function to compile one Python source file to Python bytecode.</td>
</tr><tr>
<td><a href="#decode">decode</a></td>
<td>Function to decode a text.</td>
</tr><tr>
<td><a href="#flakesCheck">flakesCheck</a></td>
<td>Function to perform a pyflakes check.</td>
</tr><tr>
<td><a href="#get_coding">get_coding</a></td>
<td>Function to get the coding of a text.</td>
</tr>
</table>
<hr /><hr />
<a NAME="compile" ID="compile"></a>
<h2>compile</h2>
<b>compile</b>(<i>file</i>)
<p>
    Function to compile one Python source file to Python bytecode.
</p><dl>
<dt><i>file</i></dt>
<dd>
source filename (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
A tuple indicating status (1 = an error was found), the
        filename, the linenumber, the code string, the error message
        and the full source code (boolean, string, string, string,
        string, string). The values are only valid, if the status
        equals 1.
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="decode" ID="decode"></a>
<h2>decode</h2>
<b>decode</b>(<i>text</i>)
<p>
    Function to decode a text.
</p><dl>
<dt><i>text</i></dt>
<dd>
text to decode (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
decoded text and encoding
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="flakesCheck" ID="flakesCheck"></a>
<h2>flakesCheck</h2>
<b>flakesCheck</b>(<i>fileName, codestring, ignoreStarImportWarnings</i>)
<p>
    Function to perform a pyflakes check.
</p><dl>
<dt><i>fileName</i></dt>
<dd>
name of the file (string)
</dd><dt><i>codestring</i></dt>
<dd>
source code to be checked (string)
</dd><dt><i>ignoreStarImportWarnings</i></dt>
<dd>
flag indicating to
        ignore 'star import' warnings (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of strings containing the warnings
        (marker, file name, line number, message)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="get_coding" ID="get_coding"></a>
<h2>get_coding</h2>
<b>get_coding</b>(<i>text</i>)
<p>
    Function to get the coding of a text.
</p><dl>
<dt><i>text</i></dt>
<dd>
text to inspect (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
coding string
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>