Improve de-register reports logic

Author: cdce8p

pylint/lint/pylinter.py

@@ -323,10 +323,10 @@ def __init__(
         """Dictionary of registered and initialized checkers."""
         self._dynamic_plugins: dict[str, ModuleType | ModuleNotFoundError | bool] = {}
         """Set of loaded plugin names."""
-        self._registered_checkers: set[tuple[str, checkers.BaseChecker]] = set()
+        self._registered_checkers: set[tuple[str, checkers.BaseChecker, int]] = set()
         """Set of tuples with loaded checker names and reference to checker."""
         self._registered_dynamic_plugin_checkers: set[
-            tuple[str, checkers.BaseChecker]
+            tuple[str, checkers.BaseChecker, int]
         ] = set()
         """Set of tuples with loaded dynamic plugin checker names and reference to
         checker.
@@ -504,7 +504,7 @@ def report_order(self) -> list[BaseChecker]:
     def register_checker(self, checker: checkers.BaseChecker) -> None:
         """This method auto registers the checker."""
         self._checkers[checker.name].append(checker)
-        self._registered_checkers.add((checker.name, checker))
+        self._registered_checkers.add((checker.name, checker, id(checker)))
         for r_id, r_title, r_cb in checker.reports:
             self.register_report(r_id, r_title, r_cb, checker)
         if not self._freeze_register_msgs and hasattr(checker, "msgs"):
@@ -517,13 +517,13 @@ def register_checker(self, checker: checkers.BaseChecker) -> None:
             self.disable(checker.name)
 
     def _deregister_checkers(
-        self, checker_collection: Collection[tuple[str, checkers.BaseChecker]]
+        self, checker_collection: Collection[tuple[str, checkers.BaseChecker, int]]
     ) -> None:
         """De-registered a collection of checkers with its reports.
 
         Leave messages in place as re-registering them is a no-op.
         """
-        for checker_name, checker in checker_collection:
+        for checker_name, checker, _ in checker_collection:
             self._checkers[checker_name].remove(checker)
             if checker.reports:
                 self.deregister_reports(checker)

pylint/reporters/reports_handler_mix_in.py

@@ -50,7 +50,8 @@ def register_report(
 
     def deregister_reports(self, checker: BaseChecker) -> None:
         """De-register all reports for a checker."""
-        self._reports.pop(checker)
+        for r_id, r_title, r_cb in checker.reports:
+            self._reports[checker].remove((r_id, r_title, r_cb))
 
     def enable_report(self, reportid: str) -> None:
         """Enable the report of the given id."""

tests/test_check_parallel.py

@@ -225,7 +225,11 @@ def test_worker_initialize_custom_plugins(self) -> None:
         linter = PyLinter(reporter=Reporter())
         linter.load_default_plugins()
         config_data = {
-            "load-plugins": "pylint.extensions.code_style,pylint.extensions.typing",
+            "load-plugins": (
+                "pylint.extensions.code_style,"
+                "pylint.extensions.typing,"
+                "pylint.checkers.raw_metrics,"  # Custom report
+            ),
         }
         config_args = [
             "--enable=consider-using-augmented-assign",
@@ -238,6 +242,9 @@ def test_worker_initialize_custom_plugins(self) -> None:
             _config_initialization(linter, [])
         assert len(linter._checkers["code_style"]) == 1
         assert len(linter._checkers["typing"]) == 1
+        assert len(linter._checkers["metrics"]) == 2
+        old_metrics_checker = linter._checkers["metrics"][-1]
+        assert len(linter._reports[old_metrics_checker]) == 2
         assert linter.is_message_enabled("consider-using-augmented-assign") is True
         assert (  # default disabled
             linter.is_message_enabled("prefer-typing-namedtuple") is False
@@ -246,8 +253,17 @@ def test_worker_initialize_custom_plugins(self) -> None:
         worker_initialize(linter=dill.dumps(linter))
         worker_linter = pylint.lint.parallel._worker_linter
         assert isinstance(worker_linter, PyLinter)
+        assert len(worker_linter._registered_dynamic_plugin_checkers) == 3
         assert len(worker_linter._checkers["code_style"]) == 1
         assert len(worker_linter._checkers["typing"]) == 1
+        assert len(worker_linter._checkers["metrics"]) == 2
+        # The base checker overwrite __eq__ and __hash__ to only compare name and msgs.
+        # Thus, while the ids for the metrics checker are different, they have the same
+        # hash. That is used as key for the '_reports' dict.
+        new_metrics_checker = worker_linter._checkers["metrics"][-1]
+        assert id(old_metrics_checker) != id(new_metrics_checker)
+        assert old_metrics_checker == new_metrics_checker
+        assert len(worker_linter._reports[new_metrics_checker]) == 2
         assert linter.is_message_enabled("consider-using-augmented-assign") is True
         assert (  # default disabled
             linter.is_message_enabled("prefer-typing-namedtuple") is False