blob: 7f81fceaaebbdfd1c7358afcd2c30cff99947cd1 (
plain)
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
|
# Copyright (c) 2021 Pierre Sassoulas <pierre.sassoulas@gmail.com>
# Copyright (c) 2021 Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
# Copyright (c) 2021 Ashley Whetter <ashley@awhetter.co.uk>
# Copyright (c) 2021 Marc Mueller <30130371+cdce8p@users.noreply.github.com>
# Copyright (c) 2021 Andreas Finkler <andi.finkler@gmail.com>
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
from astroid import nodes
from pylint.checkers import BaseChecker
from pylint.checkers.utils import check_messages
from pylint.interfaces import IAstroidChecker
from pylint.lint import PyLinter
class ConfusingConsecutiveElifChecker(BaseChecker):
"""Checks if "elif" is used right after an indented block that finishes with "if" or "elif" itself."""
__implements__ = IAstroidChecker
name = "confusing_elif"
priority = -1
msgs = {
"R5601": (
"Consecutive elif with differing indentation level, consider creating a function to separate the inner elif",
"confusing-consecutive-elif",
"Used when an elif statement follows right after an indented block which itself ends with if or elif. "
"It may not be ovious if the elif statement was willingly or mistakenly unindented. "
"Extracting the indented if statement into a separate function might avoid confusion and prevent errors.",
)
}
@check_messages("confusing-consecutive-elif")
def visit_if(self, node: nodes.If) -> None:
body_ends_with_if = isinstance(
node.body[-1], nodes.If
) and self._has_no_else_clause(node.body[-1])
if node.has_elif_block() and body_ends_with_if:
self.add_message("confusing-consecutive-elif", node=node.orelse[0])
@staticmethod
def _has_no_else_clause(node: nodes.If):
orelse = node.orelse
while orelse and isinstance(orelse[0], nodes.If):
orelse = orelse[0].orelse
if not orelse or isinstance(orelse[0], nodes.If):
return True
return False
def register(linter: PyLinter):
"""This required method auto registers the checker.
:param linter: The linter to register the checker to.
:type linter: pylint.lint.PyLinter
"""
linter.register_checker(ConfusingConsecutiveElifChecker(linter))
|
