Add a new JsonReporter with all information

Author: Pierre-Sassoulas

pylint/reporters/json_reporter.py

@@ -10,7 +10,7 @@
 import sys
 from typing import TYPE_CHECKING, Optional
 
-from pylint.interfaces import UNDEFINED
+from pylint.interfaces import UNDEFINED, Confidence
 from pylint.message import Message
 from pylint.reporters.base_reporter import BaseReporter
 from pylint.typing import MessageLocationTuple
@@ -43,6 +43,11 @@
 )
 
 
+class JSONExport(OldJsonExport):  # pylint: disable=inherit-non-class
+    confidence: Confidence
+    abspath: str
+
+
 class BaseJSONReporter(BaseReporter):
     """Report messages and layouts in JSON."""
 
@@ -74,9 +79,6 @@ class JSONReporter(BaseJSONReporter):
     """
     TODO: 3.0: Remove this JSONReporter in favor of the new one handling abs-path
     and confidence.
-
-    TODO: 3.0: Add a new JSONReporter handling abs-path, confidence and scores.
-    (Ultimately all other breaking change related to json for 3.0).
     """
 
     @staticmethod
@@ -102,7 +104,6 @@ def deserialize(message_as_json: OldJsonExport) -> Message:
             symbol=message_as_json["symbol"],
             msg=message_as_json["message"],
             location=MessageLocationTuple(
-                # TODO: 3.0: Add abs-path and confidence in a new JSONReporter
                 abspath=message_as_json["path"],
                 path=message_as_json["path"],
                 module=message_as_json["module"],
@@ -112,10 +113,56 @@ def deserialize(message_as_json: OldJsonExport) -> Message:
                 end_line=message_as_json["endLine"],
                 end_column=message_as_json["endColumn"],
             ),
-            # TODO: 3.0: Make confidence available in a new JSONReporter
             confidence=UNDEFINED,
         )
 
 
+class NewJSONReporter(BaseJSONReporter):
+
+    """
+    TODO: 3.0: Refactor this reporter so it's the only reporter.
+
+    TODO: 3.0: Handle all other breaking changes related to json for 3.0
+    """
+
+    @staticmethod
+    def serialize(message: Message) -> JSONExport:
+        return {
+            "type": message.category,
+            "module": message.module,
+            "obj": message.obj,
+            "line": message.line,
+            "column": message.column,
+            "endLine": message.end_line,
+            "endColumn": message.end_column,
+            "path": message.path,
+            "symbol": message.symbol,
+            "message": message.msg or "",
+            "message-id": message.msg_id,
+            "confidence": message.confidence,
+            "abspath": message.abspath,
+        }
+
+    @staticmethod
+    def deserialize(message_as_json: JSONExport) -> Message:
+        return Message(
+            msg_id=message_as_json["message-id"],
+            symbol=message_as_json["symbol"],
+            msg=message_as_json["message"],
+            location=MessageLocationTuple(
+                abspath=message_as_json["abspath"],
+                path=message_as_json["path"],
+                module=message_as_json["module"],
+                obj=message_as_json["obj"],
+                line=message_as_json["line"],
+                column=message_as_json["column"],
+                end_line=message_as_json["endLine"],
+                end_column=message_as_json["endColumn"],
+            ),
+            confidence=message_as_json["confidence"],
+        )
+
+
 def register(linter: PyLinter) -> None:
     linter.register_reporter(JSONReporter)
+    linter.register_reporter(NewJSONReporter)

tests/reporters/unittest_json_reporter.py

@@ -8,15 +8,17 @@
 
 import json
 from io import StringIO
+from pathlib import Path
 from typing import Any
 
 import pytest
 
 from pylint import checkers
-from pylint.interfaces import UNDEFINED
+from pylint.interfaces import HIGH, UNDEFINED
 from pylint.lint import PyLinter
 from pylint.message import Message
 from pylint.reporters import JSONReporter
+from pylint.reporters.json_reporter import NewJSONReporter
 from pylint.reporters.ureports.nodes import EvaluationSection
 from pylint.typing import MessageLocationTuple
 
@@ -133,5 +135,36 @@ def get_linter_result(score: bool, message: dict[str, Any]) -> list[dict[str, An
 )
 def test_serialize_deserialize(message: Message) -> None:
     # TODO: 3.0: Add confidence handling, add path and abs path handling or a new JSONReporter
-    json_message = JSONReporter.serialize(message)
-    assert message == JSONReporter.deserialize(json_message)
+    for reporter in (JSONReporter, NewJSONReporter):
+        json_message = reporter.serialize(message)
+        assert message == reporter.deserialize(json_message)
+
+
+@pytest.mark.parametrize(
+    "message",
+    [
+        pytest.param(
+            Message(
+                msg_id="C0111",
+                symbol="missing-docstring",
+                location=MessageLocationTuple(
+                    abspath=str(Path(__file__).resolve()),
+                    path=__file__,
+                    module="unittest_json_reporter",
+                    obj="obj",
+                    line=1,
+                    column=3,
+                    end_line=3,
+                    end_column=5,
+                ),
+                msg="This is the actual message",
+                confidence=HIGH,
+            ),
+            id="everything-defined",
+        )
+    ],
+)
+def test_serialize_deserialize_new_json(message: Message) -> None:
+    json_message = NewJSONReporter.serialize(message)
+    print(json_message)
+    assert message == NewJSONReporter.deserialize(json_message)