WIP: experiment with allow_escape for getlocation

Author: RonnyPfannschmidt

src/_pytest/compat.py

@@ -82,25 +82,31 @@ class CodeLocation(NamedTuple):
     lineno: int
 
 
+# TODO: integrate after pytest 3.6.0 has been dropped
 def CodeLocation__str__(self: CodeLocation) -> str:
-    """Python 3.6 hack for NamedTuple __str__"""
+    """Python 3.6.0 hack for NamedTuple __str__"""
     return f"{self.path}:{self.lineno}"
 
 
 setattr(CodeLocation, "__str__", CodeLocation__str__)
 
 
-def getlocation(function, curdir: Optional[Path]) -> CodeLocation:
+def getlocation(
+    function, *, relative_to: Optional[Path], allow_escape: bool
+) -> CodeLocation:
     function = get_real_func(function)
     fn = Path(inspect.getfile(function))
     lineno = function.__code__.co_firstlineno
 
     # TODO: this cycle indicates a larger issue
     from .pathlib import bestrelpath
 
-    if curdir is not None:
+    if relative_to is not None:
         try:
-            relfn = Path(bestrelpath(curdir, fn))
+            if allow_escape:
+                relfn = Path(bestrelpath(relative_to, fn))
+            else:
+                relfn = relative_to.relative_to(relative_to)
         except ValueError:
             pass
         else:

src/_pytest/fixtures.py

@@ -660,7 +660,11 @@ def _compute_fixture_value(self, fixturedef: "FixtureDef[object]") -> None:
                     "\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,
                     )
@@ -1202,7 +1206,7 @@ def __call__(self, function: _FixtureFunction) -> _FixtureFunction:
 
         name = self.name or function.__name__
         if name == "request":
-            location = getlocation(function, None)
+            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

@@ -4,7 +4,6 @@
 import inspect
 import itertools
 import os
-import pathlib
 import sys
 import types
 import warnings
@@ -1408,19 +1407,18 @@ def _show_fixtures_per_test(config: Config, session: Session) -> None:
     import _pytest.config
 
     session.perform_collect()
-    curdir = pathlib.Path.cwd()
+    curdir = Path.cwd()
     tw = _pytest.config.create_terminal_writer(config)
     verbose = config.getvalue("verbose")
 
-    def get_best_relpath(func):
-        return getlocation(func, curdir)
-
     def write_fixture(fixture_def: fixtures.FixtureDef[object]) -> None:
         argname = fixture_def.argname
         if verbose <= 0 and argname.startswith("_"):
             return
         if verbose > 0:
-            bestrel = get_best_relpath(fixture_def.func)
+            bestrel = getlocation(
+                fixture_def.func, relative_to=curdir, allow_escape=True
+            )
             funcargspec = f"{argname} -- {bestrel}"
         else:
             funcargspec = argname
@@ -1434,13 +1432,17 @@ def write_fixture(fixture_def: fixtures.FixtureDef[object]) -> 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.
-        tw.sep("-", "({})".format(get_best_relpath(item.function)))  # type: ignore[attr-defined]
+
+        loc = getlocation(function, relative_to=curdir, allow_escape=True)
+        tw.sep("-", f"({loc})")
         # dict key not used in loop but needed for sorting.
         for _, fixturedefs in sorted(info.name2fixturedefs.items()):
             assert fixturedefs is not None
@@ -1477,7 +1479,7 @@ def _showfixtures_main(config: Config, session: Session) -> None:
         if not fixturedefs:
             continue
         for fixturedef in fixturedefs:
-            loc = getlocation(fixturedef.func, curdir)
+            loc = getlocation(fixturedef.func, relative_to=curdir, allow_escape=True)
             if (fixturedef.argname, loc) in seen:
                 continue
             seen.add((fixturedef.argname, loc))
@@ -1503,11 +1505,11 @@ def _showfixtures_main(config: Config, session: Session) -> None:
             continue
         tw.write(argname, green=True)
         if fixturedef.scope != "function":
-            tw.write(" [%s scope]" % fixturedef.scope, cyan=True)
+            tw.write(f" [{fixturedef.scope} scope]", cyan=True)
         if verbose > 0:
-            tw.write(" -- %s" % str(bestrel), yellow=True)
+            tw.write(f" -- {bestrel}", yellow=True)
         tw.write("\n")
-        loc = getlocation(fixturedef.func, curdir)
+        loc = getlocation(fixturedef.func, relative_to=curdir, allow_escape=True)
         doc = inspect.getdoc(fixturedef.func)
         if doc:
             write_docstring(tw, doc)