Add FunctionDefinition to the reference docs

Fix #7968
This commit is contained in:
Bruno Oliveira 2020-10-31 08:45:34 -03:00
parent a7e38c5c61
commit 569c091769
2 changed files with 13 additions and 3 deletions

View File

@ -840,6 +840,13 @@ Function
:members: :members:
:show-inheritance: :show-inheritance:
FunctionDefinition
~~~~~~~~~~~~~~~~~~
.. autoclass:: _pytest.python.FunctionDefinition()
:members:
:show-inheritance:
Item Item
~~~~ ~~~~

View File

@ -960,6 +960,7 @@ class Metafunc:
cls=None, cls=None,
module=None, module=None,
) -> None: ) -> None:
#: Access to the underlying :class:`_pytest.python.FunctionDefinition`.
self.definition = definition self.definition = definition
#: Access to the :class:`_pytest.config.Config` object for the test session. #: Access to the :class:`_pytest.config.Config` object for the test session.
@ -1677,10 +1678,12 @@ class Function(PyobjMixin, nodes.Item):
class FunctionDefinition(Function): 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: 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 setup = runtest