Merge 02ad46a5a4 into 81cfb3fc87

src/_pytest/compat.py

@@ -13,6 +13,7 @@ from pathlib import Path
 from typing import Any
 from typing import Callable
 from typing import Generic
+from typing import NamedTuple
 from typing import NoReturn
 from typing import TYPE_CHECKING
 from typing import TypeVar
@@ -93,18 +94,36 @@ def is_async_function(func: object) -> bool:
     return iscoroutinefunction(func) or inspect.isasyncgenfunction(func)
 
 
-def getlocation(function, curdir: str | None = None) -> str:
+class CodeLocation(NamedTuple):
+    path: Path
+    lineno: int
+
+    def __str__(self: CodeLocation) -> str:
+        """Python 3.6.0 hack for NamedTuple __str__"""
+        return f"{self.path}:{self.lineno}"
+
+
+def getlocation(
+    function, *, relative_to: Path | None, allow_escape: bool
+) -> CodeLocation:
     function = get_real_func(function)
     fn = Path(inspect.getfile(function))
     lineno = function.__code__.co_firstlineno
-    if curdir is not None:
+
+    # TODO: this cycle indicates a larger issue
+    from .pathlib import bestrelpath
+
+    if relative_to is not None:
         try:
-            relfn = fn.relative_to(curdir)
+            if allow_escape:
+                relfn = Path(bestrelpath(relative_to, fn))
+            else:
+                relfn = relative_to.relative_to(relative_to)
         except ValueError:
             pass
         else:
-            return "%s:%d" % (relfn, lineno + 1)
-    return "%s:%d" % (fn, lineno + 1)
+            return CodeLocation(relfn, lineno + 1)
+    return CodeLocation(fn, lineno + 1)
 
 
 def num_mock_patch_args(function) -> int:

src/_pytest/fixtures.py

@@ -676,7 +676,11 @@ class FixtureRequest:
                     "\n\nRequested here:\n{}:{}".format(
                         funcitem.nodeid,
                         fixturedef.argname,
-                        getlocation(fixturedef.func, funcitem.config.rootpath),
+                        getlocation(
+                            fixturedef.func,
+                            relative_to=funcitem.config.rootpath,
+                            allow_escape=True,
+                        ),
                         source_path_str,
                         source_lineno,
                     )
@@ -1207,7 +1211,7 @@ class FixtureFunctionMarker:
 
         name = self.name or function.__name__
         if name == "request":
-            location = getlocation(function)
+            location = getlocation(function, relative_to=None, allow_escape=True)
             fail(
                 "'request' is a reserved word for fixtures, use another name:\n  {}".format(
                     location

src/_pytest/python.py

@@ -40,6 +40,7 @@ from _pytest._io import TerminalWriter
 from _pytest._io.saferepr import saferepr
 from _pytest.compat import ascii_escaped
 from _pytest.compat import assert_never
+from _pytest.compat import CodeLocation
 from _pytest.compat import final
 from _pytest.compat import get_default_arg_names
 from _pytest.compat import get_real_func
@@ -1544,7 +1545,7 @@ def _ascii_escaped_by_config(val: Union[str, bytes], config: Optional[Config]) -
 
 def _pretty_fixture_path(func) -> str:
     cwd = Path.cwd()
-    loc = Path(getlocation(func, str(cwd)))
+    loc = Path(str(getlocation(func, relative_to=cwd, allow_escape=False)))
     prefix = Path("...", "_pytest")
     try:
         return str(prefix / loc.relative_to(_PYTEST_DIR))
@@ -1566,9 +1567,8 @@ def _show_fixtures_per_test(config: Config, session: Session) -> None:
     tw = _pytest.config.create_terminal_writer(config)
     verbose = config.getvalue("verbose")
 
-    def get_best_relpath(func) -> str:
-        loc = getlocation(func, str(curdir))
-        return bestrelpath(curdir, Path(loc))
+    def get_best_relpath(func):
+        return getlocation(func, relative_to=curdir, allow_escape=False)
 
     def write_fixture(fixture_def: fixtures.FixtureDef[object]) -> None:
         argname = fixture_def.argname
@@ -1589,9 +1589,12 @@ def _show_fixtures_per_test(config: Config, session: Session) -> None:
     def write_item(item: nodes.Item) -> None:
         # Not all items have _fixtureinfo attribute.
         info: Optional[FuncFixtureInfo] = getattr(item, "_fixtureinfo", None)
+        function: Optional[Callable[..., Any]] = getattr(item, "function", None)
         if info is None or not info.name2fixturedefs:
             # This test item does not use any fixtures.
             return
+        if function is None:
+            return
         tw.line()
         tw.sep("-", f"fixtures used by {item.name}")
         # TODO: Fix this type ignore.
@@ -1625,14 +1628,14 @@ def _showfixtures_main(config: Config, session: Session) -> None:
     fm = session._fixturemanager
 
     available = []
-    seen: Set[Tuple[str, str]] = set()
+    seen: Set[Tuple[str, CodeLocation]] = set()
 
     for argname, fixturedefs in fm._arg2fixturedefs.items():
         assert fixturedefs is not None
         if not fixturedefs:
             continue
         for fixturedef in fixturedefs:
-            loc = getlocation(fixturedef.func, str(curdir))
+            loc = getlocation(fixturedef.func, relative_to=curdir, allow_escape=True)
             if (fixturedef.argname, loc) in seen:
                 continue
             seen.add((fixturedef.argname, loc))
@@ -1658,7 +1661,7 @@ def _showfixtures_main(config: Config, session: Session) -> None:
             continue
         tw.write(f"{argname}", green=True)
         if fixturedef.scope != "function":
-            tw.write(" [%s scope]" % fixturedef.scope, cyan=True)
+            tw.write(f" [{fixturedef.scope} scope]", cyan=True)
         tw.write(f" -- {prettypath}", yellow=True)
         tw.write("\n")
         doc = inspect.getdoc(fixturedef.func)