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
137
138
139
140
141
|
# 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
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
from __future__ import annotations
from collections.abc import ValuesView
from pathlib import Path
import pytest
from pylint.exceptions import InvalidMessageError, UnknownMessageError
from pylint.message.message_definition import MessageDefinition
from pylint.message.message_id_store import MessageIdStore
from pylint.testutils._run import _Run as Run
EMPTY_FILE = str(Path(__file__).parent.parent.resolve() / "regrtest_data" / "empty.py")
def test_len_str(msgid_store: MessageIdStore, msgids: dict[str, str]) -> None:
assert len(msgid_store) == len(msgids)
str_result = str(msgid_store)
assert "MessageIdStore: [" in str_result
assert " - W1234 (warning-symbol)" in str_result
assert " - W1235 (warning-symbol-two)" in str_result
assert " - C1234 (convention-symbol)" in str_result
assert " - E1234 (error-symbol)" in str_result
assert "]" in str_result
def test_get_message_ids(msgid_store: MessageIdStore, msgids: dict[str, str]) -> None:
"""We can get message id even with capitalization problem."""
msgid = list(msgids.keys())[0]
msgids_result = msgid_store.get_active_msgids(msgid.lower())
assert len(msgids_result) == 1
assert msgid == msgids_result[0]
def test_get_message_ids_not_existing(empty_msgid_store: MessageIdStore) -> None:
with pytest.raises(UnknownMessageError) as error:
w9876 = "W9876"
empty_msgid_store.get_active_msgids(w9876)
assert w9876 in str(error.value)
def test_register_message_definitions(
empty_msgid_store: MessageIdStore,
message_definitions: ValuesView[MessageDefinition],
) -> None:
number_of_msgid = len(message_definitions)
for message_definition in message_definitions:
empty_msgid_store.register_message_definition(
message_definition.msgid,
message_definition.symbol,
message_definition.old_names,
)
if message_definition.old_names:
number_of_msgid += len(message_definition.old_names)
assert len(empty_msgid_store) == number_of_msgid
def test_add_msgid_and_symbol(empty_msgid_store: MessageIdStore) -> None:
empty_msgid_store.add_msgid_and_symbol("E1235", "new-sckiil")
empty_msgid_store.add_legacy_msgid_and_symbol("C1235", "old-sckiil", "E1235")
assert len(empty_msgid_store) == 2
message_ids = empty_msgid_store.get_active_msgids("E1235")
assert len(message_ids) == 1
assert message_ids[0] == "E1235"
message_ids = empty_msgid_store.get_active_msgids("old-sckiil")
assert len(message_ids) == 1
assert message_ids[0] == "E1235"
assert empty_msgid_store.get_symbol("C1235") == "old-sckiil"
assert empty_msgid_store.get_symbol("E1235") == "new-sckiil"
assert empty_msgid_store.get_msgid("old-sckiil") == "C1235"
assert empty_msgid_store.get_msgid("new-sckiil") == "E1235"
with pytest.raises(UnknownMessageError):
empty_msgid_store.get_symbol("C1234")
with pytest.raises(UnknownMessageError):
empty_msgid_store.get_msgid("not-exist")
def test_duplicate_symbol(empty_msgid_store: MessageIdStore) -> None:
empty_msgid_store.add_msgid_and_symbol("W1234", "warning-symbol")
with pytest.raises(InvalidMessageError) as error:
empty_msgid_store.check_msgid_and_symbol("W1234", "other-symbol")
assert (
"Message id 'W1234' cannot have both 'other-symbol' and 'warning-symbol' as symbolic name."
in str(error.value)
)
def test_duplicate_msgid(msgid_store: MessageIdStore) -> None:
msgid_store.add_msgid_and_symbol("W1234", "warning-symbol")
with pytest.raises(InvalidMessageError) as error:
msgid_store.check_msgid_and_symbol("W1235", "warning-symbol")
assert (
"Message symbol 'warning-symbol' cannot be used for 'W1234' and 'W1235'"
in str(error.value)
)
def test_exclusivity_of_msgids() -> None:
"""Test to see if all checkers have an exclusive message id prefix."""
err_msg = (
"{} has the same prefix ('{}') as the '{}' checker. Please make sure the prefix "
"is unique for each checker. You can use 'script/get_unused_message_id_category.py' "
"to get a unique id."
)
runner = Run(["--enable-all-extensions", EMPTY_FILE], exit=False)
# Some pairs are hard-coded as they are pre-existing and non-exclusive,
# and we don't want to rename them for backwards compatibility
checker_id_pairs = {
"00": ("main", "miscellaneous"),
"01": (
"basic",
"refactoring",
"consider_ternary_expression",
"while_used",
"docstyle",
"deprecated_builtins",
),
"02": ("classes", "refactoring", "multiple_types"),
"03": ("classes", "format"),
"04": ("imports", "spelling"),
"05": ("consider-using-any-or-all", "miscellaneous"),
"07": ("exceptions", "broad_try_clause", "overlap-except"),
"12": ("design", "logging"),
"17": ("async", "refactoring"),
"20": ("compare-to-zero", "empty-comment", "magic-value"),
}
for msgid, definition in runner.linter.msgs_store._messages_definitions.items():
if definition.shared:
continue
if msgid[1:3] in checker_id_pairs:
assert (
definition.checker_name in checker_id_pairs[msgid[1:3]]
), err_msg.format(msgid, msgid[1:3], checker_id_pairs[msgid[1:3]][0])
else:
checker_id_pairs[msgid[1:3]] = (definition.checker_name,)
|
