Revert "Simplify testutils"

This reverts commit 833762f.

Author: jacobtylerwalls

pylint/testutils/lint_module_test.py

@@ -11,13 +11,15 @@
 from collections import Counter
 from io import StringIO
 from pathlib import Path
-from typing import TextIO
+from typing import Counter as CounterType
+from typing import TextIO, Tuple
 
 import pytest
 from _pytest.config import Config
 
 from pylint import checkers
 from pylint.config.config_initialization import _config_initialization
+from pylint.constants import IS_PYPY
 from pylint.lint import PyLinter
 from pylint.message.message import Message
 from pylint.testutils.constants import _EXPECTED_RE, _OPERATORS, UPDATE_OPTION
@@ -31,7 +33,7 @@
 from pylint.testutils.output_line import OutputLine
 from pylint.testutils.reporter_for_tests import FunctionalTestReporter
 
-MessageCounter = Counter[tuple[int, str]]
+MessageCounter = CounterType[Tuple[int, str]]
 
 PYLINTRC = Path(__file__).parent / "testing_pylintrc"
 
@@ -103,6 +105,13 @@ def __init__(
             self._linter, args_list=args, config_file=rc_file, reporter=_test_reporter
         )
 
+        self._check_end_position = (
+            sys.version_info >= self._linter.config.min_pyver_end_position
+        )
+        # TODO: PY3.9: PyPy supports end_lineno from 3.9 and above
+        if self._check_end_position and IS_PYPY:
+            self._check_end_position = sys.version_info >= (3, 9)  # pragma: no cover
+
         self._config = config
 
     def setUp(self) -> None:
@@ -218,7 +227,8 @@ def _get_expected(self) -> tuple[MessageCounter, list[OutputLine]]:
             expected_msgs = Counter()
         with self._open_expected_file() as f:
             expected_output_lines = [
-                OutputLine.from_csv(row) for row in csv.reader(f, "test")
+                OutputLine.from_csv(row, self._check_end_position)
+                for row in csv.reader(f, "test")
             ]
         return expected_msgs, expected_output_lines
 
@@ -232,7 +242,9 @@ def _get_actual(self) -> tuple[MessageCounter, list[OutputLine]]:
                 msg.symbol != "fatal"
             ), f"Pylint analysis failed because of '{msg.msg}'"
             received_msgs[msg.line, msg.symbol] += 1
-            received_output_lines.append(OutputLine.from_msg(msg))
+            received_output_lines.append(
+                OutputLine.from_msg(msg, self._check_end_position)
+            )
         return received_msgs, received_output_lines
 
     def _runTest(self) -> None:

pylint/testutils/output_line.py

@@ -5,13 +5,15 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
-from typing import Any, NamedTuple
+from typing import Any, NamedTuple, TypeVar
 
 from astroid import nodes
 
 from pylint.interfaces import UNDEFINED, Confidence
 from pylint.message.message import Message
 
+_T = TypeVar("_T")
+
 
 class MessageTest(NamedTuple):
     msg_id: str
@@ -39,15 +41,17 @@ class OutputLine(NamedTuple):
     confidence: str
 
     @classmethod
-    def from_msg(cls, msg: Message) -> OutputLine:
+    def from_msg(cls, msg: Message, check_endline: bool = True) -> OutputLine:
         """Create an OutputLine from a Pylint Message."""
         column = cls._get_column(msg.column)
