Change ancestor_of/descendant_of to `with_descendants/with_ancestor…

…s` (#2278) * Deprecate `ancestor_of` and `descendant_of` * Replace all occurrences of `ancestor_of` with `with_descendants` * Replace all occurrences of `descendant_of` with `with_ancestors` * Remove `_beta` version of recursive `ancestor_of` and `descendant_of` joins * Update docs with this convention
aiidateam · Dec 4, 2018 · af61105 · af61105
1 parent 1adafc4
commit af61105
Show file tree

Hide file tree

Showing 9 changed files with 77 additions and 75 deletions.
diff --git a/aiida/backends/djsite/db/subtests/nodes.py b/aiida/backends/djsite/db/subtests/nodes.py
@@ -145,7 +145,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 0
             )
 
@@ -155,7 +155,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 2
             )
 
@@ -165,7 +165,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 2
             )
 
@@ -175,7 +175,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 4
             )
 
@@ -187,7 +187,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 2
             )
 
@@ -196,7 +196,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 1
             )
         #~ self.assertEquals(
@@ -207,7 +207,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 0
             )
         #~ self.assertEquals(
@@ -218,13 +218,13 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n4.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 1
             )
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n5.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n7.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n7.pk}
                 ).count(), 1
             )
         #~ self.assertEquals(
@@ -239,7 +239,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                     Node, filters={'id':n1.pk}, tag='anc'
-                ).append(Node, descendant_of='anc',  filters={'id':n8.pk}
+                ).append(Node, with_ancestors='anc',  filters={'id':n8.pk}
                 ).count(), 1
             )
         #~ self.assertEquals(

diff --git a/aiida/backends/general/abstractqueries.py b/aiida/backends/general/abstractqueries.py
@@ -171,7 +171,7 @@ def get_bands_and_parents_structure(self, args):
             qb.append(orm.Group, tag="group", filters=group_filters,
                       group_of="bdata")
 
-        qb.append(StructureData, tag="sdata", ancestor_of="bdata",
+        qb.append(StructureData, tag="sdata", with_descendants="bdata",
                   # We don't care about the creator of StructureData
                   project=["id", "attributes.kinds", "attributes.sites"])
 
@@ -245,5 +245,5 @@ def get_all_parents(self, node_pks, return_values=('id',)):
         qb = QueryBuilder()
         qb.append(Node, tag='low_node',
                   filters={'id': {'in': node_pks}})
-        qb.append(Node, ancestor_of='low_node', project=return_values)
+        qb.append(Node, with_descendants='low_node', project=return_values)
         return qb.all()
diff --git a/aiida/backends/sqlalchemy/tests/nodes.py b/aiida/backends/sqlalchemy/tests/nodes.py
@@ -56,7 +56,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 0
         )
 
@@ -66,7 +66,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 2
         )
 
@@ -81,7 +81,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 2
         )
         # ~ self.assertEquals(
@@ -94,7 +94,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 4
         )
 
@@ -111,7 +111,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 2
         )
 
@@ -127,7 +127,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 1
         )
 
@@ -143,7 +143,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 0
         )
 
@@ -158,7 +158,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n4.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 1
         )
         # ~ self.assertEquals(
@@ -169,7 +169,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n5.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n7.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n7.pk}
                      ).count(), 1
         )
         # ~ self.assertEquals(
@@ -184,7 +184,7 @@ def test_creation_and_deletion(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 1
         )
         # ~ self.assertEquals(

