Remove the with_descendants argument from DataSliceManagerView.get().

Its functionality is now covered by the `populate_including_descendants` parameter: the old call `view.get(with_descendants=True)` can now be expressed as `view.get(populate_including_descendants=[view])`.

PiperOrigin-RevId: 862125204
Change-Id: I8c92a3e6a0a15839d82cd6ab9da30dcb39544f61

Author: svsgoogle

py/koladata/ext/persisted_data/colab/Persisted_incremental_DataSlice_basics.ipynb

@@ -610,7 +610,9 @@
         }
       ],
       "source": [
-        "root.query[:].doc[:].get_data_slice(with_descendants=True)"
+        "root.query[:].doc[:].get_data_slice(\n",
+        "    populate_including_descendants=[root.query[:].doc[:]]\n",
+        ")"
       ]
     },
     {
@@ -1344,7 +1346,7 @@
         }
       ],
       "source": [
-        "branch_root.get_data_slice(with_descendants=True)"
+        "branch_root.get_data_slice(populate_including_descendants=[branch_root])"
       ]
     },
     {
@@ -1674,7 +1676,7 @@
         }
       ],
       "source": [
-        "root.query.get_data_slice(with_descendants=True)[0]"
+        "root.query.get_data_slice(populate_including_descendants=[root.query])[0]"
       ]
     },
     {

py/koladata/ext/persisted_data/data_slice_manager_view.py

@@ -98,7 +98,6 @@ def get_schema(self) -> kd.types.SchemaItem:
   def get_data_slice(
       self,
       *,
-      with_descendants: bool = False,
       populate: Collection[DataSliceManagerView] | None = None,
       populate_including_descendants: (
           Collection[DataSliceManagerView] | None
@@ -109,8 +108,6 @@ def get_data_slice(
     The view path must be valid, i.e. self.is_view_valid() must be True.
 
     Args:
-      with_descendants: If True, then the DataSlice will include the data of all
-        the descendants of the view path.
       populate: Additional views whose DataSlicePaths will be populated. Their
         paths must be descendants of this view's path for you to see their data
         in the returned DataSlice.
@@ -119,13 +116,10 @@ def get_data_slice(
     """
     self._check_path_from_root_is_valid()
     populate = {v.get_path_from_root() for v in populate or []}
+    populate.add(self._path_from_root)
     populate_including_descendants = {
         v.get_path_from_root() for v in populate_including_descendants or []
     }
-    if with_descendants:
-      populate_including_descendants.add(self._path_from_root)
-    else:
-      populate.add(self._path_from_root)
     ds = self._data_slice_manager.get_data_slice(
         populate=populate,
         populate_including_descendants=populate_including_descendants,
@@ -135,7 +129,6 @@ def get_data_slice(
   def get(
       self,
       *,
-      with_descendants: bool = False,
       populate: Collection[DataSliceManagerView] | None = None,
       populate_including_descendants: (
           Collection[DataSliceManagerView] | None
@@ -146,16 +139,13 @@ def get(
     The view path must be valid, i.e. self.is_view_valid() must be True.
 
     Args:
-      with_descendants: If True, then the DataSlice will include the data of all
-        the descendants of the view path.
       populate: Additional views whose DataSlicePaths will be populated. Their
         paths must be descendants of this view's path for you to see their data
         in the returned DataSlice.
       populate_including_descendants: Additional views whose DataSlicePaths and
         all their descendants will be populated.
     """
     return self.get_data_slice(
-        with_descendants=with_descendants,
         populate=populate,
         populate_including_descendants=populate_including_descendants,
     )

py/koladata/ext/persisted_data/data_slice_manager_view_test.py

@@ -61,7 +61,7 @@ def test_typical_usage(self):
         kd.slice(['How tall is Obama', 'How high is the Eiffel tower']),
     )
     kd.testing.assert_equivalent(
-        queries.get(with_descendants=True),
+        queries.get(populate_including_descendants=[queries]),
         kd.slice([
             expected_query_schema.new(query_id=0, text='How tall is Obama'),
             expected_query_schema.new(
@@ -772,7 +772,7 @@ def branch_and_filter(
     root = DataSliceManagerView(manager)
     filtered_root = DataSliceManagerView(filtered_manager)
     kd.testing.assert_equivalent(
-        root.get_data_slice(with_descendants=True),
+        root.get_data_slice(populate_including_descendants=[root]),
         kd.new(
             query=kd.list([
                 kd.named_schema('query').new(
@@ -802,7 +802,9 @@ def branch_and_filter(
     )
     # The filtering recipe above results in one query with one doc:
     kd.testing.assert_equivalent(
-        filtered_root.get_data_slice(with_descendants=True),
+        filtered_root.get_data_slice(
+            populate_including_descendants=[filtered_root]
+        ),
         kd.new(
             query=kd.list([
                 kd.named_schema('query').new(
@@ -953,7 +955,7 @@ def _test_filter_docs_from_view(
           ),
       )
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1010,8 +1012,10 @@ def _test_filter_docs_from_view(
             description='Filtered docs by selecting all of them',
         )
         kd.testing.assert_equivalent(
-            root.get_data_slice(with_descendants=True),
-            trunk_root.get_data_slice(with_descendants=True),
+            root.get_data_slice(populate_including_descendants=[root]),
+            trunk_root.get_data_slice(
+                populate_including_descendants=[trunk_root]
+            ),
             ids_equality=True,
         )
         branch_manager_revision_descriptions = [
@@ -1038,7 +1042,7 @@ def _test_filter_docs_from_view(
           description='Filtered all docs',
       )
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_root.get_data_slice()
           .with_attr('query', None)
           .with_schema(trunk_root.get_schema()),
@@ -1079,7 +1083,7 @@ def _test_filter_docs_from_view(
           ),
       )
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1114,8 +1118,16 @@ def _test_filter_docs_from_view(
           trunk_root.query[:].get_data_slice().S[1].get_itemid(),
       )
       kd.testing.assert_equivalent(
-          root.query[:].doc[:].get_data_slice(with_descendants=True).L[0],
-          trunk_root.query[:].doc[:].get_data_slice(with_descendants=True).L[1],
+          root.query[:]
+          .doc[:]
+          .get_data_slice(populate_including_descendants=[root.query[:].doc[:]])
+          .L[0],
+          trunk_root.query[:]
+          .doc[:]
+          .get_data_slice(
+              populate_including_descendants=[trunk_root.query[:].doc[:]]
+          )
+          .L[1],
           ids_equality=True,
       )
       branch_manager_revision_descriptions = [
@@ -1144,7 +1156,7 @@ def _test_filter_docs_from_view(
           description='Filtered token keys to keep only those that are "hands"',
       )
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1182,7 +1194,7 @@ def _test_filter_docs_from_view(
       )
 
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1234,7 +1246,7 @@ def _test_filter_docs_from_view(
       )
 
       kd.testing.assert_equivalent(
-          root.get_data_slice(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1322,7 +1334,7 @@ def _test_filter_docs_from_view(
           description='Filtered docs to keep only those with tokens',
       )
       kd.testing.assert_equivalent(
-          root.get(with_descendants=True),
+          root.get_data_slice(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1370,7 +1382,7 @@ def _test_filter_docs_from_view(
           ),
       )
       kd.testing.assert_equivalent(
-          root.get(with_descendants=True),
+          root.get(populate_including_descendants=[root]),
           trunk_initial_data_manager.get_schema().new(
               query=kd.list([
                   query_schema.new(
@@ -1435,7 +1447,8 @@ def test_error_messages_when_sugar_does_not_apply_to_attribute_name(self):
 
     # IPython auto-complete should not suggest the reserved attribute names.
     self.assertEqual(
-        kd.dir(root.get_data_slice(with_descendants=True)), ['fingerprint']
+        kd.dir(root.get_data_slice(populate_including_descendants=[root])),
+        ['fingerprint'],
     )
     self.assertNotIn('fingerprint', root.__all__)
     self.assertEqual(
@@ -1842,19 +1855,9 @@ def test_get_with_populate_arguments(self):
         schemas_equality=False,
     )
 
-    kd.testing.assert_equivalent(
-        doc_view.get(populate_including_descendants=[doc_view]),
-        doc_view.get(with_descendants=True),
-        ids_equality=True,
-    )
-    kd.testing.assert_equivalent(
-        query_view.get(populate_including_descendants=[query_view]),
-        query_view.get(with_descendants=True),
-        ids_equality=True,
-    )
     kd.testing.assert_equivalent(
         doc_view.get(populate_including_descendants=[query_view]),
-        doc_view.get(with_descendants=True),
+        doc_view.get(populate_including_descendants=[doc_view]),
         ids_equality=True,
     )
     kd.testing.assert_equivalent(
@@ -1866,18 +1869,7 @@ def test_get_with_populate_arguments(self):
         root_view.get(
             populate=[doc_view], populate_including_descendants=[query_view]
         ),
-        root_view.get(with_descendants=True),
-        ids_equality=True,
-    )
-    kd.testing.assert_equivalent(
-        root_view.get(
-            populate=[query_view.text, query_view.query_id],
-            populate_including_descendants=[doc_view],
-        ),
-        root_view.get(
-            populate=[query_view.text, query_view.query_id],
-            populate_including_descendants=[doc_view],
-        ),
+        root_view.get(populate_including_descendants=[root_view]),
         ids_equality=True,
     )