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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/pylint-dev/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/pylint-dev/pylint/blob/main/CONTRIBUTORS.txt
"""Unittest for the BaseChecker class."""
import pytest
from pylint.checkers import BaseChecker
from pylint.checkers.imports import ImportsChecker
from pylint.checkers.typecheck import TypeChecker
from pylint.exceptions import InvalidMessageError
from pylint.extensions.while_used import WhileChecker
from pylint.lint.pylinter import PyLinter
class OtherBasicChecker(BaseChecker):
def __init__(self) -> None:
super().__init__(PyLinter())
name = "basic"
msgs = {
"W0001": (
"Basic checker has an example.",
"basic-checker-example",
"Used nowhere and serves no purpose.",
)
}
class MissingFieldsChecker(BaseChecker):
name = "basic"
msgs = {"W0001": ("msg-name",)} # type: ignore[dict-item]
class LessBasicChecker(OtherBasicChecker):
options = (
(
"example-args",
{
"default": 42,
"type": "int",
"metavar": "<int>",
"help": "Example of integer argument for the checker.",
},
),
)
class DifferentBasicChecker(BaseChecker):
def __init__(self) -> None:
super().__init__(PyLinter())
name = "a-different-checker"
msgs = {
"W0002": (
"Blah blah example.",
"blah-blah-example",
"I only exist to be different to OtherBasicChecker :(",
)
}
def test_base_checker_doc() -> None:
basic = OtherBasicChecker()
expected_beginning = """\
Basic checker
~~~~~~~~~~~~~
Verbatim name of the checker is ``basic``.
"""
expected_middle = """\
Basic checker Options
^^^^^^^^^^^^^^^^^^^^^
:example-args:
Example of integer argument for the checker.
Default: ``42``
"""
expected_end = """\
Basic checker Messages
^^^^^^^^^^^^^^^^^^^^^^
:basic-checker-example (W0001): *Basic checker has an example.*
Used nowhere and serves no purpose.
"""
assert str(basic) == expected_beginning + expected_end
assert repr(basic) == "Checker 'basic' (responsible for 'W0001')"
less_basic = LessBasicChecker()
assert str(less_basic) == expected_beginning + expected_middle + expected_end
assert repr(less_basic) == repr(basic)
def test_base_checker_ordering() -> None:
"""Test ordering of checkers based on their __gt__ method."""
linter = PyLinter()
fake_checker_1 = OtherBasicChecker()
fake_checker_2 = LessBasicChecker()
fake_checker_3 = DifferentBasicChecker()
import_checker = ImportsChecker(linter)
while_checker = WhileChecker(linter)
type_checker = TypeChecker(linter)
list_of_checkers = [
1,
fake_checker_1,
fake_checker_2,
fake_checker_3,
type_checker,
import_checker,
while_checker,
linter,
]
assert sorted(list_of_checkers) == [ # type: ignore[type-var]
linter,
import_checker,
type_checker,
fake_checker_3,
fake_checker_1,
fake_checker_2,
while_checker,
1,
]
assert fake_checker_1 > fake_checker_3
assert fake_checker_2 > fake_checker_3
assert fake_checker_1 == fake_checker_2
def test_base_checker_invalid_message() -> None:
linter = PyLinter()
with pytest.raises(InvalidMessageError):
linter.register_checker(MissingFieldsChecker(linter))
|
