Documentation/Source/eric5.UtilitiesPython2.py2flakes.messages.html

<!DOCTYPE html>
<html><head>
<title>eric5.UtilitiesPython2.py2flakes.messages</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>eric5.UtilitiesPython2.py2flakes.messages</h1>
<p>
Module implementing the messages for pyflakes.
</p><p>
Note: This is a copy of the identical module contained in Utilities.pyflakes.
It is here to make it accessible to the external Python 2 process.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#DoctestSyntaxError">DoctestSyntaxError</a></td>
<td>Class defining the "Doctest syntax Error" message.</td>
</tr><tr>
<td><a href="#DuplicateArgument">DuplicateArgument</a></td>
<td>Class defining the "Duplicate Argument" message.</td>
</tr><tr>
<td><a href="#ImportShadowedByLoopVar">ImportShadowedByLoopVar</a></td>
<td>Class defining the "Import Shadowed By Loop Var" message.</td>
</tr><tr>
<td><a href="#ImportStarUsed">ImportStarUsed</a></td>
<td>Class defining the "Import Star Used" message.</td>
</tr><tr>
<td><a href="#LateFutureImport">LateFutureImport</a></td>
<td>Class defining the "Late Future Import" message.</td>
</tr><tr>
<td><a href="#Message">Message</a></td>
<td>Class defining the base for all specific message classes.</td>
</tr><tr>
<td><a href="#Redefined">Redefined</a></td>
<td>Class defining the "Redefined" message.</td>
</tr><tr>
<td><a href="#RedefinedInListComp">RedefinedInListComp</a></td>
<td>Class defining the "Redefined In List Comprehension" message.</td>
</tr><tr>
<td><a href="#RedefinedWhileUnused">RedefinedWhileUnused</a></td>
<td>Class defining the "Redefined While Unused" message.</td>
</tr><tr>
<td><a href="#UndefinedExport">UndefinedExport</a></td>
<td>Class defining the "Undefined Export" message.</td>
</tr><tr>
<td><a href="#UndefinedLocal">UndefinedLocal</a></td>
<td>Class defining the "Undefined Local Variable" message.</td>
</tr><tr>
<td><a href="#UndefinedName">UndefinedName</a></td>
<td>Class defining the "Undefined Name" message.</td>
</tr><tr>
<td><a href="#UnusedImport">UnusedImport</a></td>
<td>Class defining the "Unused Import" message.</td>
</tr><tr>
<td><a href="#UnusedVariable">UnusedVariable</a></td>
<td>Class defining the "Unused Variable" message.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="DoctestSyntaxError" ID="DoctestSyntaxError"></a>
<h2>DoctestSyntaxError</h2>
<p>
    Class defining the "Doctest syntax Error" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#DoctestSyntaxError.__init__">DoctestSyntaxError</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="DoctestSyntaxError.__init__" ID="DoctestSyntaxError.__init__"></a>
