7eee5c1634
`reportinfo()` is the last remaining py.path-only code path in pytest, i.e. the last piece holding back py.path deprecation. The problem with it is that plugins/users use it from both sides -- implementing it (returning the value) and using it (using the return value). Dealing with implementers is easy enough -- allow to return `os.PathLike[str]`. But for callers who expect strictly `py.path` this will break and there's not really a good way to provide backward compat for this. From analyzing a corpus of 680 pytest plugins, the vast majority of `reportinfo` appearances are implementations, and the few callers don't actually access the path part of the return tuple. As for test suites that might access `reportinfo` (e.g. using `request.node.reportinfo()` or other ways), that is much harder to survey, but from the ones I searched, I only found case (`pytest_teamcity`, but even then it uses `str(fspath)` so is unlikely to be affected in practice). They are better served with using `node.location` or `node.path` directly. Therefore, just break it and change the return type to `str|os.PathLike[str]`. Refs #7259.
48 lines
1.4 KiB
Python
48 lines
1.4 KiB
Python
# content of conftest.py
|
|
import pytest
|
|
|
|
|
|
def pytest_collect_file(parent, fspath):
|
|
if fspath.suffix == ".yaml" and fspath.name.startswith("test"):
|
|
return YamlFile.from_parent(parent, path=fspath)
|
|
|
|
|
|
class YamlFile(pytest.File):
|
|
def collect(self):
|
|
# We need a yaml parser, e.g. PyYAML.
|
|
import yaml
|
|
|
|
raw = yaml.safe_load(self.path.open())
|
|
for name, spec in sorted(raw.items()):
|
|
yield YamlItem.from_parent(self, name=name, spec=spec)
|
|
|
|
|
|
class YamlItem(pytest.Item):
|
|
def __init__(self, name, parent, spec):
|
|
super().__init__(name, parent)
|
|
self.spec = spec
|
|
|
|
def runtest(self):
|
|
for name, value in sorted(self.spec.items()):
|
|
# Some custom test execution (dumb example follows).
|
|
if name != value:
|
|
raise YamlException(self, name, value)
|
|
|
|
def repr_failure(self, excinfo):
|
|
"""Called when self.runtest() raises an exception."""
|
|
if isinstance(excinfo.value, YamlException):
|
|
return "\n".join(
|
|
[
|
|
"usecase execution failed",
|
|
" spec failed: {1!r}: {2!r}".format(*excinfo.value.args),
|
|
" no further details known at this point.",
|
|
]
|
|
)
|
|
|
|
def reportinfo(self):
|
|
return self.path, 0, f"usecase: {self.name}"
|
|
|
|
|
|
class YamlException(Exception):
|
|
"""Custom exception for error reporting."""
|