1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
import astroid
from pylint.checkers import BaseTokenChecker
from pylint.checkers.utils import check_messages
from pylint.interfaces import ITokenChecker, IAstroidChecker
class ElseifUsedChecker(BaseTokenChecker):
"""Checks for use of "else if" when a "elif" could be used
"""
__implements__ = (ITokenChecker, IAstroidChecker)
name = 'elseifused'
msgs = {'R5501': ('Consider using "elif" instead of "else if"',
'else-if-used',
'Used when an else statement is immediately followed by '
'an if statement and does not contain statements that '
'would be unrelated to it.'),
}
def __init__(self, linter=None):
BaseTokenChecker.__init__(self, linter)
self._init()
def _init(self):
self._elifs = []
self._if_counter = 0
def _is_actual_elif(self, node):
"""Check if the given node is an actual elif
This is a problem we're having with the builtin ast module,
which splits `elif` branches into a separate if statement.
Unfortunately we need to know the exact type in certain
cases.
"""
if isinstance(node.parent, astroid.If):
orelse = node.parent.orelse
# current if node must directly follow a "else"
if orelse and orelse == [node]:
if self._elifs[self._if_counter]:
return True
return False
def process_tokens(self, tokens):
# Process tokens and look for 'if' or 'elif'
for _, token, _, _, _ in tokens:
self._elifs.append(True if token == 'elif' else False)
def leave_module(self, _):
self._init()
def visit_ifexp(self, _):
self._if_counter += 1
def visit_comprehension(self, node):
self._if_counter += len(node.ifs)
@check_messages('else-if-used')
def visit_if(self, node):
if isinstance(node.parent, astroid.If):
orelse = node.parent.orelse
# current if node must directly follow a "else"
if orelse and orelse == [node]:
if not self._elifs[self._if_counter]:
self.add_message('else-if-used', node=node)
self._if_counter += 1
def register(linter):
"""Required method to auto register this checker.
:param linter: Main interface object for Pylint plugins
:type linter: Pylint object
"""
linter.register_checker(ElseifUsedChecker(linter))
|