prioritize outputting relative paths

changelog/12973.improvement.rst

@@ -0,0 +1 @@
+Prioritize displaying relative paths in the terminal output, such as for :class:`~pytest.FixtureLookupError`, :class:`~pytest.Collector.CollectError`, and any warnings.

src/_pytest/config/__init__.py

@@ -1175,13 +1175,17 @@
                 sys.stderr.write(f"INTERNALERROR> {line}\n")
                 sys.stderr.flush()
 
+    def cwd_relative_path(self, fullpath: pathlib.Path | os.PathLike[str] | str) -> str:
+        path = pathlib.Path(str(fullpath))
+        return bestrelpath(self.invocation_params.dir, path)
+
     def cwd_relative_nodeid(self, nodeid: str) -> str:
         # nodeid's are relative to the rootpath, compute relative to cwd.
         if self.invocation_params.dir != self.rootpath:
             base_path_part, *nodeid_part = nodeid.split("::")
             # Only process path part
             fullpath = self.rootpath / base_path_part
-            relative_path = bestrelpath(self.invocation_params.dir, fullpath)
+            relative_path = self.cwd_relative_path(fullpath)
 
             nodeid = "::".join([relative_path, *nodeid_part])
         return nodeid

src/_pytest/fixtures.py

@@ -811,6 +811,8 @@ def formatrepr(self) -> FixtureLookupErrorRepr:
             stack = stack[:-1]
         for function in stack:
             fspath, lineno = getfslineno(function)
+            fspath = self.request.config.cwd_relative_path(fspath)
+
             try:
                 lines, _ = inspect.getsourcelines(get_real_func(function))
             except (OSError, IndexError, TypeError):

src/_pytest/python.py

@@ -519,8 +519,9 @@
             else exc_info.exconly()
         )
         formatted_tb = str(exc_repr)
+        relative_path = config.cwd_relative_path(path)
         raise nodes.Collector.CollectError(
-            f"ImportError while importing test module '{path}'.\n"
+            f"ImportError while importing test module '{relative_path}'.\n"
             "Hint: make sure your test modules/packages have valid Python names.\n"
             "Traceback:\n"
             f"{formatted_tb}"

src/_pytest/reports.py

@@ -367,9 +367,11 @@
                 if excinfo.value._use_item_location:
                     path, line = item.reportinfo()[:2]
                     assert line is not None
-                    longrepr = os.fspath(path), line + 1, r.message
+                    relative_path = item.config.cwd_relative_path(path)
+                    longrepr = relative_path, line + 1, r.message
                 else:
-                    longrepr = (str(r.path), r.lineno, r.message)
+                    relative_path = item.config.cwd_relative_path(r.path)
+                    longrepr = (relative_path, r.lineno, r.message)
             else:
                 outcome = "failed"
                 if call.when == "call":

src/_pytest/warnings.py

@@ -64,6 +64,9 @@
             yield
         finally:
             for warning_message in log:
+                warning_message.filename = config.cwd_relative_path(
+                    warning_message.filename
+                )
                 ihook.pytest_warning_recorded.call_historic(
                     kwargs=dict(
                         warning_message=warning_message,

testing/python/collect.py

@@ -1682,3 +1682,19 @@ def test_collection_hierarchy(pytester: Pytester) -> None:
         ],
         consecutive=True,
     )
+
+
+def test_output_relative_path_when_import_error(pytester: Pytester) -> None:
+    pytester.makepyfile(
+        **{"tests/test_p1": "raise ImportError('Something bad happened ☺')"}
+    )
+    relative_path = os.path.join("tests", "test_p1.py")
+
+    result = pytester.runpytest()
+    result.stdout.fnmatch_lines(
+        [
+            f"ImportError while importing test module '{relative_path}'*",
+            "Traceback:",
+            "*raise ImportError*Something bad happened*",
+        ]
+    )

testing/test_junitxml.py

@@ -1760,3 +1760,27 @@ def test_func():
         assert junit_logging == "no"
         assert len(node.find_by_tag("system-err")) == 0
         assert len(node.find_by_tag("system-out")) == 0
+
+
+def test_output_relative_path_when_skip(pytester: Pytester) -> None:
+    pytester.makepyfile(
+        **{
+            "tests/test_p1": """
+        import pytest
+        @pytest.mark.skip("balabala")
+        def test_skip():
+            pass
+        """
+        }
+    )
+    pytester.runpytest("--junit-xml=junit.xml")
+
+    dom = minidom.parse(str(pytester.path / "junit.xml"))
+
+    el = dom.getElementsByTagName("skipped")[0]
+
+    assert el.getAttribute("message") == "balabala"
+
+    text = el.childNodes[0].nodeValue
+    relative_path = os.path.join("tests", "test_p1.py")
+    assert text == f"{relative_path}:2: balabala"

testing/test_terminal.py

@@ -3069,6 +3069,21 @@ def test_pass():
     )
 
 
