summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBruno Oliveira <nicoddemus@gmail.com>2020-10-31 08:45:34 -0300
committerBruno Oliveira <nicoddemus@gmail.com>2020-10-31 08:45:34 -0300
commit569c091769d6739d262ee796e71f5f70dc81bf19 (patch)
tree96a575275a9c7d4d6bb58ca3ddee5dd1f54dee0b /src
parenta7e38c5c61928033a2dc1915cbee8caa8544a4d0 (diff)
downloadpytest-569c091769d6739d262ee796e71f5f70dc81bf19.tar.gz
Add FunctionDefinition to the reference docs
Fix #7968
Diffstat (limited to 'src')
-rw-r--r--src/_pytest/python.py9
1 files changed, 6 insertions, 3 deletions
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