Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.ImportNode.html
src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.ImportNode.html
- branch
- eric7
- changeset 10046
- 35b27af462ef
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10045:f5c57f8d17a4 | 10046:35b27af462ef |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.ImportNode</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.NameOrder.ImportNode</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class representing an import or import from node. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ImportNode">ImportNode</a></td> | |
| 25 <td>Class representing an import or import from node.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#ImportNodeError">ImportNodeError</a></td> | |
| 29 <td>Class representing an exception for an invalid import node.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="ImportNode" ID="ImportNode"></a> | |
| 40 <h2>ImportNode</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class representing an import or import from node. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 None | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#ImportNode.__init__">ImportNode</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ImportNode.__eq__">__eq__</a></td> | |
| 67 <td>Special method implementing the equality operator.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ImportNode.__lt__">__lt__</a></td> | |
| 71 <td>Special method implementing the less than operator.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ImportNode.__str__">__str__</a></td> | |
| 75 <td>Special method to create a string representation of the instance.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="ImportNode.__init__" ID="ImportNode.__init__"></a> | |
| 85 <h4>ImportNode (Constructor)</h4> | |
| 86 <b>ImportNode</b>(<i>appNames, astNode, checker, sortIgnoringStyle, sortFromFirst</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>appNames</i> (list of str)</dt> | |
| 94 <dd> | |
| 95 list of application package names | |
| 96 </dd> | |
| 97 <dt><i>astNode</i> (ast.AST)</dt> | |
| 98 <dd> | |
| 99 reference to the ast node | |
| 100 </dd> | |
| 101 <dt><i>checker</i> (ImportsChecker)</dt> | |
| 102 <dd> | |
| 103 reference to the checker object | |
| 104 </dd> | |
| 105 <dt><i>sortIgnoringStyle</i> (bool)</dt> | |
| 106 <dd> | |
| 107 flag indicating to sort ignoring the import style | |
| 108 </dd> | |
| 109 <dt><i>sortFromFirst</i> (bool)</dt> | |
| 110 <dd> | |
| 111 flag indicating to sort from imports before straight ones | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <dl> | |
| 115 | |
| 116 <dt>Raises <b>ImportNodeError</b>:</dt> | |
| 117 <dd> | |
| 118 raised to indicate an invalid node was | |
| 119 given to this class | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <a NAME="ImportNode.__eq__" ID="ImportNode.__eq__"></a> | |
| 123 <h4>ImportNode.__eq__</h4> | |
| 124 <b>__eq__</b>(<i>other</i>) | |
| 125 | |
| 126 <p> | |
| 127 Special method implementing the equality operator. | |
| 128 </p> | |
| 129 <dl> | |
| 130 | |
| 131 <dt><i>other</i> (ImportNode)</dt> | |
| 132 <dd> | |
| 133 reference to the object to compare | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <dl> | |
| 137 <dt>Return:</dt> | |
| 138 <dd> | |
| 139 flag indicating equality | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <dl> | |
| 143 <dt>Return Type:</dt> | |
| 144 <dd> | |
| 145 bool | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <a NAME="ImportNode.__lt__" ID="ImportNode.__lt__"></a> | |
| 149 <h4>ImportNode.__lt__</h4> | |
| 150 <b>__lt__</b>(<i>other</i>) | |
| 151 | |
| 152 <p> | |
| 153 Special method implementing the less than operator. | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>other</i> (ImportNode)</dt> | |
| 158 <dd> | |
| 159 reference to the object to compare | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <dl> | |
| 163 <dt>Return:</dt> | |
| 164 <dd> | |
| 165 flag indicating a less than situation | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <dl> | |
| 169 <dt>Return Type:</dt> | |
| 170 <dd> | |
| 171 bool | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <a NAME="ImportNode.__str__" ID="ImportNode.__str__"></a> | |
| 175 <h4>ImportNode.__str__</h4> | |
| 176 <b>__str__</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Special method to create a string representation of the instance. | |
| 180 </p> | |
| 181 <dl> | |
| 182 <dt>Return:</dt> | |
| 183 <dd> | |
| 184 string representation of the instance | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <dl> | |
| 188 <dt>Return Type:</dt> | |
| 189 <dd> | |
| 190 str | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <dl> | |
| 194 | |
| 195 <dt>Raises <b>ImportNodeError</b>:</dt> | |
| 196 <dd> | |
| 197 raised to indicate an invalid node was | |
| 198 given to this class | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <div align="right"><a href="#top">Up</a></div> | |
| 202 <hr /> | |
| 203 <hr /> | |
| 204 <a NAME="ImportNodeError" ID="ImportNodeError"></a> | |
| 205 <h2>ImportNodeError</h2> | |
| 206 | |
| 207 <p> | |
| 208 Class representing an exception for an invalid import node. | |
| 209 </p> | |
| 210 <h3>Derived from</h3> | |
| 211 Exception | |
| 212 <h3>Class Attributes</h3> | |
| 213 | |
| 214 <table> | |
| 215 <tr><td>None</td></tr> | |
| 216 </table> | |
| 217 <h3>Class Methods</h3> | |
| 218 | |
| 219 <table> | |
| 220 <tr><td>None</td></tr> | |
| 221 </table> | |
| 222 <h3>Methods</h3> | |
| 223 | |
| 224 <table> | |
| 225 <tr><td>None</td></tr> | |
| 226 </table> | |
| 227 <h3>Static Methods</h3> | |
| 228 | |
| 229 <table> | |
| 230 <tr><td>None</td></tr> | |
| 231 </table> | |
| 232 | |
| 233 <div align="right"><a href="#top">Up</a></div> | |
| 234 <hr /> | |
| 235 </body></html> |
