src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsUnionVisitor.html

Wed, 31 May 2023 13:53:05 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 31 May 2023 13:53:05 +0200
branch
eric7
changeset 10086
c8854a6300d1
child 10479
856476537696
permissions
-rw-r--r--

Code Style Checker
- Added a checker for PEP-604 style union type annotations.

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsUnionVisitor</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsUnionVisitor</h1>

<p>
Module implementing a node visitor for checking the import of typing.Union.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#AnnotationsUnionVisitor">AnnotationsUnionVisitor</a></td>
<td>Class implementing a node visitor for checking the import of typing.Union.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="AnnotationsUnionVisitor" ID="AnnotationsUnionVisitor"></a>
<h2>AnnotationsUnionVisitor</h2>

<p>
    Class implementing a node visitor for checking the import of typing.Union.
</p>
<h3>Derived from</h3>
ast.NodeVisitor
<h3>Class Attributes</h3>

<table>
<tr><td>AttributeName</td></tr><tr><td>FullName</td></tr><tr><td>ModuleName</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#AnnotationsUnionVisitor.__init__">AnnotationsUnionVisitor</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#AnnotationsUnionVisitor.getIssues">getIssues</a></td>
<td>Public method to get the collected Union nodes.</td>
</tr>
<tr>
<td><a href="#AnnotationsUnionVisitor.visit_Attribute">visit_Attribute</a></td>
<td>Public method to handle an ast.Attribute node.</td>
</tr>
<tr>
<td><a href="#AnnotationsUnionVisitor.visit_Import">visit_Import</a></td>
<td>Public method to handle an ast.Import node.</td>
</tr>
<tr>
<td><a href="#AnnotationsUnionVisitor.visit_ImportFrom">visit_ImportFrom</a></td>
<td>Public method to handle an ast.ImportFrom node.</td>
</tr>
<tr>
<td><a href="#AnnotationsUnionVisitor.visit_Subscript">visit_Subscript</a></td>
<td>Public method to handle an ast.Subscript node.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

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

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

<p>
        Public method to get the collected Union nodes.
</p>
<dl>
<dt>Return:</dt>
<dd>
list of collected nodes
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of ast.AST
</dd>
</dl>
<a NAME="AnnotationsUnionVisitor.visit_Attribute" ID="AnnotationsUnionVisitor.visit_Attribute"></a>
<h4>AnnotationsUnionVisitor.visit_Attribute</h4>
<b>visit_Attribute</b>(<i>node</i>)

<p>
        Public method to handle an ast.Attribute node.
</p>
<dl>

<dt><i>node</i> (ast.Attribute)</dt>
<dd>
reference to the node to be handled
</dd>
</dl>
<a NAME="AnnotationsUnionVisitor.visit_Import" ID="AnnotationsUnionVisitor.visit_Import"></a>
<h4>AnnotationsUnionVisitor.visit_Import</h4>
<b>visit_Import</b>(<i>node</i>)

<p>
        Public method to handle an ast.Import node.
</p>
<dl>

<dt><i>node</i> (ast.Import)</dt>
<dd>
reference to the node to be handled
</dd>
</dl>
<a NAME="AnnotationsUnionVisitor.visit_ImportFrom" ID="AnnotationsUnionVisitor.visit_ImportFrom"></a>
<h4>AnnotationsUnionVisitor.visit_ImportFrom</h4>
<b>visit_ImportFrom</b>(<i>node</i>)

<p>
        Public method to handle an ast.ImportFrom node.
</p>
<dl>

<dt><i>node</i> (ast.ImportFrom)</dt>
<dd>
reference to the node to be handled
</dd>
</dl>
<a NAME="AnnotationsUnionVisitor.visit_Subscript" ID="AnnotationsUnionVisitor.visit_Subscript"></a>
<h4>AnnotationsUnionVisitor.visit_Subscript</h4>
<b>visit_Subscript</b>(<i>node</i>)

<p>
        Public method to handle an ast.Subscript node.
</p>
<dl>

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

eric ide

mercurial