+def test_output_relative_path_by_fixture(pytester: Pytester) -> None:
+    pytester.makepyfile(
+        **{
+            "tests/test_p1": """
+        def test_pass(miss_setup):
+            print('hi there')
+        """
+        }
+    )
+    result = pytester.runpytest("-rX")
+
+    relative_path = os.path.join("tests", "test_p1.py")
+    result.stdout.fnmatch_lines([f"file {relative_path}, line 1"])
+
+
 class TestNodeIDHandling:
     def test_nodeid_handling_windows_paths(self, pytester: Pytester, tmp_path) -> None:
         """Test the correct handling of Windows-style paths with backslashes."""

testing/test_warnings.py

@@ -6,6 +6,7 @@
 import warnings
 
 from _pytest.fixtures import FixtureRequest
+from _pytest.pathlib import bestrelpath
 from _pytest.pytester import Pytester
 import pytest
 
@@ -589,15 +590,15 @@ def test_group_warnings_by_message(pytester: Pytester) -> None:
             "test_group_warnings_by_message.py::test_foo[[]3[]]",
             "test_group_warnings_by_message.py::test_foo[[]4[]]",
             "test_group_warnings_by_message.py::test_foo_1",
-            "  */test_group_warnings_by_message.py:*: UserWarning: foo",
+            "  test_group_warnings_by_message.py:*: UserWarning: foo",
             "    warnings.warn(UserWarning(msg))",
             "",
             "test_group_warnings_by_message.py::test_bar[[]0[]]",
             "test_group_warnings_by_message.py::test_bar[[]1[]]",
             "test_group_warnings_by_message.py::test_bar[[]2[]]",
             "test_group_warnings_by_message.py::test_bar[[]3[]]",
             "test_group_warnings_by_message.py::test_bar[[]4[]]",
-            "  */test_group_warnings_by_message.py:*: UserWarning: bar",
+            "  test_group_warnings_by_message.py:*: UserWarning: bar",
             "    warnings.warn(UserWarning(msg))",
             "",
             "-- Docs: *",
@@ -617,11 +618,11 @@ def test_group_warnings_by_message_summary(pytester: Pytester) -> None:
             f"*== {WARNINGS_SUMMARY_HEADER} ==*",
             "test_1.py: 21 warnings",
             "test_2.py: 1 warning",
-            "  */test_1.py:10: UserWarning: foo",
+            "  test_1.py:10: UserWarning: foo",
             "    warnings.warn(UserWarning(msg))",
             "",
             "test_1.py: 20 warnings",
-            "  */test_1.py:10: UserWarning: bar",
+            "  test_1.py:10: UserWarning: bar",
             "    warnings.warn(UserWarning(msg))",
             "",
             "-- Docs: *",
@@ -762,10 +763,11 @@ def test_it():
             """
         )
         result = pytester.runpytest_subprocess()
+        relative_path = bestrelpath(pytester.path, testfile)
         # with stacklevel=2 the warning should originate from the above created test file
         result.stdout.fnmatch_lines_random(
             [
-                f"*{testfile}:3*",
+                f"*{relative_path}:3*",
                 "*Unknown pytest.mark.unknown*",
             ]
         )
@@ -837,3 +839,29 @@ def test_resource_warning(tmp_path):
         else []
     )
     result.stdout.fnmatch_lines([*expected_extra, "*1 passed*"])
+
+
+@pytest.mark.filterwarnings("always::UserWarning")
+def test_output_relative_path_when_warnings(pytester: Pytester) -> None:
+    pytester.makeini("[pytest]")
+    pytester.makepyfile(
+        **{
+            "tests/test_p1": """
+        import pytest
+
+        @pytest.mark.unknown_mark
+        def test_pass():
+            pass
+        """
+        }
+    )
+    result = pytester.runpytest()
+
+    relative_path = os.path.join("tests", "test_p1.py")
+    result.stdout.fnmatch_lines(
+        [
+            f"*== {WARNINGS_SUMMARY_HEADER} ==*",
+            f"{relative_path}:3",
+            f"* {relative_path}:3: PytestUnknownMarkWarning: Unknown pytest.mark.unknown_mark - is this a typo?*",
+        ]
+    )