--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportNode.html Wed Dec 29 16:54:36 2021 +0100 @@ -0,0 +1,227 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportNode</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.Imports.ImportNode</h1> + +<p> +Module implementing a class representing an import or import from node. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ImportNode">ImportNode</a></td> +<td>Class representing an import or import from node.</td> +</tr> +<tr> +<td><a href="#ImportNodeException">ImportNodeException</a></td> +<td>Class representing an exception for an invalid import node.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ImportNode" ID="ImportNode"></a> +<h2>ImportNode</h2> + +<p> + Class representing an import or import from node. +</p> +<h3>Derived from</h3> +None +<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="#ImportNode.__init__">ImportNode</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ImportNode.__eq__">__eq__</a></td> +<td>Special method implementing the equality operator.</td> +</tr> +<tr> +<td><a href="#ImportNode.__lt__">__lt__</a></td> +<td>Special method implementing the less than operator.</td> +</tr> +<tr> +<td><a href="#ImportNode.__str__">__str__</a></td> +<td>Special method to create a string representation of the instance.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ImportNode.__init__" ID="ImportNode.__init__"></a> +<h4>ImportNode (Constructor)</h4> +<b>ImportNode</b>(<i>appNames, astNode, checker</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>appNames</i> (list of str)</dt> +<dd> +list of application package names +</dd> +<dt><i>astNode</i> (ast.AST)</dt> +<dd> +reference to the ast node +</dd> +<dt><i>checker</i> (ImportsChecker)</dt> +<dd> +reference to the checker object +</dd> +</dl> +<dl> + +<dt>Raises <b>ImportNodeException</b>:</dt> +<dd> +raised to indicate an invalid node was + given to this class +</dd> +</dl> +<a NAME="ImportNode.__eq__" ID="ImportNode.__eq__"></a> +<h4>ImportNode.__eq__</h4> +<b>__eq__</b>(<i>other</i>) + +<p> + Special method implementing the equality operator. +</p> +<dl> + +<dt><i>other</i> (ImportNode)</dt> +<dd> +reference to the object to compare +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating equality +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ImportNode.__lt__" ID="ImportNode.__lt__"></a> +<h4>ImportNode.__lt__</h4> +<b>__lt__</b>(<i>other</i>) + +<p> + Special method implementing the less than operator. +</p> +<dl> + +<dt><i>other</i> (ImportNode)</dt> +<dd> +reference to the object to compare +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a less than situation +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="ImportNode.__str__" ID="ImportNode.__str__"></a> +<h4>ImportNode.__str__</h4> +<b>__str__</b>(<i></i>) + +<p> + Special method to create a string representation of the instance. +</p> +<dl> +<dt>Return:</dt> +<dd> +string representation of the instance +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<dl> + +<dt>Raises <b>ImportNodeException</b>:</dt> +<dd> +raised to indicate an invalid node was + given to this class +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="ImportNodeException" ID="ImportNodeException"></a> +<h2>ImportNodeException</h2> + +<p> + Class representing an exception for an invalid import node. +</p> +<h3>Derived from</h3> +Exception +<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>None</td></tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file