Refs #32948 -- Renamed Node._new_instance() to Node.create().

Node._new_instance() was added in
6dd2b5468f to work around Q.__init__()
having an incompatible signature with Node.__init__().

It was intended as a hook that could be overridden if subclasses needed
to change the behaviour of instantiation of their specialised form of
Node. In practice this doesn't ever seem to have been used for this
purpose and there are very few calls to Node._new_instance() with other
code, e.g. Node.__deepcopy__() calling Node and overriding __class__ as
required.

Rename this to Node.create() to make it a more "official" piece of
private API that we can use to simplify a lot of other areas internally.

The docstring and nearby comment have been reworded to read more
clearly.
This commit is contained in:
Nick Pope 2021-09-20 23:34:24 +01:00 committed by Mariusz Felisiak
parent cadd864f68
commit ddf0002bb7
3 changed files with 9 additions and 13 deletions

View File

@ -171,7 +171,7 @@ class WhereNode(tree.Node):
self.children[pos] = child.relabeled_clone(change_map)
def clone(self):
clone = self.__class__._new_instance(
clone = self.__class__.create(
children=None,
connector=self.connector,
negated=self.negated,

View File

@ -25,17 +25,13 @@ class Node:
self.connector = connector or self.default
self.negated = negated
# Required because django.db.models.query_utils.Q. Q. __init__() is
# problematic, but it is a natural Node subclass in all other respects.
@classmethod
def _new_instance(cls, children=None, connector=None, negated=False):
def create(cls, children=None, connector=None, negated=False):
"""
Create a new instance of this class when new Nodes (or subclasses) are
needed in the internal code in this class. Normally, it just shadows
__init__(). However, subclasses with an __init__ signature that aren't
an extension of Node.__init__ might need to implement this method to
allow a Node to create a new instance of them (if they have any extra
setting up to do).
Create a new instance using Node() instead of __init__() as some
subclasses, e.g. django.db.models.query_utils.Q, may implement a custom
__init__() with a signature that conflicts with the one defined in
Node.__init__().
"""
obj = Node(children, connector, negated)
obj.__class__ = cls
@ -97,7 +93,7 @@ class Node:
node other got squashed or not.
"""
if self.connector != conn_type:
obj = self._new_instance(self.children, self.connector, self.negated)
obj = self.create(self.children, self.connector, self.negated)
self.connector = conn_type
self.children = [obj, data]
return data

View File

@ -69,11 +69,11 @@ class NodeTests(unittest.TestCase):
self.node1.negate()
self.assertFalse(self.node1.negated)
def test_new_instance(self):
def test_create(self):
SubNode = type("SubNode", (Node,), {})
a = SubNode([SubNode(["a", "b"], OR), "c"], AND)
b = SubNode._new_instance(a.children, a.connector, a.negated)
b = SubNode.create(a.children, a.connector, a.negated)
self.assertEqual(a, b)
# Children lists are the same object, but equal.
self.assertIsNot(a.children, b.children)