use_query options via type hints

Author: Archmonger

docs/src/features/components.md

@@ -39,7 +39,7 @@ Convert any Django view into a IDOM component by using this decorator. Compatibl
 
     | Type | Description |
     | --- | --- |
-    | `_ViewComponentConstructor` | A function that takes `request: HttpRequest | None, *args: Any, key: Key | None, **kwargs: Any` and returns an IDOM component. |
+    | `_ViewComponentConstructor` | A function that takes `request, *args, key, **kwargs` and returns an IDOM component. All parameters are directly provided to your view, besides `key` which is used by IDOM. |
 
 ??? Warning "Potential information exposure when using `compatibility = True`"
 

src/django_idom/hooks.py

@@ -3,7 +3,16 @@
 import asyncio
 import contextlib
 import logging
-from typing import Any, Awaitable, Callable, DefaultDict, Sequence, Union, cast
+from typing import (
+    Any,
+    Awaitable,
+    Callable,
+    DefaultDict,
+    Sequence,
+    Union,
+    cast,
+    overload,
+)
 
 from channels.db import database_sync_to_async as _database_sync_to_async
 from django.db.models import ManyToManyField, prefetch_related_objects
@@ -74,10 +83,30 @@ def use_websocket() -> IdomWebsocket:
     return websocket
 
 
+@overload
+def use_query(
+    query: Callable[_Params, _Result | None],
+    options: QueryOptions,
+    /,
+    *args: _Params.args,
+    **kwargs: _Params.kwargs,
+) -> Query[_Result | None]:
+    ...
+
+
+@overload
 def use_query(
     query: Callable[_Params, _Result | None],
+    /,
     *args: _Params.args,
     **kwargs: _Params.kwargs,
+) -> Query[_Result | None]:
+    ...
+
+
+def use_query(
+    *args: Any,
+    **kwargs: Any,
 ) -> Query[_Result | None]:
     """Hook to fetch a Django ORM query.
 
@@ -87,6 +116,14 @@ def use_query(
 
     Keyword Args:
         **kwargs: Keyword arguments to pass into `query`."""
+    query = args[0]
+    if len(args) > 1 and isinstance(args[1], QueryOptions):
+        query_options = args[1]
+        args = args[2:]
+    else:
+        query_options = QueryOptions()
+        args = args[1:]
+
     query_ref = use_ref(query)
     if query_ref.current is not query:
         raise ValueError(f"Query function changed from {query_ref.current} to {query}.")
@@ -95,9 +132,6 @@ def use_query(
     data, set_data = use_state(cast(Union[_Result, None], None))
     loading, set_loading = use_state(True)
     error, set_error = use_state(cast(Union[Exception, None], None))
-    query_options = (
-        query if isinstance(query, QueryOptions) else QueryOptions(func=query)
-    )
 
     @use_callback
     def refetch() -> None:
@@ -109,8 +143,8 @@ def refetch() -> None:
     def add_refetch_callback() -> Callable[[], None]:
         # By tracking callbacks globally, any usage of the query function will be re-run
         # if the user has told a mutation to refetch it.
-        _REFETCH_CALLBACKS[query_options.func].add(refetch)
-        return lambda: _REFETCH_CALLBACKS[query_options.func].remove(refetch)
+        _REFETCH_CALLBACKS[query].add(refetch)
+        return lambda: _REFETCH_CALLBACKS[query].remove(refetch)
 
     @use_effect(dependencies=None)
     @database_sync_to_async
@@ -120,7 +154,7 @@ def execute_query() -> None:
 
         try:
             # Run the initial query
-            data = query_options.func(*args, **kwargs)
+            data = query(*args, **kwargs)
 
             # Use a custom postprocessor, if provided
             if query_options.postprocessor:

src/django_idom/types.py

@@ -57,12 +57,6 @@ class ViewComponentIframe:
 class QueryOptions:
     """A Django ORM query function, alongside some configuration values."""
 
-    def __call__(self, *args, **kwargs):
-        return self.func(*args, **kwargs)
-
-    func: Callable
-    """Callable that fetches ORM object(s)."""
-
     postprocessor_options: dict[str, Any] = field(
         default_factory=lambda: {"many_to_many": False, "many_to_one": False}
     )

src/django_idom/utils.py

@@ -200,38 +200,3 @@ def _generate_obj_name(object: Any) -> str | None:
         if hasattr(object, "__class__"):
             return f"{object.__module__}.{object.__class__.__name__}"
     return None
-
-
-@overload
-def query_options(
-    query_func: None = ...,
-    evaluator: Callable[[QueryOptions], None] | None = None,
-    **options,
-) -> Callable[[Callable[_Params, _Result]], QueryOptions]:
-    ...
-
-
-@overload
-def query_options(
-    query_func: Callable[_Params, _Result],
-    evaluator: Callable[[QueryOptions], None] | None = None,
-    **options,
-) -> QueryOptions:
-    ...
-
-
-def query_options(
-    query_func: Callable[_Params, _Result] | None = None,
-    evaluator: Callable[[QueryOptions], None] | None = None,
-    **options,
-) -> QueryOptions | Callable[[Callable[_Params, _Result]], QueryOptions]:
-    def decorator(query_func: Callable[_Params, _Result]):
-        if not query_func:
-            raise ValueError("A query function must be provided to `query_options`")
-
-        query_options = QueryOptions(func=query_func, postprocessor=evaluator)
-        if options:
-            query_options.postprocessor_options.update(options)
-        return query_options
-
-    return decorator(query_func) if query_func else decorator

tests/test_app/components.py

@@ -8,7 +8,7 @@
 import django_idom
 from django_idom.components import view_to_component
 from django_idom.hooks import use_mutation, use_query
-from django_idom.utils import query_options
+from django_idom.types import QueryOptions
 
 from . import views
 
@@ -166,7 +166,6 @@ def create_relational_parent() -> RelationalParent:
     return parent
 
 
-@query_options(many_to_many=True, many_to_one=True)
 def get_relational_parent_query():
     return RelationalParent.objects.first() or create_relational_parent()
 
@@ -184,7 +183,10 @@ def get_foriegn_child_query():
 
 @component
 def relational_query():
-    relational_parent = use_query(get_relational_parent_query)
+    relational_parent = use_query(
+        get_relational_parent_query,
+        QueryOptions(postprocessor_options={"many_to_many": True, "many_to_one": True}),
+    )
     foriegn_child = use_query(get_foriegn_child_query)
 
     if not relational_parent.data or not foriegn_child.data: