fix: prefetch_related_objects requires Sequence not Iterable (#2970)

* fix: `prefetch_related_objects` requires `Sequence` not `Iterable`

Signed-off-by: Emmanuel Ferdman <[email protected]>

* fix: `prefetch_related_objects` requires `Sequence` not `Iterable`

Signed-off-by: Emmanuel Ferdman <[email protected]>

* fix: `prefetch_related_objects` requires `Sequence` not `Iterable`

Signed-off-by: Emmanuel Ferdman <[email protected]>

* fix: `prefetch_related_objects` requires `Sequence` not `Iterable`

Signed-off-by: Emmanuel Ferdman <[email protected]>

---------

Signed-off-by: Emmanuel Ferdman <[email protected]>

Author: emmanuel-ferdman

django-stubs/db/models/query.pyi

@@ -285,8 +285,8 @@ class Prefetch(Generic[_LookupT, _PrefetchedQuerySetT, _ToAttrT]):
     def get_current_queryset(self, level: int) -> _PrefetchedQuerySetT | None: ...
     def get_current_querysets(self, level: int) -> list[_PrefetchedQuerySetT] | None: ...
 
-def prefetch_related_objects(model_instances: Iterable[_Model], *related_lookups: str | Prefetch) -> None: ...
-async def aprefetch_related_objects(model_instances: Iterable[_Model], *related_lookups: str | Prefetch) -> None: ...
+def prefetch_related_objects(model_instances: Sequence[_Model], *related_lookups: str | Prefetch) -> None: ...
+async def aprefetch_related_objects(model_instances: Sequence[_Model], *related_lookups: str | Prefetch) -> None: ...
 def get_prefetcher(instance: Model, through_attr: str, to_attr: str) -> tuple[Any, Any, bool, bool]: ...
 
 class InstanceCheckMeta(type): ...

tests/assert_type/db/models/test_query.py

@@ -0,0 +1,33 @@
+from collections.abc import Sequence
+
+from django.db.models import Model
+from django.db.models.query import (
+    aprefetch_related_objects,  # pyright: ignore[reportUnknownVariableType]
+    prefetch_related_objects,  # pyright: ignore[reportUnknownVariableType]
+)
+
+models_list: list[Model] = []
+prefetch_related_objects(models_list, "pk")
+
+models_tuple: tuple[Model, ...] = ()
+prefetch_related_objects(models_tuple, "pk")
+
+models_sequence: Sequence[Model] = []
+prefetch_related_objects(models_sequence, "pk")
+
+# failure cases
+models_set: set[Model] = set()
+prefetch_related_objects(models_set, "pk")  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+
+models_frozenset: frozenset[Model] = frozenset()
+prefetch_related_objects(models_frozenset, "pk")  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+
+
+async def test_async() -> None:
+    await aprefetch_related_objects(models_list, "pk")
+    await aprefetch_related_objects(models_tuple, "pk")
+    await aprefetch_related_objects(models_sequence, "pk")
+
+    # failure cases
+    await aprefetch_related_objects(models_set, "pk")  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]
+    await aprefetch_related_objects(models_frozenset, "pk")  # type: ignore[arg-type]  # pyright: ignore[reportArgumentType]  # pyrefly: ignore[bad-argument-type]