<h4>DoctestSyntaxError (Constructor)</h4>
<b>DoctestSyntaxError</b>(<i>filename, loc, position=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>position</i></dt>
<dd>
position of the syntax error
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="DuplicateArgument" ID="DuplicateArgument"></a>
<h2>DuplicateArgument</h2>
<p>
    Class defining the "Duplicate Argument" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#DuplicateArgument.__init__">DuplicateArgument</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="DuplicateArgument.__init__" ID="DuplicateArgument.__init__"></a>
<h4>DuplicateArgument (Constructor)</h4>
<b>DuplicateArgument</b>(<i>filename, loc, name</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the duplicate argument (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="ImportShadowedByLoopVar" ID="ImportShadowedByLoopVar"></a>
<h2>ImportShadowedByLoopVar</h2>
<p>
    Class defining the "Import Shadowed By Loop Var" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#ImportShadowedByLoopVar.__init__">ImportShadowedByLoopVar</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="ImportShadowedByLoopVar.__init__" ID="ImportShadowedByLoopVar.__init__"></a>
<h4>ImportShadowedByLoopVar (Constructor)</h4>
<b>ImportShadowedByLoopVar</b>(<i>filename, loc, name, orig_loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the shadowed import (string)
</dd><dt><i>orig_loc</i></dt>
<dd>
location of the import
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="ImportStarUsed" ID="ImportStarUsed"></a>
<h2>ImportStarUsed</h2>
<p>
    Class defining the "Import Star Used" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#ImportStarUsed.__init__">ImportStarUsed</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="ImportStarUsed.__init__" ID="ImportStarUsed.__init__"></a>
<h4>ImportStarUsed (Constructor)</h4>
<b>ImportStarUsed</b>(<i>filename, loc, modname</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>modname</i></dt>
<dd>
name of the module imported using star import (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="LateFutureImport" ID="LateFutureImport"></a>
<h2>LateFutureImport</h2>
<p>
    Class defining the "Late Future Import" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#LateFutureImport.__init__">LateFutureImport</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="LateFutureImport.__init__" ID="LateFutureImport.__init__"></a>
<h4>LateFutureImport (Constructor)</h4>
<b>LateFutureImport</b>(<i>filename, loc, names</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>names</i></dt>
<dd>
names of the imported futures (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="Message" ID="Message"></a>
<h2>Message</h2>
<p>
    Class defining the base for all specific message classes.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_args</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Message.__init__">Message</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Message.__str__">__str__</a></td>
<td>Special method return a string representation of the instance object.</td>
</tr><tr>
<td><a href="#Message.getMessageData">getMessageData</a></td>
<td>Public method to get the individual message data elements.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Message.__init__" ID="Message.__init__"></a>
<h4>Message (Constructor)</h4>
<b>Message</b>(<i>filename, loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd>
</dl><a NAME="Message.__str__" ID="Message.__str__"></a>
<h4>Message.__str__</h4>
<b>__str__</b>(<i></i>)
<p>
        Special method return a string representation of the instance object.
</p><dl>
<dt>Returns:</dt>
<dd>
string representation of the object (string)
</dd>
</dl><a NAME="Message.getMessageData" ID="Message.getMessageData"></a>
<h4>Message.getMessageData</h4>
<b>getMessageData</b>(<i></i>)
<p>
        Public method to get the individual message data elements.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple containing file name, line number, message ID and
            message arguments (string, integer, string, list)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="Redefined" ID="Redefined"></a>
<h2>Redefined</h2>
<p>
    Class defining the "Redefined" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Redefined.__init__">Redefined</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Redefined.__init__" ID="Redefined.__init__"></a>
<h4>Redefined (Constructor)</h4>
<b>Redefined</b>(<i>filename, loc, name, orig_loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the redefined function (string)
</dd><dt><i>orig_loc</i></dt>
<dd>
location of the original definition
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="RedefinedInListComp" ID="RedefinedInListComp"></a>
<h2>RedefinedInListComp</h2>
<p>
    Class defining the "Redefined In List Comprehension" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#RedefinedInListComp.__init__">RedefinedInListComp</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="RedefinedInListComp.__init__" ID="RedefinedInListComp.__init__"></a>
<h4>RedefinedInListComp (Constructor)</h4>
<b>RedefinedInListComp</b>(<i>filename, loc, name, orig_loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the redefined object (string)
</dd><dt><i>orig_loc</i></dt>
<dd>
location of the original definition
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="RedefinedWhileUnused" ID="RedefinedWhileUnused"></a>
<h2>RedefinedWhileUnused</h2>
<p>
    Class defining the "Redefined While Unused" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#RedefinedWhileUnused.__init__">RedefinedWhileUnused</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="RedefinedWhileUnused.__init__" ID="RedefinedWhileUnused.__init__"></a>
<h4>RedefinedWhileUnused (Constructor)</h4>
<b>RedefinedWhileUnused</b>(<i>filename, loc, name, orig_loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the redefined object (string)
</dd><dt><i>orig_loc</i></dt>
<dd>
location of the original definition
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UndefinedExport" ID="UndefinedExport"></a>
<h2>UndefinedExport</h2>
<p>
    Class defining the "Undefined Export" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UndefinedExport.__init__">UndefinedExport</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UndefinedExport.__init__" ID="UndefinedExport.__init__"></a>
<h4>UndefinedExport (Constructor)</h4>
<b>UndefinedExport</b>(<i>filename, loc, name</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
undefined exported name (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UndefinedLocal" ID="UndefinedLocal"></a>
<h2>UndefinedLocal</h2>
<p>
    Class defining the "Undefined Local Variable" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UndefinedLocal.__init__">UndefinedLocal</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UndefinedLocal.__init__" ID="UndefinedLocal.__init__"></a>
<h4>UndefinedLocal (Constructor)</h4>
<b>UndefinedLocal</b>(<i>filename, loc, name, orig_loc</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the prematurely referenced variable (string)
</dd><dt><i>orig_loc</i></dt>
<dd>
location of the variable definition
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UndefinedName" ID="UndefinedName"></a>
<h2>UndefinedName</h2>
<p>
    Class defining the "Undefined Name" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UndefinedName.__init__">UndefinedName</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UndefinedName.__init__" ID="UndefinedName.__init__"></a>
<h4>UndefinedName (Constructor)</h4>
<b>UndefinedName</b>(<i>filename, loc, name</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
undefined name (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UnusedImport" ID="UnusedImport"></a>
<h2>UnusedImport</h2>
<p>
    Class defining the "Unused Import" message.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UnusedImport.__init__">UnusedImport</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UnusedImport.__init__" ID="UnusedImport.__init__"></a>
<h4>UnusedImport (Constructor)</h4>
<b>UnusedImport</b>(<i>filename, loc, name</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>name</i></dt>
<dd>
name of the unused import (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UnusedVariable" ID="UnusedVariable"></a>
<h2>UnusedVariable</h2>
<p>
    Class defining the "Unused Variable" message.
</p><p>
    Indicates that a variable has been explicitly assigned to but not actually
    used.
</p>
<h3>Derived from</h3>
Message
<h3>Class Attributes</h3>
<table>
<tr><td>message</td></tr><tr><td>message_id</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UnusedVariable.__init__">UnusedVariable</a></td>
<td>Constructor</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UnusedVariable.__init__" ID="UnusedVariable.__init__"></a>
<h4>UnusedVariable (Constructor)</h4>
<b>UnusedVariable</b>(<i>filename, loc, names</i>)
<p>
        Constructor
</p><dl>
<dt><i>filename</i></dt>
<dd>
name of the file (string)
</dd><dt><i>loc</i></dt>
<dd>
location of the issue
</dd><dt><i>names</i></dt>
<dd>
names of unused variable (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>