Improve typing of reports' longrepr field

src/_pytest/junitxml.py

@@ -25,6 +25,7 @@ from _pytest import deprecated
 from _pytest import nodes
 from _pytest import timing
 from _pytest._code.code import ExceptionRepr
+from _pytest._code.code import ReprFileLocation
 from _pytest.config import Config
 from _pytest.config import filename_arg
 from _pytest.config.argparsing import Parser
@@ -200,8 +201,11 @@ class _NodeReporter:
             self._add_simple("skipped", "xfail-marked test passes unexpectedly")
         else:
             assert report.longrepr is not None
-            if getattr(report.longrepr, "reprcrash", None) is not None:
+            reprcrash = getattr(
-                message = report.longrepr.reprcrash.message
+                report.longrepr, "reprcrash", None
+            )  # type: Optional[ReprFileLocation]
+            if reprcrash is not None:
+                message = reprcrash.message
             else:
                 message = str(report.longrepr)
             message = bin_xml_escape(message)
@@ -217,8 +221,11 @@ class _NodeReporter:
 
     def append_error(self, report: TestReport) -> None:
         assert report.longrepr is not None
-        if getattr(report.longrepr, "reprcrash", None) is not None:
+        reprcrash = getattr(
-            reason = report.longrepr.reprcrash.message
+            report.longrepr, "reprcrash", None
+        )  # type: Optional[ReprFileLocation]
+        if reprcrash is not None:
+            reason = reprcrash.message
         else:
             reason = str(report.longrepr)
 
@@ -237,7 +244,7 @@ class _NodeReporter:
             skipped = ET.Element("skipped", type="pytest.xfail", message=xfailreason)
             self.append(skipped)
         else:
-            assert report.longrepr is not None
+            assert isinstance(report.longrepr, tuple)
             filename, lineno, skipreason = report.longrepr
             if skipreason.startswith("Skipped: "):
                 skipreason = skipreason[9:]

src/_pytest/reports.py

@@ -1,6 +1,7 @@
 from io import StringIO
 from pprint import pprint
 from typing import Any
+from typing import cast
 from typing import Dict
 from typing import Iterable
 from typing import Iterator
@@ -15,6 +16,7 @@ import py
 
 from _pytest._code.code import ExceptionChainRepr
 from _pytest._code.code import ExceptionInfo
+from _pytest._code.code import ExceptionRepr
 from _pytest._code.code import ReprEntry
 from _pytest._code.code import ReprEntryNative
 from _pytest._code.code import ReprExceptionInfo
@@ -57,8 +59,9 @@ _R = TypeVar("_R", bound="BaseReport")
 class BaseReport:
     when = None  # type: Optional[str]
     location = None  # type: Optional[Tuple[str, Optional[int], str]]
-    # TODO: Improve this Any.
+    longrepr = (
-    longrepr = None  # type: Optional[Any]
+        None
+    )  # type: Union[None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr]
     sections = []  # type: List[Tuple[str, str]]
     nodeid = None  # type: str
 
@@ -79,7 +82,8 @@ class BaseReport:
             return
 
         if hasattr(longrepr, "toterminal"):
-            longrepr.toterminal(out)
+            longrepr_terminal = cast(TerminalRepr, longrepr)
+            longrepr_terminal.toterminal(out)
         else:
             try:
                 s = str(longrepr)
@@ -233,7 +237,9 @@ class TestReport(BaseReport):
         location: Tuple[str, Optional[int], str],
         keywords,
         outcome: "Literal['passed', 'failed', 'skipped']",
-        longrepr,
+        longrepr: Union[
+            None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr
+        ],
         when: "Literal['setup', 'call', 'teardown']",
         sections: Iterable[Tuple[str, str]] = (),
         duration: float = 0,
@@ -293,8 +299,9 @@ class TestReport(BaseReport):
         sections = []
         if not call.excinfo:
             outcome = "passed"  # type: Literal["passed", "failed", "skipped"]
-            # TODO: Improve this Any.
+            longrepr = (
-            longrepr = None  # type: Optional[Any]
+                None
+            )  # type: Union[None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr]
         else:
             if not isinstance(excinfo, ExceptionInfo):
                 outcome = "failed"
@@ -372,7 +379,7 @@ class CollectReport(BaseReport):
 
 
 class CollectErrorRepr(TerminalRepr):
-    def __init__(self, msg) -> None:
+    def __init__(self, msg: str) -> None:
         self.longrepr = msg
 
     def toterminal(self, out: TerminalWriter) -> None:
