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

changeset 2966
f85f686981ad
parent 2910
cdc56e9d9f12
equal deleted inserted replaced
2965:d133c7edd88a 2966:f85f686981ad
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td> 84 <td><a href="#Pep8NamingChecker.__checkVariablesInFunction">__checkVariablesInFunction</a></td>
85 <td>Private method to check local variables in functions (N821).</td> 85 <td>Private method to check local variables in functions (N821).</td>
86 </tr><tr> 86 </tr><tr>
87 <td><a href="#Pep8NamingChecker.__error">__error</a></td> 87 <td><a href="#Pep8NamingChecker.__error">__error</a></td>
88 <td>Private method to build the error information</td> 88 <td>Private method to build the error information.</td>
89 </tr><tr> 89 </tr><tr>
90 <td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td> 90 <td><a href="#Pep8NamingChecker.__findGlobalDefs">__findGlobalDefs</a></td>
91 <td>Private method amend a node with global definitions information.</td> 91 <td>Private method amend a node with global definitions information.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#Pep8NamingChecker.__getArgNames">__getArgNames</a></td> 93 <td><a href="#Pep8NamingChecker.__getArgNames">__getArgNames</a></td>
159 Classes for internal use have a leading underscore in addition. 159 Classes for internal use have a leading underscore in addition.
160 </p><dl> 160 </p><dl>
161 <dt><i>node</i></dt> 161 <dt><i>node</i></dt>
162 <dd> 162 <dd>
163 AST note to check 163 AST note to check
164 </dd><dt><i>parents</i></dt>
165 <dd>
166 list of parent nodes
164 </dd> 167 </dd>
165 </dl><dl> 168 </dl><dl>
166 <dt>Returns:</dt> 169 <dt>Returns:</dt>
167 <dd> 170 <dd>
168 tuple giving line number, offset within line and error code 171 tuple giving line number, offset within line and error code
180 first argument. A method should have 'self' as the first argument. 183 first argument. A method should have 'self' as the first argument.
181 </p><dl> 184 </p><dl>
182 <dt><i>node</i></dt> 185 <dt><i>node</i></dt>
183 <dd> 186 <dd>
184 AST note to check 187 AST note to check
188 </dd><dt><i>parents</i></dt>
189 <dd>
190 list of parent nodes
185 </dd> 191 </dd>
186 </dl><dl> 192 </dl><dl>
187 <dt>Returns:</dt> 193 <dt>Returns:</dt>
188 <dd> 194 <dd>
189 tuple giving line number, offset within line and error code 195 tuple giving line number, offset within line and error code
203 (e.g. threading.py), to retain backwards compatibility. 209 (e.g. threading.py), to retain backwards compatibility.
204 </p><dl> 210 </p><dl>
205 <dt><i>node</i></dt> 211 <dt><i>node</i></dt>
206 <dd> 212 <dd>
207 AST note to check 213 AST note to check
214 </dd><dt><i>parents</i></dt>
215 <dd>
216 list of parent nodes
208 </dd> 217 </dd>
209 </dl><dl> 218 </dl><dl>
210 <dt>Returns:</dt> 219 <dt>Returns:</dt>
211 <dd> 220 <dd>
212 tuple giving line number, offset within line and error code 221 tuple giving line number, offset within line and error code
220 naming convention (N811, N812, N813, N814). 229 naming convention (N811, N812, N813, N814).
221 </p><dl> 230 </p><dl>
222 <dt><i>node</i></dt> 231 <dt><i>node</i></dt>
223 <dd> 232 <dd>
224 AST note to check 233 AST note to check
234 </dd><dt><i>parents</i></dt>
235 <dd>
236 list of parent nodes
225 </dd> 237 </dd>
226 </dl><dl> 238 </dl><dl>
227 <dt>Returns:</dt> 239 <dt>Returns:</dt>
228 <dd> 240 <dd>
229 tuple giving line number, offset within line and error code 241 tuple giving line number, offset within line and error code
238 Module and package names should be lowercase. 250 Module and package names should be lowercase.
239 </p><dl> 251 </p><dl>
240 <dt><i>node</i></dt> 252 <dt><i>node</i></dt>
241 <dd> 253 <dd>
242 AST note to check 254 AST note to check
255 </dd><dt><i>parents</i></dt>
256 <dd>
257 list of parent nodes
243 </dd> 258 </dd>
244 </dl><dl> 259 </dl><dl>
245 <dt>Returns:</dt> 260 <dt>Returns:</dt>
246 <dd> 261 <dd>
247 tuple giving line number, offset within line and error code 262 tuple giving line number, offset within line and error code
254 Private class to check the given node for a name to be avoided (N831). 269 Private class to check the given node for a name to be avoided (N831).
255 </p><dl> 270 </p><dl>
256 <dt><i>node</i></dt> 271 <dt><i>node</i></dt>
257 <dd> 272 <dd>
258 AST note to check 273 AST note to check
274 </dd><dt><i>parents</i></dt>
275 <dd>
276 list of parent nodes
259 </dd> 277 </dd>
260 </dl><dl> 278 </dl><dl>
261 <dt>Returns:</dt> 279 <dt>Returns:</dt>
262 <dd> 280 <dd>
263 tuple giving line number, offset within line and error code 281 tuple giving line number, offset within line and error code
272 Local variables in functions should be lowercase. 290 Local variables in functions should be lowercase.
273 </p><dl> 291 </p><dl>
274 <dt><i>node</i></dt> 292 <dt><i>node</i></dt>
275 <dd> 293 <dd>
276 AST note to check 294 AST note to check
295 </dd><dt><i>parents</i></dt>
296 <dd>
297 list of parent nodes
277 </dd> 298 </dd>
278 </dl><dl> 299 </dl><dl>
279 <dt>Returns:</dt> 300 <dt>Returns:</dt>
280 <dd> 301 <dd>
281 tuple giving line number, offset within line and error code 302 tuple giving line number, offset within line and error code
283 </dd> 304 </dd>
284 </dl><a NAME="Pep8NamingChecker.__error" ID="Pep8NamingChecker.__error"></a> 305 </dl><a NAME="Pep8NamingChecker.__error" ID="Pep8NamingChecker.__error"></a>
285 <h4>Pep8NamingChecker.__error</h4> 306 <h4>Pep8NamingChecker.__error</h4>
286 <b>__error</b>(<i>node, code</i>) 307 <b>__error</b>(<i>node, code</i>)
287 <p> 308 <p>
288 Private method to build the error information 309 Private method to build the error information.
289 </p><dl> 310 </p><dl>
290 <dt><i>node</i></dt> 311 <dt><i>node</i></dt>
291 <dd> 312 <dd>
292 AST node to report an error for 313 AST node to report an error for
293 </dd><dt><i>code</i></dt> 314 </dd><dt><i>code</i></dt>

eric ide

mercurial