src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.SysVersionVisitor.html

Thu, 27 Feb 2025 14:42:39 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 27 Feb 2025 14:42:39 +0100
branch
eric7
changeset 11150
73d80859079c
permissions
-rw-r--r--

Code Style Checkers
- Refactored the various code style checkers for better maintainability.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.SysVersionVisitor</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Miscellaneous.SysVersionVisitor</h1>
<p>
Module implementing a node visitor to check the use of sys.version and sys.version_info.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#SysVersionVisitor">SysVersionVisitor</a></td>
<td>Class implementing a node visitor to check the use of sys.version and sys.version_info.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="SysVersionVisitor" ID="SysVersionVisitor"></a>
<h2>SysVersionVisitor</h2>
<p>
    Class implementing a node visitor to check the use of sys.version and
    sys.version_info.
</p>
<p>
    Note: This class is modeled after flake8-2020 v1.8.1.
</p>

<h3>Derived from</h3>
ast.NodeVisitor
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#SysVersionVisitor.__init__">SysVersionVisitor</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.__isSys">__isSys</a></td>
<td>Private method to check for a reference to sys attribute.</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.__isSysVersionUpperSlice">__isSysVersionUpperSlice</a></td>
<td>Private method to check the upper slice of sys.version.</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.visit_Attribute">visit_Attribute</a></td>
<td>Public method to handle an attribute.</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.visit_Compare">visit_Compare</a></td>
<td>Public method to handle a comparison.</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.visit_ImportFrom">visit_ImportFrom</a></td>
<td>Public method to handle a from ...</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.visit_Name">visit_Name</a></td>
<td>Public method to handle an name.</td>
</tr>
<tr>
<td><a href="#SysVersionVisitor.visit_Subscript">visit_Subscript</a></td>
<td>Public method to handle a subscript.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="SysVersionVisitor.__init__" ID="SysVersionVisitor.__init__"></a>
<h4>SysVersionVisitor (Constructor)</h4>
<b>SysVersionVisitor</b>(<i></i>)
<p>
        Constructor
</p>

<a NAME="SysVersionVisitor.__isSys" ID="SysVersionVisitor.__isSys"></a>
<h4>SysVersionVisitor.__isSys</h4>
<b>__isSys</b>(<i>attr, node</i>)
<p>
        Private method to check for a reference to sys attribute.
</p>

<dl>

<dt><i>attr</i> (str)</dt>
<dd>
attribute name
</dd>
<dt><i>node</i> (ast.Node)</dt>
<dd>
reference to the node to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a match
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="SysVersionVisitor.__isSysVersionUpperSlice" ID="SysVersionVisitor.__isSysVersionUpperSlice"></a>
<h4>SysVersionVisitor.__isSysVersionUpperSlice</h4>
<b>__isSysVersionUpperSlice</b>(<i>node, n</i>)
<p>
        Private method to check the upper slice of sys.version.
</p>

<dl>

<dt><i>node</i> (ast.Node)</dt>
<dd>
reference to the node to be checked
</dd>
<dt><i>n</i> (int)</dt>
<dd>
slice value to check against
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a match
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="SysVersionVisitor.visit_Attribute" ID="SysVersionVisitor.visit_Attribute"></a>
<h4>SysVersionVisitor.visit_Attribute</h4>
<b>visit_Attribute</b>(<i>node</i>)
<p>
        Public method to handle an attribute.
</p>

<dl>

<dt><i>node</i> (ast.Attribute)</dt>
<dd>
reference to the node to be processed
</dd>
</dl>
<a NAME="SysVersionVisitor.visit_Compare" ID="SysVersionVisitor.visit_Compare"></a>
<h4>SysVersionVisitor.visit_Compare</h4>
<b>visit_Compare</b>(<i>node</i>)
<p>
        Public method to handle a comparison.
</p>

<dl>

<dt><i>node</i> (ast.Compare)</dt>
<dd>
reference to the node to be processed
</dd>
</dl>
<a NAME="SysVersionVisitor.visit_ImportFrom" ID="SysVersionVisitor.visit_ImportFrom"></a>
<h4>SysVersionVisitor.visit_ImportFrom</h4>
<b>visit_ImportFrom</b>(<i>node</i>)
<p>
        Public method to handle a from ... import ... statement.
</p>

<dl>

<dt><i>node</i> (ast.ImportFrom)</dt>
<dd>
reference to the node to be processed
</dd>
</dl>
<a NAME="SysVersionVisitor.visit_Name" ID="SysVersionVisitor.visit_Name"></a>
<h4>SysVersionVisitor.visit_Name</h4>
<b>visit_Name</b>(<i>node</i>)
<p>
        Public method to handle an name.
</p>

<dl>

<dt><i>node</i> (ast.Name)</dt>
<dd>
reference to the node to be processed
</dd>
</dl>
<a NAME="SysVersionVisitor.visit_Subscript" ID="SysVersionVisitor.visit_Subscript"></a>
<h4>SysVersionVisitor.visit_Subscript</h4>
<b>visit_Subscript</b>(<i>node</i>)
<p>
        Public method to handle a subscript.
</p>

<dl>

<dt><i>node</i> (ast.Subscript)</dt>
<dd>
reference to the node to be processed
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial