Documentation/Source/eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker.html

<!DOCTYPE html>
<html><head>
<title>eric5.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker</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.Plugins.CheckerPlugins.Pep8.Pep8NamingChecker</h1>
<p>
Module implementing a checker for PEP-8 naming conventions.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Pep8NamingChecker">Pep8NamingChecker</a></td>
<td>Class implementing a checker for PEP-8 naming conventions.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Pep8NamingChecker" ID="Pep8NamingChecker"></a>
<h2>Pep8NamingChecker</h2>
<p>
    Class implementing a checker for PEP-8 naming conventions.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>CamelcaseRegexp</td></tr><tr><td>Codes</td></tr><tr><td>LowercaseRegex</td></tr><tr><td>Messages</td></tr><tr><td>MixedcaseRegexp</td></tr><tr><td>UppercaseRegexp</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr>
<td><a href="#Pep8NamingChecker.getMessage">getMessage</a></td>
<td>Class method to get a translated and formatted message for a given code.</td>
</tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Pep8NamingChecker.__init__">Pep8NamingChecker</a></td>
<td>Constructor (according to 'extended' pep8.py API)</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkClassName">__checkClassName</a></td>
<td>Private class to check the given node for class name conventions (N801).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkFunctionArgumentNames">__checkFunctionArgumentNames</a></td>
<td>Private class to check the argument names of functions (N803, N804, N805, N806).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkFuntionName">__checkFuntionName</a></td>
<td>Private class to check the given node for function name conventions (N802).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkImportAs">__checkImportAs</a></td>
<td>Private method to check that imports don't change the naming convention (N811, N812, N813, N814).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkModule">__checkModule</a></td>
<td>Private method to check module naming conventions (N807, N808).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkNameToBeAvoided">__checkNameToBeAvoided</a></td>
<td>Private class to check the given node for a name to be avoided (N831).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td>
<td>Private method to check local variables in functions (N821).</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__error">__error</a></td>
<td>Private method to build the error information</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td>
<td>Private method amend a node with global definitions information.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__getArgNames">__getArgNames</a></td>
<td>Private method to get the argument names of a function node.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__isNameToBeAvoided">__isNameToBeAvoided</a></td>
<td>Private method to check, if the given name should be avoided.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__tagClassFunctions">__tagClassFunctions</a></td>
<td>Private method to tag functions if they are methods, class methods or static methods.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__visitNode">__visitNode</a></td>
<td>Private method to inspect the given AST node.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.__visitTree">__visitTree</a></td>
<td>Private method to scan the given AST tree.</td>
</tr><tr>
<td><a href="#Pep8NamingChecker.run">run</a></td>
<td>Public method run by the pep8.py checker.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Pep8NamingChecker.getMessage" ID="Pep8NamingChecker.getMessage"></a>
<h4>Pep8NamingChecker.getMessage (class method)</h4>
<b>getMessage</b>(<i>code, *args</i>)
<p>
        Class method to get a translated and formatted message for a
        given code.
</p><dl>
<dt><i>code</i></dt>
<dd>
message code (string)
</dd><dt><i>args</i></dt>
<dd>
arguments for a formatted message (list)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
translated and formatted message (string)
</dd>
</dl><a NAME="Pep8NamingChecker.__init__" ID="Pep8NamingChecker.__init__"></a>
<h4>Pep8NamingChecker (Constructor)</h4>
<b>Pep8NamingChecker</b>(<i>tree, filename, options</i>)
<p>
        Constructor (according to 'extended' pep8.py API)
</p><dl>
<dt><i>tree</i></dt>
<dd>
AST tree of the source file
</dd><dt><i>filename</i></dt>
<dd>
name of the source file (string)
</dd><dt><i>options</i></dt>
<dd>
options as parsed by pep8.StyleGuide
</dd>
</dl><a NAME="Pep8NamingChecker.__checkClassName" ID="Pep8NamingChecker.__checkClassName"></a>
<h4>Pep8NamingChecker.__checkClassName</h4>
<b>__checkClassName</b>(<i>node, parents</i>)
<p>
        Private class to check the given node for class name
        conventions (N801).
</p><p>
        Almost without exception, class names use the CapWords convention.
        Classes for internal use have a leading underscore in addition.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkFunctionArgumentNames" ID="Pep8NamingChecker.__checkFunctionArgumentNames"></a>
<h4>Pep8NamingChecker.__checkFunctionArgumentNames</h4>
<b>__checkFunctionArgumentNames</b>(<i>node, parents</i>)
<p>
        Private class to check the argument names of functions
        (N803, N804, N805, N806).
</p><p>
        The argument names of a function should be lowercase, with words
        separated by underscores. A class method should have 'cls' as the
        first argument. A method should have 'self' as the first argument.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkFuntionName" ID="Pep8NamingChecker.__checkFuntionName"></a>
<h4>Pep8NamingChecker.__checkFuntionName</h4>
<b>__checkFuntionName</b>(<i>node, parents</i>)
<p>
        Private class to check the given node for function name
        conventions (N802).
