Move mutation and query to types.py

Author: Archmonger

src/django_idom/hooks.py

@@ -1,42 +1,26 @@
 from __future__ import annotations
 
 import asyncio
-from dataclasses import dataclass
-from typing import (
-    Any,
-    Awaitable,
-    Callable,
-    DefaultDict,
-    Generic,
-    Sequence,
-    TypeVar,
-    Union,
-    cast,
-)
+from typing import Any, Awaitable, Callable, DefaultDict, Sequence, Union, cast
 
 from channels.db import database_sync_to_async as _database_sync_to_async
 from django.db.models.base import Model
 from django.db.models.query import QuerySet
 from idom import use_callback, use_ref
 from idom.backend.types import Location
 from idom.core.hooks import Context, create_context, use_context, use_effect, use_state
-from typing_extensions import ParamSpec
 
-from django_idom.types import IdomWebsocket
+from django_idom.types import IdomWebsocket, Mutation, Query, _Params, _Result
 
 
 database_sync_to_async = cast(
     Callable[..., Callable[..., Awaitable[Any]]],
     _database_sync_to_async,
 )
-
+WebsocketContext: Context[IdomWebsocket | None] = create_context(None)
 _REFETCH_CALLBACKS: DefaultDict[
     Callable[..., Any], set[Callable[[], None]]
 ] = DefaultDict(set)
-WebsocketContext: Context[IdomWebsocket | None] = create_context(None)
-_Result = TypeVar("_Result", bound=Union[Model, QuerySet[Any]])
-_Params = ParamSpec("_Params")
-_Data = TypeVar("_Data")
 
 
 def use_location() -> Location:
@@ -147,22 +131,6 @@ def reset() -> None:
     return Mutation(call, loading, error, reset)
 
 
-@dataclass
-class Query(Generic[_Data]):
-    data: _Data
-    loading: bool
-    error: Exception | None
-    refetch: Callable[[], None]
-
-
-@dataclass
-class Mutation(Generic[_Params]):
-    execute: Callable[_Params, None]
-    loading: bool
-    error: Exception | None
-    reset: Callable[[], None]
-
-
 def _fetch_deferred(data: Any) -> None:
     # https://github.com/typeddjango/django-stubs/issues/704
     if isinstance(data, QuerySet):  # type: ignore[misc]

src/django_idom/types.py

@@ -1,10 +1,43 @@
 from dataclasses import dataclass
-from typing import Awaitable, Callable, Optional
+from typing import Any, Awaitable, Callable, Generic, Optional, TypeVar, Union
+
+from django.db.models.base import Model
+from django.db.models.query import QuerySet
+from typing_extensions import ParamSpec
+
+
+__all__ = ["_Result", "_Params", "_Data", "IdomWebsocket", "Query", "Mutation"]
+
+_Result = TypeVar("_Result", bound=Union[Model, QuerySet[Any]])
+_Params = ParamSpec("_Params")
+_Data = TypeVar("_Data")
 
 
 @dataclass
 class IdomWebsocket:
+    """Websocket returned by the `use_websocket` hook."""
+
     scope: dict
     close: Callable[[Optional[int]], Awaitable[None]]
     disconnect: Callable[[int], Awaitable[None]]
     view_id: str
+
+
+@dataclass
+class Query(Generic[_Data]):
+    """Queries generated by the `use_query` hook."""
+
+    data: _Data
+    loading: bool
+    error: Exception | None
+    refetch: Callable[[], None]
+
+
+@dataclass
+class Mutation(Generic[_Params]):
+    """Mutations generated by the `use_mutation` hook."""
+
+    execute: Callable[_Params, None]
+    loading: bool
+    error: Exception | None
+    reset: Callable[[], None]