[pylint.message] Add a location attribute to 'pylint.Message'

Author: Pierre-Sassoulas

pylint/message/message.py

@@ -77,3 +77,16 @@ def format(self, template: str) -> str:
         cf. https://docs.python.org/2/library/string.html#formatstrings
         """
         return template.format(**asdict(self))
+
+    @property
+    def location(self) -> MessageLocationTuple:
+        return MessageLocationTuple(
+            self.abspath,
+            self.path,
+            self.module,
+            self.obj,
+            self.line,
+            self.column,
+            self.end_line,
+            self.end_column,
+        )

pylint/reporters/json_reporter.py

@@ -32,7 +32,7 @@ def display_messages(self, layout: Section | None) -> None:
 
     @staticmethod
     def serialize(message: Message) -> dict[str, int | str | None]:
-        # TODO (3.0) add abs-path and confidence
+        # TODO: 3.0: Add abs-path and confidence or a new JSONReporter
         return {
             "type": message.category,
             "module": message.module,
@@ -54,7 +54,7 @@ def deserialize(message_as_json: dict) -> Message:
             symbol=message_as_json["symbol"],
             msg=message_as_json["message"],
             location=MessageLocationTuple(
-                # TODO (3.0) abs-path is not available in json export
+                # TODO: 3.0: Add abs-path and confidence or a new JSONReporter
                 abspath=message_as_json["path"],
                 path=message_as_json["path"],
                 module=message_as_json["module"],
@@ -64,7 +64,7 @@ def deserialize(message_as_json: dict) -> Message:
                 end_line=message_as_json["endLine"],
                 end_column=message_as_json["endColumn"],
             ),
-            # TODO (3.0) confidence is not available in json export
+            # TODO: 3.0: Make confidence available or a new JSONReporter
             confidence=UNDEFINED,
         )
 

tests/message/unittest_message.py

@@ -55,5 +55,7 @@ def build_message(
     )
     e1234 = build_message(e1234_message_definition, e1234_location_values)
     w1234 = build_message(w1234_message_definition, w1234_location_values)
+    assert e1234.location == e1234_location_values
+    assert w1234.location == w1234_location_values
     assert e1234.format(template) == expected
     assert w1234.format(template) == "8:11:12: W1234: message (msg-symbol)"

tests/reporters/unittest_json_reporter.py

@@ -132,6 +132,6 @@ def get_linter_result(score: bool, message: dict[str, Any]) -> list[dict[str, An
     ],
 )
 def test_serialize_deserialize(message):
-    # TODO (3.0): Add confidence handling, add path and abs path handling
+    # 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)