[bad-option-value] Add a 'useless-option-value' message

So it's possible to to distinguish between genuine typoes and old configuration that could be cleaned.

Author: Pierre-Sassoulas

.pyenchant_pylint_custom_dict.txt

@@ -324,6 +324,7 @@ typechecking
 typeddict
 typehint
 typeshed
+typoes
 uid
 uml
 un

doc/whatsnew/2/2.14/full.rst

@@ -17,6 +17,10 @@ Release date: TBA
 
   Closes #6810
 
+* Deleted messages that do not exists anymore in pylint now raise ``useless-option-value`` instead of ``bad-option-value``
+  which permit to distinguish between genuine typoes and old configuration that could be cleaned.
+
+  Refs #6794
 
 What's New in Pylint 2.14.0?
 ----------------------------

pylint/lint/message_state_handler.py

@@ -17,6 +17,7 @@
     MSG_TYPES,
     MSG_TYPES_LONG,
 )
+from pylint.interfaces import HIGH
 from pylint.message import MessageDefinition
 from pylint.typing import ManagedMessage
 from pylint.utils.pragma_parser import (
@@ -411,9 +412,14 @@ def process_tokens(self, tokens: list[tokenize.TokenInfo]) -> None:
                         try:
                             meth(msgid, "module", l_start)
                         except exceptions.UnknownMessageError:
-                            msg = f"{pragma_repr.action}. Don't recognize message {msgid}."
+                            (
+                                symbol,
+                                msg,
+                            ) = self.linter.msgs_store.kwargs_for_bad_option_value_add_message(
+                                msgid, f"'{pragma_repr.action}'"
+                            )
                             self.linter.add_message(
-                                "bad-option-value", args=msg, line=start[0]
+                                line=start[0], confidence=HIGH, msgid=symbol, args=msg
                             )
             except UnRecognizedOptionError as err:
                 self.linter.add_message(

pylint/lint/pylinter.py

@@ -29,6 +29,7 @@
     MSG_TYPES_STATUS,
     WarningScope,
 )
+from pylint.interfaces import HIGH
 from pylint.lint.base_options import _make_linter_options
 from pylint.lint.caching import load_results, save_results
 from pylint.lint.expand_modules import _is_ignored_file, expand_modules
@@ -194,6 +195,13 @@ def _load_reporter_by_class(reporter_class: str) -> type[BaseReporter]:
         "Used when a bad value for an inline option is encountered.",
         {"scope": WarningScope.LINE},
     ),
+    "I0012": (
+        "Useless option value for %s",
+        "useless-option-value",
+        "Used when a value for an inline option that is now deleted from pylint"
+        " is encountered.",
+        {"scope": WarningScope.LINE},
+    ),
     "E0013": (
         "Plugin '%s' is impossible to load, is it installed ? ('%s')",
         "bad-plugin-value",
@@ -1206,6 +1214,8 @@ def _emit_bad_option_value(self) -> None:
             self.linter.set_current_module(modname)
             values = self._stashed_bad_option_value_messages[modname]
             for option_string, msg_id in values:
-                msg = f"{option_string}. Don't recognize message {msg_id}."
-                self.add_message("bad-option-value", args=msg, line=0)
+                symbol, msg = self.msgs_store.kwargs_for_bad_option_value_add_message(
+                    msg_id, f"'{option_string}'"
+                )
+                self.add_message(line=0, msgid=symbol, args=msg, confidence=HIGH)
         self._stashed_bad_option_value_messages = collections.defaultdict(list)

pylint/message/__init__.py

@@ -3,7 +3,6 @@
 # Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
 
 """All the classes related to Message handling."""
-
 from pylint.message.message import Message
 from pylint.message.message_definition import MessageDefinition
 from pylint.message.message_definition_store import MessageDefinitionStore

pylint/message/message_definition_store.py

@@ -9,6 +9,7 @@
 from collections.abc import Sequence, ValuesView
 from typing import TYPE_CHECKING
 
+from pylint.constants import DELETED_MESSAGES
 from pylint.exceptions import UnknownMessageError
 from pylint.message.message_definition import MessageDefinition
 from pylint.message.message_id_store import MessageIdStore
@@ -32,6 +33,28 @@ def __init__(self) -> None:
         # MessageDefinition kept by category
         self._msgs_by_category: dict[str, list[str]] = collections.defaultdict(list)
 
+    @staticmethod
+    def is_deleted_msgid_or_symbol(msgid_or_symbol: str) -> str | None:
+        """Return the explanation for removal if the message was removed."""
+        for explanation, deleted_messages in DELETED_MESSAGES.items():
+            for deleted_message in deleted_messages:
+                if msgid_or_symbol in [deleted_message.msgid, deleted_message.symbol]:
+                    return explanation
+        return None
+
+    def kwargs_for_bad_option_value_add_message(
+        self, msgid: str, original_message: str
+    ) -> tuple[str, str]:
+        removal_explanation = self.is_deleted_msgid_or_symbol(msgid)
+        if removal_explanation is not None:
+            symbol = "useless-option-value"
+            msg = f"{original_message}. '{msgid}' was removed from pylint, see {removal_explanation}."
+        else:
+            symbol = "bad-option-value"
+            msg = f"{original_message}. Don't recognize message '{msgid}'."
+
+        return symbol, msg
+
     @property
     def messages(self) -> ValuesView[MessageDefinition]:
         """The list of all active messages."""

tests/config/functional/ini/pylintrc_with_deleted_message.0.out

@@ -0,0 +1,3 @@
+************* Module {abspath}
+{relpath}:1:0: I0012: Useless option value for '--disable'. 'buffer-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942. (useless-option-value)
+{relpath}:1:0: I0012: Useless option value for '--enable'. 'cmp-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942. (useless-option-value)

tests/config/functional/ini/pylintrc_with_deleted_message.ini

@@ -0,0 +1,7 @@
+# Check that we raise an informational when a deleted messages exists in a .pylintrc file
+# See https://github.com/PyCQA/pylint/issues/6794
+[messages control]
+disable = logging-not-lazy, buffer-builtin
+enable = useless-option-value, locally-disabled, cmp-builtin
+jobs = 10
+reports = yes

tests/config/functional/ini/pylintrc_with_deleted_message.result.json

@@ -0,0 +1,12 @@
+{
+  "functional_append": {
+    "disable": ["logging-not-lazy"],
+    "enable": ["locally-disabled", "useless-option-value"]
+  },
+  "functional_remove": {
+    "disable": ["locally-disabled", "useless-option-value"],
+    "enable": ["logging-not-lazy"]
+  },
+  "jobs": 10,
+  "reports": true
+}

tests/config/functional/ini/pylintrc_with_missing_comma.2.out

@@ -1,3 +1,3 @@
 ************* Module {abspath}
-{relpath}:1:0: E0012: Bad option value for --disable. Don't recognize message logging-not-lazylogging-format-interpolation. (bad-option-value)
-{relpath}:1:0: E0012: Bad option value for --enable. Don't recognize message locally-disabledsuppressed-message. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--disable'. Don't recognize message 'logging-not-lazylogging-format-interpolation'. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--enable'. Don't recognize message 'locally-disabledsuppressed-message'. (bad-option-value)

tests/config/functional/setup_cfg/do_not_read_other_tools_configuration/setup.2.out

@@ -1,2 +1,2 @@
 ************* Module {abspath}
-{relpath}:1:0: E0012: Bad option value for --enable. Don't recognize message useless-supression. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--enable'. Don't recognize message 'useless-supression'. (bad-option-value)

tests/config/functional/toml/issue_3122/toml_with_missing_comma.2.out

@@ -1,3 +1,3 @@
 ************* Module {abspath}
-{relpath}:1:0: E0012: Bad option value for --disable. Don't recognize message logging-not-lazylogging-format-interpolation. (bad-option-value)
-{relpath}:1:0: E0012: Bad option value for --enable. Don't recognize message locally-disabledsuppressed-message. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--disable'. Don't recognize message 'logging-not-lazylogging-format-interpolation'. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--enable'. Don't recognize message 'locally-disabledsuppressed-message'. (bad-option-value)

tests/config/functional/toml/unknown_msgid/enable_unknown_msgid.2.out

@@ -1,3 +1,3 @@
 ************* Module {abspath}
-{relpath}:1:0: E0012: Bad option value for --disable. Don't recognize message logging-not-layzy. (bad-option-value)
-{relpath}:1:0: E0012: Bad option value for --enable. Don't recognize message C00000. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--disable'. Don't recognize message 'logging-not-layzy'. (bad-option-value)
+{relpath}:1:0: E0012: Bad option value for '--enable'. Don't recognize message 'C00000'. (bad-option-value)

tests/config/test_config.py

@@ -60,7 +60,7 @@ def test_unknown_message_id(capsys: CaptureFixture) -> None:
     """Check that we correctly raise a message on an unknown id."""
     Run([str(EMPTY_MODULE), "--disable=12345"], exit=False)
     output = capsys.readouterr()
-    assert "Command line:1:0: E0012: Bad option value for --disable." in output.out
+    assert "Command line:1:0: E0012: Bad option value for '--disable'." in output.out
 
 
 def test_unknown_option_name(capsys: CaptureFixture) -> None:

tests/functional/b/bad_option_value.py

@@ -1,4 +1,4 @@
+"""Check unknown option. """
+
 # pylint:enable=W04044  # [bad-option-value]
-"""check unknown option
-"""
-__revision__ = 1
+# pylint:enable=execfile-builtin  # [useless-option-value]

tests/functional/b/bad_option_value.txt

@@ -1 +1,2 @@
-bad-option-value:1:0:None:None::Bad option value for enable. Don't recognize message W04044.:UNDEFINED
+bad-option-value:3:0:None:None::Bad option value for 'enable'. Don't recognize message 'W04044'.:HIGH
+useless-option-value:4:0:None:None::"Useless option value for 'enable'. 'execfile-builtin' was removed from pylint, see https://github.com/PyCQA/pylint/pull/4942.":HIGH

tests/functional/b/bad_option_value_disable.txt

@@ -1,2 +1,2 @@
-bad-option-value:10:0:None:None::Bad option value for disable. Don't recognize message a-removed-option.:UNDEFINED
-bad-option-value:13:0:None:None::Bad option value for disable. Don't recognize message a-removed-option.:UNDEFINED
+bad-option-value:10:0:None:None::Bad option value for 'disable'. Don't recognize message 'a-removed-option'.:HIGH
+bad-option-value:13:0:None:None::Bad option value for 'disable'. Don't recognize message 'a-removed-option'.:HIGH

tests/functional/u/use/use_symbolic_message_instead.txt

@@ -1,4 +1,4 @@
-bad-option-value:1:0:None:None::Bad option value for disable. Don't recognize message T1234.:UNDEFINED
+bad-option-value:1:0:None:None::Bad option value for 'disable'. Don't recognize message 'T1234'.:HIGH
 use-symbolic-message-instead:1:0:None:None::"'C0111' is cryptic: use '# pylint: disable=missing-docstring' instead":UNDEFINED
 use-symbolic-message-instead:1:0:None:None::"'R0903' is cryptic: use '# pylint: disable=too-few-public-methods' instead":UNDEFINED
 use-symbolic-message-instead:2:0:None:None::"'c0111' is cryptic: use '# pylint: enable=missing-docstring' instead":UNDEFINED