@@ -436,16 +443,18 @@ def _report_to_json(report: BaseReport) -> Dict[str, Any]:
         else:
             return None
 
-    def serialize_longrepr(rep: BaseReport) -> Dict[str, Any]:
+    def serialize_exception_longrepr(rep: BaseReport) -> Dict[str, Any]:
         assert rep.longrepr is not None
+        # TODO: Investigate whether the duck typing is really necessary here.
+        longrepr = cast(ExceptionRepr, rep.longrepr)
         result = {
-            "reprcrash": serialize_repr_crash(rep.longrepr.reprcrash),
+            "reprcrash": serialize_repr_crash(longrepr.reprcrash),
-            "reprtraceback": serialize_repr_traceback(rep.longrepr.reprtraceback),
+            "reprtraceback": serialize_repr_traceback(longrepr.reprtraceback),
-            "sections": rep.longrepr.sections,
+            "sections": longrepr.sections,
         }  # type: Dict[str, Any]
-        if isinstance(rep.longrepr, ExceptionChainRepr):
+        if isinstance(longrepr, ExceptionChainRepr):
             result["chain"] = []
-            for repr_traceback, repr_crash, description in rep.longrepr.chain:
+            for repr_traceback, repr_crash, description in longrepr.chain:
                 result["chain"].append(
                     (
                         serialize_repr_traceback(repr_traceback),
@@ -462,7 +471,7 @@ def _report_to_json(report: BaseReport) -> Dict[str, Any]:
         if hasattr(report.longrepr, "reprtraceback") and hasattr(
             report.longrepr, "reprcrash"
         ):
-            d["longrepr"] = serialize_longrepr(report)
+            d["longrepr"] = serialize_exception_longrepr(report)
         else:
             d["longrepr"] = str(report.longrepr)
     else:

src/_pytest/resultlog.py

@@ -85,7 +85,7 @@ class ResultLog:
         elif report.passed:
             longrepr = ""
         elif report.skipped:
-            assert report.longrepr is not None
+            assert isinstance(report.longrepr, tuple)
             longrepr = str(report.longrepr[2])
         else:
             longrepr = str(report.longrepr)

src/_pytest/runner.py

@@ -2,7 +2,6 @@
 import bdb
 import os
 import sys
-from typing import Any
 from typing import Callable
 from typing import cast
 from typing import Dict
@@ -22,6 +21,7 @@ from .reports import TestReport
 from _pytest import timing
 from _pytest._code.code import ExceptionChainRepr
 from _pytest._code.code import ExceptionInfo
+from _pytest._code.code import TerminalRepr
 from _pytest.compat import TYPE_CHECKING
 from _pytest.config.argparsing import Parser
 from _pytest.nodes import Collector
@@ -327,8 +327,7 @@ def pytest_runtest_makereport(item: Item, call: CallInfo[None]) -> TestReport:
 
 def pytest_make_collect_report(collector: Collector) -> CollectReport:
     call = CallInfo.from_call(lambda: list(collector.collect()), "collect")
-    # TODO: Better typing for longrepr.
+    longrepr = None  # type: Union[None, Tuple[str, int, str], str, TerminalRepr]
-    longrepr = None  # type: Optional[Any]
     if not call.excinfo:
         outcome = "passed"  # type: Literal["passed", "skipped", "failed"]
     else:
@@ -348,6 +347,7 @@ def pytest_make_collect_report(collector: Collector) -> CollectReport:
             outcome = "failed"
             errorinfo = collector.repr_failure(call.excinfo)
             if not hasattr(errorinfo, "toterminal"):
+                assert isinstance(errorinfo, str)
                 errorinfo = CollectErrorRepr(errorinfo)
             longrepr = errorinfo
     result = call.result if not call.excinfo else None

src/_pytest/terminal.py

@@ -1247,6 +1247,7 @@ def _folded_skips(
     d = {}  # type: Dict[Tuple[str, Optional[int], str], List[CollectReport]]
     for event in skipped:
         assert event.longrepr is not None
+        assert isinstance(event.longrepr, tuple), (event, event.longrepr)
         assert len(event.longrepr) == 3, (event, event.longrepr)
         fspath, lineno, reason = event.longrepr
         # For consistency, report all fspaths in relative form.

testing/test_reports.py

@@ -1,14 +1,19 @@
 import sys
+from typing import Sequence
+from typing import Union
 
 import pytest
 from _pytest._code.code import ExceptionChainRepr
+from _pytest._code.code import ExceptionRepr
+from _pytest.config import Config
 from _pytest.pathlib import Path
+from _pytest.pytester import Testdir
 from _pytest.reports import CollectReport
 from _pytest.reports import TestReport
 
 
 class TestReportSerialization:
-    def test_xdist_longrepr_to_str_issue_241(self, testdir):
+    def test_xdist_longrepr_to_str_issue_241(self, testdir: Testdir) -> None:
         """Regarding issue pytest-xdist#241.
 
         This test came originally from test_remote.py in xdist (ca03269).
@@ -31,7 +36,7 @@ class TestReportSerialization:
         assert test_b_call.outcome == "passed"
         assert test_b_call._to_json()["longrepr"] is None
 
-    def test_xdist_report_longrepr_reprcrash_130(self, testdir) -> None:
+    def test_xdist_report_longrepr_reprcrash_130(self, testdir: Testdir) -> None:
         """Regarding issue pytest-xdist#130
 
         This test came originally from test_remote.py in xdist (ca03269).
@@ -46,15 +51,18 @@ class TestReportSerialization:
         assert len(reports) == 3
         rep = reports[1]
         added_section = ("Failure Metadata", "metadata metadata", "*")
+        assert isinstance(rep.longrepr, ExceptionRepr)
         rep.longrepr.sections.append(added_section)
         d = rep._to_json()
         a = TestReport._from_json(d)
-        assert a.longrepr is not None
+        assert isinstance(a.longrepr, ExceptionRepr)
         # Check assembled == rep
         assert a.__dict__.keys() == rep.__dict__.keys()
         for key in rep.__dict__.keys():
             if key != "longrepr":
                 assert getattr(a, key) == getattr(rep, key)
+        assert rep.longrepr.reprcrash is not None
+        assert a.longrepr.reprcrash is not None
         assert rep.longrepr.reprcrash.lineno == a.longrepr.reprcrash.lineno
         assert rep.longrepr.reprcrash.message == a.longrepr.reprcrash.message
         assert rep.longrepr.reprcrash.path == a.longrepr.reprcrash.path
@@ -67,7 +75,7 @@ class TestReportSerialization:
         # Missing section attribute PR171
         assert added_section in a.longrepr.sections
 
-    def test_reprentries_serialization_170(self, testdir) -> None:
+    def test_reprentries_serialization_170(self, testdir: Testdir) -> None:
         """Regarding issue pytest-xdist#170
 
         This test came originally from test_remote.py in xdist (ca03269).
@@ -85,25 +93,35 @@ class TestReportSerialization:
         reports = reprec.getreports("pytest_runtest_logreport")
         assert len(reports) == 3
         rep = reports[1]
+        assert isinstance(rep.longrepr, ExceptionRepr)
         d = rep._to_json()
         a = TestReport._from_json(d)
-        assert a.longrepr is not None
+        assert isinstance(a.longrepr, ExceptionRepr)
 
         rep_entries = rep.longrepr.reprtraceback.reprentries
         a_entries = a.longrepr.reprtraceback.reprentries
         for i in range(len(a_entries)):
-            assert isinstance(rep_entries[i], ReprEntry)
+            rep_entry = rep_entries[i]
-            assert rep_entries[i].lines == a_entries[i].lines
+            assert isinstance(rep_entry, ReprEntry)
-            assert rep_entries[i].reprfileloc.lineno == a_entries[i].reprfileloc.lineno
+            assert rep_entry.reprfileloc is not None
-            assert (
+            assert rep_entry.reprfuncargs is not None
-                rep_entries[i].reprfileloc.message == a_entries[i].reprfileloc.message
+            assert rep_entry.reprlocals is not None
-            )
-            assert rep_entries[i].reprfileloc.path == a_entries[i].reprfileloc.path
-            assert rep_entries[i].reprfuncargs.args == a_entries[i].reprfuncargs.args
-            assert rep_entries[i].reprlocals.lines == a_entries[i].reprlocals.lines
-            assert rep_entries[i].style == a_entries[i].style
 
-    def test_reprentries_serialization_196(self, testdir) -> None:
+            a_entry = a_entries[i]
+            assert isinstance(a_entry, ReprEntry)
+            assert a_entry.reprfileloc is not None
+            assert a_entry.reprfuncargs is not None
+            assert a_entry.reprlocals is not None
+
+            assert rep_entry.lines == a_entry.lines
+            assert rep_entry.reprfileloc.lineno == a_entry.reprfileloc.lineno
+            assert rep_entry.reprfileloc.message == a_entry.reprfileloc.message
+            assert rep_entry.reprfileloc.path == a_entry.reprfileloc.path
+            assert rep_entry.reprfuncargs.args == a_entry.reprfuncargs.args
+            assert rep_entry.reprlocals.lines == a_entry.reprlocals.lines
+            assert rep_entry.style == a_entry.style
+
+    def test_reprentries_serialization_196(self, testdir: Testdir) -> None:
         """Regarding issue pytest-xdist#196
 
         This test came originally from test_remote.py in xdist (ca03269).
@@ -121,9 +139,10 @@ class TestReportSerialization:
         reports = reprec.getreports("pytest_runtest_logreport")
         assert len(reports) == 3
         rep = reports[1]
+        assert isinstance(rep.longrepr, ExceptionRepr)
         d = rep._to_json()
         a = TestReport._from_json(d)
-        assert a.longrepr is not None
+        assert isinstance(a.longrepr, ExceptionRepr)
 
         rep_entries = rep.longrepr.reprtraceback.reprentries
         a_entries = a.longrepr.reprtraceback.reprentries
@@ -131,7 +150,7 @@ class TestReportSerialization:
             assert isinstance(rep_entries[i], ReprEntryNative)
             assert rep_entries[i].lines == a_entries[i].lines
 
-    def test_itemreport_outcomes(self, testdir):
+    def test_itemreport_outcomes(self, testdir: Testdir) -> None:
         # This test came originally from test_remote.py in xdist (ca03269).
         reprec = testdir.inline_runsource(
             """
@@ -157,7 +176,7 @@ class TestReportSerialization:
             assert newrep.failed == rep.failed
             assert newrep.skipped == rep.skipped
             if newrep.skipped and not hasattr(newrep, "wasxfail"):
-                assert newrep.longrepr is not None
+                assert isinstance(newrep.longrepr, tuple)
                 assert len(newrep.longrepr) == 3
             assert newrep.outcome == rep.outcome
             assert newrep.when == rep.when
@@ -165,7 +184,7 @@ class TestReportSerialization:
             if rep.failed:
                 assert newrep.longreprtext == rep.longreprtext
 
-    def test_collectreport_passed(self, testdir):
+    def test_collectreport_passed(self, testdir: Testdir) -> None:
         """This test came originally from test_remote.py in xdist (ca03269)."""
         reprec = testdir.inline_runsource("def test_func(): pass")
         reports = reprec.getreports("pytest_collectreport")
@@ -176,7 +195,7 @@ class TestReportSerialization:
             assert newrep.failed == rep.failed
             assert newrep.skipped == rep.skipped
 
-    def test_collectreport_fail(self, testdir):
+    def test_collectreport_fail(self, testdir: Testdir) -> None:
         """This test came originally from test_remote.py in xdist (ca03269)."""
         reprec = testdir.inline_runsource("qwe abc")
         reports = reprec.getreports("pytest_collectreport")
@@ -190,13 +209,13 @@ class TestReportSerialization:
             if rep.failed:
                 assert newrep.longrepr == str(rep.longrepr)
 
-    def test_extended_report_deserialization(self, testdir):
+    def test_extended_report_deserialization(self, testdir: Testdir) -> None:
         """This test came originally from test_remote.py in xdist (ca03269)."""
         reprec = testdir.inline_runsource("qwe abc")
         reports = reprec.getreports("pytest_collectreport")
         assert reports
         for rep in reports:
-            rep.extra = True
+            rep.extra = True  # type: ignore[attr-defined]
             d = rep._to_json()
             newrep = CollectReport._from_json(d)
             assert newrep.extra
@@ -206,7 +225,7 @@ class TestReportSerialization:
             if rep.failed:
                 assert newrep.longrepr == str(rep.longrepr)
 
-    def test_paths_support(self, testdir):
+    def test_paths_support(self, testdir: Testdir) -> None:
         """Report attributes which are py.path or pathlib objects should become strings."""
         testdir.makepyfile(
             """
@@ -218,13 +237,13 @@ class TestReportSerialization:
         reports = reprec.getreports("pytest_runtest_logreport")
         assert len(reports) == 3
         test_a_call = reports[1]
-        test_a_call.path1 = testdir.tmpdir
+        test_a_call.path1 = testdir.tmpdir  # type: ignore[attr-defined]
-        test_a_call.path2 = Path(testdir.tmpdir)
+        test_a_call.path2 = Path(testdir.tmpdir)  # type: ignore[attr-defined]
         data = test_a_call._to_json()
         assert data["path1"] == str(testdir.tmpdir)
         assert data["path2"] == str(testdir.tmpdir)
 
-    def test_deserialization_failure(self, testdir):
+    def test_deserialization_failure(self, testdir: Testdir) -> None:
         """Check handling of failure during deserialization of report types."""
         testdir.makepyfile(
             """
@@ -247,7 +266,7 @@ class TestReportSerialization:
             TestReport._from_json(data)
 
     @pytest.mark.parametrize("report_class", [TestReport, CollectReport])
-    def test_chained_exceptions(self, testdir, tw_mock, report_class):
+    def test_chained_exceptions(self, testdir: Testdir, tw_mock, report_class) -> None:
         """Check serialization/deserialization of report objects containing chained exceptions (#5786)"""
         testdir.makepyfile(
             """
@@ -267,7 +286,9 @@ class TestReportSerialization:
 
         reprec = testdir.inline_run()
         if report_class is TestReport:
-            reports = reprec.getreports("pytest_runtest_logreport")
+            reports = reprec.getreports(
+                "pytest_runtest_logreport"
+            )  # type: Union[Sequence[TestReport], Sequence[CollectReport]]
             # we have 3 reports: setup/call/teardown
             assert len(reports) == 3
             # get the call report
@@ -279,7 +300,7 @@ class TestReportSerialization:
             assert len(reports) == 2
             report = reports[1]
 
-        def check_longrepr(longrepr):
+        def check_longrepr(longrepr: ExceptionChainRepr) -> None:
             """Check the attributes of the given longrepr object according to the test file.
 
             We can get away with testing both CollectReport and TestReport with this function because
@@ -303,6 +324,7 @@ class TestReportSerialization:
 
         assert report.failed
         assert len(report.sections) == 0
+        assert isinstance(report.longrepr, ExceptionChainRepr)
         report.longrepr.addsection("title", "contents", "=")
         check_longrepr(report.longrepr)
 
@@ -317,7 +339,7 @@ class TestReportSerialization:
         # elsewhere and we do check the contents of the longrepr object after loading it.
         loaded_report.longrepr.toterminal(tw_mock)
 
-    def test_chained_exceptions_no_reprcrash(self, testdir, tw_mock) -> None:
+    def test_chained_exceptions_no_reprcrash(self, testdir: Testdir, tw_mock) -> None:
         """Regression test for tracebacks without a reprcrash (#5971)
 
         This happens notably on exceptions raised by multiprocess.pool: the exception transfer
@@ -368,7 +390,7 @@ class TestReportSerialization:
 
         reports = reprec.getreports("pytest_runtest_logreport")
 
-        def check_longrepr(longrepr) -> None:
+        def check_longrepr(longrepr: object) -> None:
             assert isinstance(longrepr, ExceptionChainRepr)
             assert len(longrepr.chain) == 2
             entry1, entry2 = longrepr.chain
@@ -397,9 +419,12 @@ class TestReportSerialization:
 
         # for same reasons as previous test, ensure we don't blow up here
         assert loaded_report.longrepr is not None
+        assert isinstance(loaded_report.longrepr, ExceptionChainRepr)
         loaded_report.longrepr.toterminal(tw_mock)
 
-    def test_report_prevent_ConftestImportFailure_hiding_exception(self, testdir):
+    def test_report_prevent_ConftestImportFailure_hiding_exception(
+        self, testdir: Testdir
+    ) -> None:
         sub_dir = testdir.tmpdir.join("ns").ensure_dir()
         sub_dir.join("conftest").new(ext=".py").write("import unknown")
 
@@ -411,7 +436,7 @@ class TestReportSerialization:
 class TestHooks:
     """Test that the hooks are working correctly for plugins"""
 
-    def test_test_report(self, testdir, pytestconfig):
+    def test_test_report(self, testdir: Testdir, pytestconfig: Config) -> None:
         testdir.makepyfile(
             """
             def test_a(): assert False
@@ -433,7 +458,7 @@ class TestHooks:
             assert new_rep.when == rep.when
             assert new_rep.outcome == rep.outcome
 
-    def test_collect_report(self, testdir, pytestconfig):
+    def test_collect_report(self, testdir: Testdir, pytestconfig: Config) -> None:
         testdir.makepyfile(
             """
             def test_a(): assert False
@@ -458,7 +483,9 @@ class TestHooks:
     @pytest.mark.parametrize(
         "hook_name", ["pytest_runtest_logreport", "pytest_collectreport"]
     )
-    def test_invalid_report_types(self, testdir, pytestconfig, hook_name):
+    def test_invalid_report_types(
+        self, testdir: Testdir, pytestconfig: Config, hook_name: str
+    ) -> None:
         testdir.makepyfile(
             """
             def test_a(): pass