Rename QueryType to QuerySetType. Make django_unicorn.components exports explicit.

Author: adamghill

django_unicorn/components/__init__.py

@@ -1,3 +1,4 @@
-from .types import *
-from .unicorn_view import *
-from .updaters import *
+# Explicitly expose what should be available when importing from `django_unicorn.component`
+from .typing import QuerySetType
+from .unicorn_view import UnicornField, UnicornView
+from .updaters import HashUpdate, LocationUpdate, PollUpdate

django_unicorn/components/types.py

@@ -0,0 +1,19 @@
+from typing import Generic, Iterator, TypeVar
+
+from django.db.models import Model, QuerySet
+
+
+M_co = TypeVar("M_co", bound=Model, covariant=True)
+
+
+class QuerySetType(Generic[M_co], QuerySet):
+    """
+    Type for QuerySet that can be used for a typehint in components.
+    """
+
+    # This is based on https://github.com/Vieolo/django-hint/blob/97e22bf/django_hint/typehint.py#L167,
+    # although https://github.com/typeddjango/django-stubs/blob/2a732fd/django-stubs/db/models/manager.pyi#L28
+    # might be a better long-term solution.
+
+    def __iter__(self) -> Iterator[M_co]:
+        ...

django_unicorn/components/typing.py

@@ -4,7 +4,8 @@
 
 from django.db.models import Model, QuerySet
 
-from django_unicorn.components import QueryType, UnicornField, UnicornView
+from django_unicorn.components import UnicornField, UnicornView
+from django_unicorn.components.typing import QuerySetType
 from django_unicorn.decorators import timed
 from django_unicorn.utils import get_type_hints
 
@@ -138,21 +139,21 @@ def _is_queryset(field, type_hint, value):
 
     return (
         isinstance(field, QuerySet)
-        or (type_hint and get_origin(type_hint) is QueryType)
+        or (type_hint and get_origin(type_hint) is QuerySetType)
     ) and isinstance(value, list)
 
 
 def _create_queryset(field, type_hint, value) -> QuerySet:
     """
-    Create a queryset based on the `value`. If needed, the queryset will be created based on the `QueryType`.
+    Create a queryset based on the `value`. If needed, the queryset will be created based on the `QuerySetType`.
 
     For example, all of these ways fields are equivalent:
 
     ```
     class TestComponent(UnicornView):
-        queryset_with_empty_list: QueryType[SomeModel] = []
-        queryset_with_none: QueryType[SomeModel] = None
-        queryset_with_empty_queryset: QueryType[SomeModel] = SomeModel.objects.none()
+        queryset_with_empty_list: QuerySetType[SomeModel] = []
+        queryset_with_none: QuerySetType[SomeModel] = None
+        queryset_with_empty_queryset: QuerySetType[SomeModel] = SomeModel.objects.none()
         queryset_with_no_typehint = SomeModel.objects.none()
     ```
 

django_unicorn/views/utils.py

@@ -1,10 +1,10 @@
-from django_unicorn.components import QueryType, UnicornView
+from django_unicorn.components import QuerySetType, UnicornView
 from example.coffee.models import Flavor
 
 
 class ModelsView(UnicornView):
     flavor: Flavor = Flavor()
-    flavors: QueryType[Flavor] = Flavor.objects.none()
+    flavors: QuerySetType[Flavor] = Flavor.objects.none()
 
     def mount(self):
         self.refresh_flavors()

example/unicorn/components/models.py

@@ -1,4 +1,4 @@
-from django_unicorn.components import convert_to_pascal_case
+from django_unicorn.components.unicorn_view import convert_to_pascal_case
 
 
 def test_convert_to_pascal_case():

tests/components/test_convert_to_pascal_case.py

@@ -1,4 +1,4 @@
-from django_unicorn.components import convert_to_snake_case
+from django_unicorn.components.unicorn_view import convert_to_snake_case
 
 
 def test_convert_to_snake_case():

tests/components/test_convert_to_snake_case.py

@@ -1,6 +1,6 @@
 import pytest
 
-from django_unicorn.components import get_locations
+from django_unicorn.components.unicorn_view import get_locations
 
 
 def test_get_locations_kebab_case():

tests/components/test_get_locations.py

@@ -5,7 +5,7 @@
 
 import pytest
 
-from django_unicorn.components import QueryType, UnicornView
+from django_unicorn.components import QuerySetType, UnicornView
 from django_unicorn.views.utils import set_property_from_data
 from example.coffee.models import Flavor
 
@@ -17,11 +17,11 @@ class FakeComponent(UnicornView):
     array: List[str] = []
     model = Flavor(name="test-initial")
     queryset = Flavor.objects.none()
-    queryset_with_typehint: QueryType[Flavor] = []
+    queryset_with_typehint: QuerySetType[Flavor] = []
 
 
 class FakeQuerySetComponent(UnicornView):
-    queryset_with_typehint: QueryType[Flavor] = None
+    queryset_with_typehint: QuerySetType[Flavor] = None
 
 
 class FakeDbComponent(UnicornView):
@@ -35,9 +35,9 @@ def __init__(self, *args, **kwargs):
 
 
 class FakeAllQuerySetComponent(UnicornView):
-    queryset_with_empty_list: QueryType[Flavor] = []
-    queryset_with_none: QueryType[Flavor] = None
-    queryset_with_empty_queryset: QueryType[Flavor] = Flavor.objects.none()
+    queryset_with_empty_list: QuerySetType[Flavor] = []
+    queryset_with_none: QuerySetType[Flavor] = None
+    queryset_with_empty_queryset: QuerySetType[Flavor] = Flavor.objects.none()
     queryset_with_no_typehint = Flavor.objects.none()