Address PR review: Collection typing for filter_in/not_in, Record return types for execute()

- Changed filter_in/not_in parameter type from Sequence[Any] to Collection[Any]
  to accept sets, frozensets, and other non-ordered collections (Copilot review)
- Updated execute() return type from Dict[str, Any] to Record to match actual
  runtime behavior (records.get() returns Record objects) (Copilot review)
- Updated execute() docstring to reference Record objects instead of dicts
- Added tests for filter_in with set and tuple inputs

Author: Saurabh Badenkal

src/PowerPlatform/Dataverse/models/filters.py

@@ -36,7 +36,7 @@
 import enum
 import uuid
 from datetime import date, datetime, timezone
-from typing import Any, Sequence
+from typing import Any, Collection, Sequence
 
 __all__ = [
     "FilterExpression",
@@ -220,7 +220,7 @@ class _InFilter(FilterExpression):
 
     __slots__ = ("column", "values")
 
-    def __init__(self, column: str, values: Sequence[Any]) -> None:
+    def __init__(self, column: str, values: Collection[Any]) -> None:
         if not values:
             raise ValueError("filter_in requires at least one value")
         self.column = column.lower()
@@ -241,7 +241,7 @@ class _NotInFilter(FilterExpression):
 
     __slots__ = ("column", "values")
 
-    def __init__(self, column: str, values: Sequence[Any]) -> None:
+    def __init__(self, column: str, values: Collection[Any]) -> None:
         if not values:
             raise ValueError("not_in requires at least one value")
         self.column = column.lower()
@@ -404,7 +404,7 @@ def is_not_null(column: str) -> FilterExpression:
     return _ComparisonFilter(column, "ne", None)
 
 
-def filter_in(column: str, values: Sequence[Any]) -> FilterExpression:
+def filter_in(column: str, values: Collection[Any]) -> FilterExpression:
     """In filter using ``Microsoft.Dynamics.CRM.In``.
 
     Named ``filter_in`` because ``in`` is a Python keyword.
@@ -422,7 +422,7 @@ def filter_in(column: str, values: Sequence[Any]) -> FilterExpression:
     return _InFilter(column, values)
 
 
-def not_in(column: str, values: Sequence[Any]) -> FilterExpression:
+def not_in(column: str, values: Collection[Any]) -> FilterExpression:
     """Not-in filter using ``Microsoft.Dynamics.CRM.NotIn``.
 
     Named ``not_in`` to parallel :func:`filter_in`.

src/PowerPlatform/Dataverse/models/query_builder.py

@@ -46,11 +46,12 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, Iterable, List, Optional, Sequence, Union
+from typing import Any, Collection, Dict, Iterable, List, Optional, Sequence, Union
 
 import pandas as pd
 
 from . import filters
+from .record import Record
 
 __all__ = ["QueryBuilder"]
 
@@ -225,7 +226,7 @@ def filter_not_null(self, column: str) -> QueryBuilder:
 
     # --------------------------------------------------------- filter: special
 
-    def filter_in(self, column: str, values: Sequence[Any]) -> QueryBuilder:
+    def filter_in(self, column: str, values: Collection[Any]) -> QueryBuilder:
         """Add an ``in`` filter using ``Microsoft.Dynamics.CRM.In``.
 
         :param column: Column name (will be lowercased).
@@ -243,7 +244,7 @@ def filter_in(self, column: str, values: Sequence[Any]) -> QueryBuilder:
         return self
 
     def filter_not_in(
-        self, column: str, values: Sequence[Any]
+        self, column: str, values: Collection[Any]
     ) -> QueryBuilder:
         """Add a ``not in`` filter using ``Microsoft.Dynamics.CRM.NotIn``.
 
@@ -436,7 +437,7 @@ def build(self) -> dict:
 
     # --------------------------------------------------------------- execute
 
-    def execute(self, *, by_page: bool = False) -> Union[Iterable[Dict[str, Any]], Iterable[List[Dict[str, Any]]]]:
+    def execute(self, *, by_page: bool = False) -> Union[Iterable[Record], Iterable[List[Record]]]:
         """Execute the query and return results.
 
         By default, returns a flat iterator over individual records,
@@ -448,12 +449,14 @@ def execute(self, *, by_page: bool = False) -> Union[Iterable[Dict[str, Any]], I
         instances should use :meth:`build` to get parameters and pass them
         to ``client.records.get()`` manually.
 
-        :param by_page: If ``True``, yield pages (lists of record dicts)
+        :param by_page: If ``True``, yield pages (lists of
+            :class:`~PowerPlatform.Dataverse.models.record.Record` objects)
             instead of individual records. Defaults to ``False``.
         :type by_page: bool
-        :return: Generator yielding individual record dicts (default) or
-            pages of record dicts (when ``by_page=True``).
-        :rtype: Iterable[Dict[str, Any]] or Iterable[List[Dict[str, Any]]]
+        :return: Generator yielding individual
+            :class:`~PowerPlatform.Dataverse.models.record.Record` objects
+            (default) or pages of records (when ``by_page=True``).
+        :rtype: Iterable[Record] or Iterable[List[Record]]
         :raises RuntimeError: If the query was not created via
             ``client.query.builder()``.
 
@@ -494,7 +497,7 @@ def execute(self, *, by_page: bool = False) -> Union[Iterable[Dict[str, Any]], I
         if by_page:
             return pages
 
-        def _flat() -> Iterable[Dict[str, Any]]:
+        def _flat() -> Iterable[Record]:
             for page in pages:
                 yield from page
 

tests/unit/models/test_query_builder.py

@@ -125,6 +125,19 @@ def test_filter_in_returns_self(self):
         qb = QueryBuilder("account")
         self.assertIs(qb.filter_in("statecode", [0, 1]), qb)
 
+    def test_filter_in_accepts_set(self):
+        qb = QueryBuilder("account").filter_in("statecode", {0, 1})
+        result = qb.build()["filter"]
+        self.assertIn("Microsoft.Dynamics.CRM.In", result)
+        self.assertIn("statecode", result)
+
+    def test_filter_in_accepts_tuple(self):
+        qb = QueryBuilder("account").filter_in("statecode", (0, 1, 2))
+        self.assertEqual(
+            qb.build()["filter"],
+            'Microsoft.Dynamics.CRM.In(PropertyName=\'statecode\',PropertyValues=["0","1","2"])',
+        )
+
     def test_filter_in_int_enum(self):
         from enum import IntEnum