From d2b214220f63e1fc90120495d600893cfba6219f Mon Sep 17 00:00:00 2001 From: Warren Markham Date: Wed, 20 Sep 2023 22:08:07 +1000 Subject: [PATCH] Add class docstring to NodeMeta (#11427) --- src/_pytest/nodes.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/_pytest/nodes.py b/src/_pytest/nodes.py index cb8907fe8..2b2dff246 100644 --- a/src/_pytest/nodes.py +++ b/src/_pytest/nodes.py @@ -127,6 +127,20 @@ _NodeType = TypeVar("_NodeType", bound="Node") class NodeMeta(type): + """Metaclass used by :class:`Node` to enforce that direct construction raises + :class:`Failed`. + + This behaviour supports the indirection introduced with :meth:`Node.from_parent`, + the named constructor to be used instead of direct construction. The design + decision to enforce indirection with :class:`NodeMeta` was made as a + temporary aid for refactoring the collection tree, which was diagnosed to + have :class:`Node` objects whose creational patterns were overly entangled. + Once the refactoring is complete, this metaclass can be removed. + + See https://github.com/pytest-dev/pytest/projects/3 for an overview of the + progress on detangling the :class:`Node` classes. + """ + def __call__(self, *k, **kw): msg = ( "Direct construction of {name} has been deprecated, please use {name}.from_parent.\n"