From 569c091769d6739d262ee796e71f5f70dc81bf19 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 31 Oct 2020 08:45:34 -0300 Subject: Add FunctionDefinition to the reference docs Fix #7968 --- src/_pytest/python.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/_pytest/python.py b/src/_pytest/python.py index 35797cc07..9e988032d 100644 --- a/src/_pytest/python.py +++ b/src/_pytest/python.py @@ -960,6 +960,7 @@ class Metafunc: cls=None, module=None, ) -> None: + #: Access to the underlying :class:`_pytest.python.FunctionDefinition`. self.definition = definition #: Access to the :class:`_pytest.config.Config` object for the test session. @@ -1677,10 +1678,12 @@ class Function(PyobjMixin, nodes.Item): class FunctionDefinition(Function): - """Internal hack until we get actual definition nodes instead of the - crappy metafunc hack.""" + """ + This class is a step gap solution until we evolve to have actual function definition nodes + and manage to get rid of ``metafunc``. + """ def runtest(self) -> None: - raise RuntimeError("function definitions are not supposed to be used") + raise RuntimeError("function definitions are not supposed to be run as tests") setup = runtest -- cgit v1.2.3