+        end_line = cls._get_py38_none_value(msg.end_line, check_endline)
+        end_column = cls._get_py38_none_value(msg.end_column, check_endline)
         return cls(
             msg.symbol,
             msg.line,
             column,
-            msg.end_line,
-            msg.end_column,
+            end_line,
+            end_column,
             msg.obj or "",
             msg.msg.replace("\r\n", "\n"),
             msg.confidence.name,
@@ -58,8 +62,19 @@ def _get_column(column: str | int) -> int:
         """Handle column numbers."""
         return int(column)
 
+    @staticmethod
+    def _get_py38_none_value(value: _T, check_endline: bool) -> _T | None:
+        """Used to make end_line and end_column None as indicated by our version
+        compared to `min_pyver_end_position`.
+        """
+        if not check_endline:
+            return None  # pragma: no cover
+        return value
+
     @classmethod
-    def from_csv(cls, row: Sequence[str] | str) -> OutputLine:
+    def from_csv(
+        cls, row: Sequence[str] | str, check_endline: bool = True
+    ) -> OutputLine:
         """Create an OutputLine from a comma separated list (the functional tests
         expected output .txt files).
         """
@@ -68,8 +83,12 @@ def from_csv(cls, row: Sequence[str] | str) -> OutputLine:
         try:
             line = int(row[1])
             column = cls._get_column(row[2])
-            end_line = cls._value_to_optional_int(row[3])
-            end_column = cls._value_to_optional_int(row[4])
+            end_line = cls._value_to_optional_int(
+                cls._get_py38_none_value(row[3], check_endline)
+            )
+            end_column = cls._value_to_optional_int(
+                cls._get_py38_none_value(row[4], check_endline)
+            )
             # symbol, line, column, end_line, end_column, node, msg, confidences
             assert len(row) == 8
             return cls(

tests/testutils/test_output_line.py

@@ -70,13 +70,33 @@ def test_output_line_from_message(message: _MessageCallable) -> None:
     assert output_line.msg == "msg"
     assert output_line.confidence == "HIGH"
 
+    output_line_with_end = OutputLine.from_msg(message(), True)
+    assert output_line_with_end.symbol == "missing-docstring"
+    assert output_line_with_end.lineno == 1
+    assert output_line_with_end.column == 2
+    assert output_line_with_end.end_lineno == 1
+    assert output_line_with_end.end_column == 3
+    assert output_line_with_end.object == "obj"
+    assert output_line_with_end.msg == "msg"
+    assert output_line_with_end.confidence == "HIGH"
+
+    output_line_without_end = OutputLine.from_msg(message(), False)
+    assert output_line_without_end.symbol == "missing-docstring"
+    assert output_line_without_end.lineno == 1
+    assert output_line_without_end.column == 2
+    assert output_line_without_end.end_lineno is None
+    assert output_line_without_end.end_column is None
+    assert output_line_without_end.object == "obj"
+    assert output_line_without_end.msg == "msg"
+    assert output_line_without_end.confidence == "HIGH"
+
 
 @pytest.mark.parametrize("confidence", [HIGH, INFERENCE])
 def test_output_line_to_csv(confidence: Confidence, message: _MessageCallable) -> None:
     """Test that the OutputLine NamedTuple is instantiated correctly with from_msg
     and then converted to csv.
     """
-    output_line = OutputLine.from_msg(message(confidence))
+    output_line = OutputLine.from_msg(message(confidence), True)
     csv = output_line.to_csv()
     assert csv == (
         "missing-docstring",
@@ -89,6 +109,19 @@ def test_output_line_to_csv(confidence: Confidence, message: _MessageCallable) -
         confidence.name,
     )
 
+    output_line_without_end = OutputLine.from_msg(message(confidence), False)
+    csv = output_line_without_end.to_csv()
+    assert csv == (
+        "missing-docstring",
+        "1",
+        "2",
+        "None",
+        "None",
+        "obj",
+        "msg",
+        confidence.name,
+    )
+
 
 def test_output_line_from_csv() -> None:
     """Test that the OutputLine NamedTuple is instantiated correctly with from_csv.
@@ -107,3 +140,25 @@ def test_output_line_from_csv() -> None:
         msg="msg",
         confidence="HIGH",
     )
+    output_line_with_end = OutputLine.from_csv(proper_csv, True)
+    assert output_line_with_end == OutputLine(
+        symbol="missing-docstring",
+        lineno=1,
+        column=2,
+        end_lineno=1,
+        end_column=None,
+        object="obj",
+        msg="msg",
+        confidence="HIGH",
+    )
+    output_line_without_end = OutputLine.from_csv(proper_csv, False)
+    assert output_line_without_end == OutputLine(
+        symbol="missing-docstring",
+        lineno=1,
+        column=2,
+        end_lineno=None,
+        end_column=None,
+        object="obj",
+        msg="msg",
+        confidence="HIGH",
+    )