diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2023-03-21 11:16:32 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-21 11:16:32 +0100 |
| commit | 77a392d04b11eb2c438c38fc187890faefd760e3 (patch) | |
| tree | a78ce5cbd8d59075003fbe5fdfc0ad7ee3fc7b95 | |
| parent | 95a82dc7ef54070e31dcecf56f2ded5348e3dfb7 (diff) | |
| download | pylint-git-77a392d04b11eb2c438c38fc187890faefd760e3.tar.gz | |
[deprecation] Make 'py_version' required for 'MessageDefinition.may_be_emitted' (#8473)
| -rw-r--r-- | doc/whatsnew/fragments/8473.internal | 6 | ||||
| -rw-r--r-- | pylint/message/message_definition.py | 20 |
2 files changed, 8 insertions, 18 deletions
diff --git a/doc/whatsnew/fragments/8473.internal b/doc/whatsnew/fragments/8473.internal new file mode 100644 index 000000000..11491dd57 --- /dev/null +++ b/doc/whatsnew/fragments/8473.internal @@ -0,0 +1,6 @@ +Following a deprecation period, the ``py_version`` argument of the +``MessageDefinition.may_be_emitted`` function is now required. The most likely solution +is to use 'linter.config.py_version' if you need to keep using this +function, or to use 'MessageDefinition.is_message_enabled' instead. + +Refs #8473 diff --git a/pylint/message/message_definition.py b/pylint/message/message_definition.py index ad641ec3f..360d72a8a 100644 --- a/pylint/message/message_definition.py +++ b/pylint/message/message_definition.py @@ -5,7 +5,6 @@ from __future__ import annotations import sys -import warnings from typing import TYPE_CHECKING, Any from astroid import nodes @@ -73,23 +72,8 @@ class MessageDefinition: def __str__(self) -> str: return f"{repr(self)}:\n{self.msg} {self.description}" - def may_be_emitted( - self, - py_version: tuple[int, ...] | sys._version_info | None = None, - ) -> bool: - """Return True if message may be emitted using the configured py_version.""" - if py_version is None: - py_version = sys.version_info - # TODO: 3.0 - warnings.warn( - "'py_version' will be a required parameter of " - "'MessageDefinition.may_be_emitted' in pylint 3.0. The most likely " - "solution is to use 'linter.config.py_version' if you need to keep " - "using this function, or to use 'MessageDefinition.is_message_enabled'" - " instead.", - DeprecationWarning, - stacklevel=2, - ) + def may_be_emitted(self, py_version: tuple[int, ...] | sys._version_info) -> bool: + """May the message be emitted using the configured py_version?""" if self.minversion is not None and self.minversion > py_version: return False if self.maxversion is not None and self.maxversion <= py_version: |