</p><p>
        Function names should be lowercase, with words separated by underscores
        as necessary to improve readability. Functions <b>not</b> being
        methods '__' in front and back are not allowed. Mixed case is allowed
        only in contexts where that's already the prevailing style
        (e.g. threading.py), to retain backwards compatibility.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkImportAs" ID="Pep8NamingChecker.__checkImportAs"></a>
<h4>Pep8NamingChecker.__checkImportAs</h4>
<b>__checkImportAs</b>(<i>node, parents</i>)
<p>
        Private method to check that imports don't change the
        naming convention (N811, N812, N813, N814).
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkModule" ID="Pep8NamingChecker.__checkModule"></a>
<h4>Pep8NamingChecker.__checkModule</h4>
<b>__checkModule</b>(<i>node, parents</i>)
<p>
        Private method to check module naming conventions (N807, N808).
</p><p>
        Module and package names should be lowercase.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkNameToBeAvoided" ID="Pep8NamingChecker.__checkNameToBeAvoided"></a>
<h4>Pep8NamingChecker.__checkNameToBeAvoided</h4>
<b>__checkNameToBeAvoided</b>(<i>node, parents</i>)
<p>
        Private class to check the given node for a name to be avoided (N831).
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__checkVariablesInFunction" ID="Pep8NamingChecker.__checkVariablesInFunction"></a>
<h4>Pep8NamingChecker.__checkVariablesInFunction</h4>
<b>__checkVariablesInFunction</b>(<i>node, parents</i>)
<p>
        Private method to check local variables in functions (N821).
</p><p>
        Local variables in functions should be lowercase.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST note to check
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__error" ID="Pep8NamingChecker.__error"></a>
<h4>Pep8NamingChecker.__error</h4>
<b>__error</b>(<i>node, code</i>)
<p>
        Private method to build the error information
</p><dl>
<dt><i>node</i></dt>
<dd>
AST node to report an error for
</dd><dt><i>code</i></dt>
<dd>
error code to report (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line and error code
            (integer, integer, string)
</dd>
</dl><a NAME="Pep8NamingChecker.__findGlobalDefs" ID="Pep8NamingChecker.__findGlobalDefs"></a>
<h4>Pep8NamingChecker.__findGlobalDefs</h4>
<b>__findGlobalDefs</b>(<i>functionNode</i>)
<p>
        Private method amend a node with global definitions information.
</p><dl>
<dt><i>functionNode</i></dt>
<dd>
AST tree node to amend
</dd>
</dl><a NAME="Pep8NamingChecker.__getArgNames" ID="Pep8NamingChecker.__getArgNames"></a>
<h4>Pep8NamingChecker.__getArgNames</h4>
<b>__getArgNames</b>(<i>node</i>)
<p>
        Private method to get the argument names of a function node.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST node to extract arguments names from
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of argument names (list of string)
</dd>
</dl><a NAME="Pep8NamingChecker.__isNameToBeAvoided" ID="Pep8NamingChecker.__isNameToBeAvoided"></a>
<h4>Pep8NamingChecker.__isNameToBeAvoided</h4>
<b>__isNameToBeAvoided</b>(<i>name</i>)
<p>
        Private method to check, if the given name should be avoided.
</p><dl>
<dt><i>name</i></dt>
<dd>
name to be checked (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating to avoid it (boolen)
</dd>
</dl><a NAME="Pep8NamingChecker.__tagClassFunctions" ID="Pep8NamingChecker.__tagClassFunctions"></a>
<h4>Pep8NamingChecker.__tagClassFunctions</h4>
<b>__tagClassFunctions</b>(<i>classNode</i>)
<p>
        Private method to tag functions if they are methods, class methods or
        static methods.
</p><dl>
<dt><i>classNode</i></dt>
<dd>
AST tree node to tag
</dd>
</dl><a NAME="Pep8NamingChecker.__visitNode" ID="Pep8NamingChecker.__visitNode"></a>
<h4>Pep8NamingChecker.__visitNode</h4>
<b>__visitNode</b>(<i>node</i>)
<p>
        Private method to inspect the given AST node.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST tree node to inspect
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line, code and
            checker function
</dd>
</dl><a NAME="Pep8NamingChecker.__visitTree" ID="Pep8NamingChecker.__visitTree"></a>
<h4>Pep8NamingChecker.__visitTree</h4>
<b>__visitTree</b>(<i>node</i>)
<p>
        Private method to scan the given AST tree.
</p><dl>
<dt><i>node</i></dt>
<dd>
AST tree node to scan
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line, code and
            checker function
</dd>
</dl><a NAME="Pep8NamingChecker.run" ID="Pep8NamingChecker.run"></a>
<h4>Pep8NamingChecker.run</h4>
<b>run</b>(<i></i>)
<p>
        Public method run by the pep8.py checker.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple giving line number, offset within line, code and
            checker function
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>