Skip to content

Commit

Permalink
[deprecation] Remove get_message_definitions from BaseChecker (
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Sassoulas authored Mar 8, 2023
1 parent 491c539 commit 1ed1ab0
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 25 deletions.
4 changes: 4 additions & 0 deletions doc/whatsnew/fragments/8401.breaking
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
``get_message_definition`` was removed from the base checker API. You can access
message definitions through the ``MessageStore``.

Refs #8401
14 changes: 0 additions & 14 deletions pylint/checkers/base_checker.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,20 +234,6 @@ def messages(self) -> list[MessageDefinition]:
for msgid, msg_tuple in sorted(self.msgs.items())
]

def get_message_definition(self, msgid: str) -> MessageDefinition:
# TODO: 3.0: Remove deprecated method
warnings.warn(
"'get_message_definition' is deprecated and will be removed in 3.0.",
DeprecationWarning,
stacklevel=2,
)
for message_definition in self.messages:
if message_definition.msgid == msgid:
return message_definition
error_msg = f"MessageDefinition for '{msgid}' does not exists. "
error_msg += f"Choose from {[m.msgid for m in self.messages]}."
raise InvalidMessageError(error_msg)

def open(self) -> None:
"""Called before visiting project (i.e. set of modules)."""

Expand Down
11 changes: 0 additions & 11 deletions tests/checkers/unittest_base_checker.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,16 +132,5 @@ def test_base_checker_ordering() -> None:

def test_base_checker_invalid_message() -> None:
linter = PyLinter()

with pytest.raises(InvalidMessageError):
linter.register_checker(MissingFieldsChecker(linter))


def test_get_message_definition() -> None:
checker = LessBasicChecker()
with pytest.warns(DeprecationWarning):
with pytest.raises(InvalidMessageError):
checker.get_message_definition("W123")

with pytest.warns(DeprecationWarning):
assert checker.get_message_definition("W0001")

0 comments on commit 1ed1ab0

Please sign in to comment.