diff --git a/aiida/backends/tests/query.py b/aiida/backends/tests/query.py
@@ -878,50 +878,50 @@ def test_query_path(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 0)
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}
                      ).count(), 0)
 
         n6.add_incoming(n5, link_type=LinkType.INPUT_CALC, link_label='link1')
         # Yet, now 2 links from 1 to 8
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 2
         )
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}
                      ).count(), 2)
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}, edge_filters={'depth': {'<': 6}},
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}, edge_filters={'depth': {'<': 6}},
                      ).count(), 2)
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}, edge_filters={'depth': 5},
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}, edge_filters={'depth': 5},
                      ).count(), 2)
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}, edge_filters={'depth': {'<': 5}},
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}, edge_filters={'depth': {'<': 5}},
                      ).count(), 0)
 
         # TODO write a query that can filter certain paths by traversed ID
         qb = QueryBuilder().append(
             Node, filters={'id': n8.pk}, tag='desc',
-        ).append(Node, ancestor_of='desc', edge_project='path', filters={'id': n1.pk})
+        ).append(Node, with_descendants='desc', edge_project='path', filters={'id': n1.pk})
         queried_path_set = set([frozenset(p) for p, in qb.all()])
 
         paths_there_should_be = set([
@@ -934,7 +934,7 @@ def test_query_path(self):
         qb = QueryBuilder().append(
             Node, filters={'id': n1.pk}, tag='anc'
         ).append(
-            Node, descendant_of='anc', filters={'id': n8.pk}, edge_project='path'
+            Node, with_ancestors='anc', filters={'id': n8.pk}, edge_project='path'
         )
 
         self.assertTrue(set(
@@ -950,34 +950,34 @@ def test_query_path(self):
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 2
         )
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}
                      ).count(), 2)
         n9.add_incoming(n6, link_type=LinkType.INPUT_CALC, link_label='link6')
         # And now there should be 4 nodes
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n1.pk}, tag='anc'
-            ).append(Node, descendant_of='anc', filters={'id': n8.pk}
+            ).append(Node, with_ancestors='anc', filters={'id': n8.pk}
                      ).count(), 4)
 
         self.assertEquals(
             QueryBuilder().append(
                 Node, filters={'id': n8.pk}, tag='desc'
-            ).append(Node, ancestor_of='desc', filters={'id': n1.pk}
+            ).append(Node, with_descendants='desc', filters={'id': n1.pk}
                      ).count(), 4)
 
         qb = QueryBuilder().append(
             Node, filters={'id': n1.pk}, tag='anc'
         ).append(
-            Node, descendant_of='anc', filters={'id': n8.pk}, edge_tag='edge'
+            Node, with_ancestors='anc', filters={'id': n8.pk}, edge_tag='edge'
         )
         qb.add_projection('edge', 'depth')
         self.assertTrue(set(next(zip(*qb.all()))), set([5, 6]))

diff --git a/aiida/orm/implementation/django/node.py b/aiida/orm/implementation/django/node.py
@@ -240,7 +240,7 @@ def _add_dblink_from(self, src, link_type, label):
             # in the TC table from self to src
             if QueryBuilder().append(
                     Node, filters={'id': self.pk}, tag='parent').append(
-                Node, filters={'id': src.pk}, tag='child', descendant_of='parent').count() > 0:
+                Node, filters={'id': src.pk}, tag='child', with_ancestors='parent').count() > 0:
                 raise ValueError(
                     "The link you are attempting to create would generate a loop")
 

diff --git a/aiida/orm/implementation/general/node.py b/aiida/orm/implementation/general/node.py
@@ -2038,7 +2038,7 @@ def has_children(self):
         from aiida.orm import Node
         first_desc = QueryBuilder().append(
             Node, filters={'id': self.pk}, tag='self').append(
-            Node, descendant_of='self', project='id').first()
+            Node, with_ancestors='self', project='id').first()
         return bool(first_desc)
 
     @property
@@ -2051,7 +2051,7 @@ def has_parents(self):
         from aiida.orm import Node
         first_ancestor = QueryBuilder().append(
             Node, filters={'id': self.pk}, tag='self').append(
-            Node, ancestor_of='self', project='id').first()
+            Node, with_descendants='self', project='id').first()
         return bool(first_ancestor)
 
     # pylint: disable=no-self-argument

diff --git a/aiida/orm/implementation/sqlalchemy/node.py b/aiida/orm/implementation/sqlalchemy/node.py
@@ -287,7 +287,7 @@ def _add_dblink_from(self, src, link_type, label):
                     }, tag='parent').append(
                 Node, filters={
                     'id': src.pk
-                }, tag='child', descendant_of='parent').count() > 0:
+                }, tag='child', with_ancestors='parent').count() > 0:
                 raise ValueError("The link you are attempting to create would generate a loop")
 
         self._do_create_link(src, label, link_type)