feat(query): return lazy QueryResult with .count() from SAClient.query()

- Add generic BaseResult[T] and QueryResult in app/interface/responses.py
- QueryResult is list-like (iter, len, getitem) and lazy-loads data
- .count() fetches count without triggering full data fetch
- Update SAClient.query() docstring with usage example
- Update tests to compare count() with paginated len()

Author: VaghinakDev

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
         name: Style Guide Enforcement (flake8)
         args:
           - '--max-line-length=120'
-          - --ignore=D100,D203,D405,W503,E203,E501,F841,E126,E712,E123,E131,F821,E121,W605,E402
+          - --ignore=D100,D203,D405,W503,E203,E501,F841,E126,E712,E123,E131,F821,E121,W605,E402,E704
   - repo: 'https://github.com/asottile/pyupgrade'
     rev: v3.21.2
     hooks:

src/superannotate/lib/app/interface/responses.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
-from typing import Callable
+from collections.abc import Callable
+from collections.abc import Iterator
 from typing import Generic
-from typing import Iterator
-from typing import TypeVar
 from typing import overload
+from typing import TypeVar
 
 T = TypeVar("T")
 

tests/integration/items/test_saqul_query.py

@@ -59,86 +59,32 @@ def test_query_on_100(self):
         sa.attach_items(self.PROJECT_NAME, os.path.join(DATA_SET_PATH, "100_urls.csv"))
         entities = sa.query(self.PROJECT_NAME, "metadata(status = NotStarted)")
         assert len(entities) == 100
-        assert (
-            sa.controller.query_items_count(
-                self.PROJECT_NAME, "metadata(status = NotStarted)"
-            )
-            == 100
-        )
+        assert entities.count() == len(entities)
 
     def test_query_result_list_like_behavior(self):
-        """Test that QueryResult behaves like a list for backward compatibility."""
         sa.attach_items(self.PROJECT_NAME, os.path.join(DATA_SET_PATH, "100_urls.csv"))
         result = sa.query(self.PROJECT_NAME, "metadata(status = NotStarted)")
 
-        # Test len()
         self.assertEqual(len(result), 100)
+        self.assertIsInstance(result[0], dict)
+        self.assertIn("name", result[0])
+        self.assertIsInstance(result[-1], dict)
+        self.assertEqual(len(result[0:5]), 5)
 
-        # Test indexing
-        first_item = result[0]
-        self.assertIsInstance(first_item, dict)
-        self.assertIn("name", first_item)
-
-        # Test negative indexing
-        last_item = result[-1]
-        self.assertIsInstance(last_item, dict)
-
-        # Test slicing
-        sliced = result[0:5]
-        self.assertEqual(len(sliced), 5)
-
-        # Test iteration
-        count = 0
-        for item in result:
-            self.assertIsInstance(item, dict)
-            count += 1
-        self.assertEqual(count, 100)
-
-        # Test list conversion
-        as_list = list(result)
-        self.assertEqual(len(as_list), 100)
-        self.assertIsInstance(as_list, list)
-
-    def test_query_result_count_method(self):
-        """Test that QueryResult.count() returns the count from server."""
-        sa.attach_items(self.PROJECT_NAME, os.path.join(DATA_SET_PATH, "100_urls.csv"))
-        result = sa.query(self.PROJECT_NAME, "metadata(status = NotStarted)")
-
-        # Test .count() method
-        count = result.count()
-        self.assertEqual(count, 100)
-        self.assertIsInstance(count, int)
-
-        # Verify count matches len
-        self.assertEqual(count, len(result))
+        items = [item for item in result]
+        self.assertEqual(len(items), 100)
+        self.assertIsInstance(list(result), list)
 
-    def test_query_result_lazy_loading(self):
-        """Test that QueryResult.count() does not trigger data fetching."""
+    def test_query_result_lazy_count(self):
         sa.attach_items(self.PROJECT_NAME, os.path.join(DATA_SET_PATH, "100_urls.csv"))
         result = sa.query(self.PROJECT_NAME, "metadata(status = NotStarted)")
 
-        # Data should not be loaded yet
         self.assertIsNone(result._data)
-
-        # Calling count() should not load data
-        count = result.count()
-        self.assertEqual(count, 100)
+        self.assertEqual(result.count(), 100)
         self.assertIsNone(result._data)
 
-        # Accessing data should trigger loading
-        first_item = result[0]
+        _ = result[0]
         self.assertIsNotNone(result._data)
-        self.assertIsInstance(first_item, dict)
-
-    def test_query_result_repr(self):
-        """Test that QueryResult repr shows the underlying list."""
-        sa.attach_items(self.PROJECT_NAME, os.path.join(DATA_SET_PATH, "100_urls.csv"))
-        result = sa.query(self.PROJECT_NAME, "metadata(status = NotStarted)")
-
-        # Test __repr__
-        repr_str = repr(result)
-        self.assertIsInstance(repr_str, str)
-        self.assertTrue(repr_str.startswith("["))
 
     def test_validate_saqul_query(self):
         try: