fixtures: simplify scope checking
There are two non-optimal things in the current way scope checking is done: - It runs on `SubRequest`, but doesn't use the `SubRequest's scope, which is confusing. Instead it takes `invoking_scope` and `requested_scope`. - Because `_check_scope` is only defined on `SubRequest` and not `TopRequest`, `_compute_fixture_value` first creates the `SubRequest` only then checks the scope (hence the need for the previous point). Instead, also define `_check_scope` on `TopRequest` (always valid), and remove `invoking_scope`, using `self._scope` instead.
This commit is contained in:
parent
83887c066b
commit
a9d1f55a0f
|
@ -388,6 +388,14 @@ class FixtureRequest(abc.ABC):
|
||||||
"""Scope string, one of "function", "class", "module", "package", "session"."""
|
"""Scope string, one of "function", "class", "module", "package", "session"."""
|
||||||
return self._scope.value
|
return self._scope.value
|
||||||
|
|
||||||
|
@abc.abstractmethod
|
||||||
|
def _check_scope(
|
||||||
|
self,
|
||||||
|
requested_fixturedef: Union["FixtureDef[object]", PseudoFixtureDef[object]],
|
||||||
|
requested_scope: Scope,
|
||||||
|
) -> None:
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def fixturenames(self) -> List[str]:
|
def fixturenames(self) -> List[str]:
|
||||||
"""Names of all active fixtures in this request."""
|
"""Names of all active fixtures in this request."""
|
||||||
|
@ -632,12 +640,12 @@ class FixtureRequest(abc.ABC):
|
||||||
)
|
)
|
||||||
fail(msg, pytrace=False)
|
fail(msg, pytrace=False)
|
||||||
|
|
||||||
|
# Check if a higher-level scoped fixture accesses a lower level one.
|
||||||
|
self._check_scope(fixturedef, scope)
|
||||||
|
|
||||||
subrequest = SubRequest(
|
subrequest = SubRequest(
|
||||||
self, scope, param, param_index, fixturedef, _ispytest=True
|
self, scope, param, param_index, fixturedef, _ispytest=True
|
||||||
)
|
)
|
||||||
|
|
||||||
# Check if a higher-level scoped fixture accesses a lower level one.
|
|
||||||
subrequest._check_scope(argname, self._scope, scope)
|
|
||||||
try:
|
try:
|
||||||
# Call the fixture function.
|
# Call the fixture function.
|
||||||
fixturedef.execute(request=subrequest)
|
fixturedef.execute(request=subrequest)
|
||||||
|
@ -669,6 +677,14 @@ class TopRequest(FixtureRequest):
|
||||||
def _scope(self) -> Scope:
|
def _scope(self) -> Scope:
|
||||||
return Scope.Function
|
return Scope.Function
|
||||||
|
|
||||||
|
def _check_scope(
|
||||||
|
self,
|
||||||
|
requested_fixturedef: Union["FixtureDef[object]", PseudoFixtureDef[object]],
|
||||||
|
requested_scope: Scope,
|
||||||
|
) -> None:
|
||||||
|
# TopRequest always has function scope so always valid.
|
||||||
|
pass
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def node(self):
|
def node(self):
|
||||||
return self._pyfuncitem
|
return self._pyfuncitem
|
||||||
|
@ -740,37 +756,33 @@ class SubRequest(FixtureRequest):
|
||||||
|
|
||||||
def _check_scope(
|
def _check_scope(
|
||||||
self,
|
self,
|
||||||
argname: str,
|
requested_fixturedef: Union["FixtureDef[object]", PseudoFixtureDef[object]],
|
||||||
invoking_scope: Scope,
|
|
||||||
requested_scope: Scope,
|
requested_scope: Scope,
|
||||||
) -> None:
|
) -> None:
|
||||||
if argname == "request":
|
if isinstance(requested_fixturedef, PseudoFixtureDef):
|
||||||
return
|
return
|
||||||
if invoking_scope > requested_scope:
|
if self._scope > requested_scope:
|
||||||
# Try to report something helpful.
|
# Try to report something helpful.
|
||||||
text = "\n".join(self._factorytraceback())
|
argname = requested_fixturedef.argname
|
||||||
|
fixture_stack = "\n".join(
|
||||||
|
self._format_fixturedef_line(fixturedef)
|
||||||
|
for fixturedef in self._get_fixturestack()
|
||||||
|
)
|
||||||
|
requested_fixture = self._format_fixturedef_line(requested_fixturedef)
|
||||||
fail(
|
fail(
|
||||||
f"ScopeMismatch: You tried to access the {requested_scope.value} scoped "
|
f"ScopeMismatch: You tried to access the {requested_scope.value} scoped "
|
||||||
f"fixture {argname} with a {invoking_scope.value} scoped request object, "
|
f"fixture {argname} with a {self._scope.value} scoped request object, "
|
||||||
f"involved factories:\n{text}",
|
f"involved factories:\n{fixture_stack}\n{requested_fixture}",
|
||||||
pytrace=False,
|
pytrace=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
def _factorytraceback(self) -> List[str]:
|
def _format_fixturedef_line(self, fixturedef: "FixtureDef[object]") -> str:
|
||||||
lines = []
|
factory = fixturedef.func
|
||||||
for fixturedef in self._get_fixturestack():
|
path, lineno = getfslineno(factory)
|
||||||
factory = fixturedef.func
|
if isinstance(path, Path):
|
||||||
fs, lineno = getfslineno(factory)
|
path = bestrelpath(self._pyfuncitem.session.path, path)
|
||||||
if isinstance(fs, Path):
|
signature = inspect.signature(factory)
|
||||||
session: Session = self._pyfuncitem.session
|
return f"{path}:{lineno + 1}: def {factory.__name__}{signature}"
|
||||||
p = bestrelpath(session.path, fs)
|
|
||||||
else:
|
|
||||||
p = fs
|
|
||||||
lines.append(
|
|
||||||
"%s:%d: def %s%s"
|
|
||||||
% (p, lineno + 1, factory.__name__, inspect.signature(factory))
|
|
||||||
)
|
|
||||||
return lines
|
|
||||||
|
|
||||||
def addfinalizer(self, finalizer: Callable[[], object]) -> None:
|
def addfinalizer(self, finalizer: Callable[[], object]) -> None:
|
||||||
self._fixturedef.addfinalizer(finalizer)
|
self._fixturedef.addfinalizer(finalizer)
|
||||||
|
@ -1111,7 +1123,7 @@ def pytest_fixture_setup(
|
||||||
fixdef = request._get_active_fixturedef(argname)
|
fixdef = request._get_active_fixturedef(argname)
|
||||||
assert fixdef.cached_result is not None
|
assert fixdef.cached_result is not None
|
||||||
result, arg_cache_key, exc = fixdef.cached_result
|
result, arg_cache_key, exc = fixdef.cached_result
|
||||||
request._check_scope(argname, request._scope, fixdef._scope)
|
request._check_scope(fixdef, fixdef._scope)
|
||||||
kwargs[argname] = result
|
kwargs[argname] = result
|
||||||
|
|
||||||
fixturefunc = resolve_fixture_function(fixturedef, request)
|
fixturefunc = resolve_fixture_function(fixturedef, request)
|
||||||
|
|
Loading…
Reference in New Issue