feat: make the component_selector argument optional for the htmy

integration, fixes #81

Author: volfpeter

fasthx/htmy.py

@@ -134,7 +134,7 @@ class HTMY:
 
     def hx(
         self,
-        component_selector: HTMYComponentSelector[T],
+        component_selector: HTMYComponentSelector[T] | None = None,
         *,
         error_component_selector: HTMYComponentSelector[Exception] | None = None,
         no_data: bool = False,
@@ -143,12 +143,15 @@ def hx(
         Decorator for rendering the route's result if the request was an HTMX one.
 
         Arguments:
-            component_selector: The component selector to use.
+            component_selector: An optional component selector to use. If not provided, it is
+                assumed the route returns a component that should be rendered as is.
             error_component_selector: The component selector to use for route error rendering.
             no_data: If set, the route will only accept HTMX requests.
         """
         return hx(
-            self._make_render_function(component_selector),
+            self._make_render_function(
+                _default_component_selector if component_selector is None else component_selector
+            ),
             render_error=None
             if error_component_selector is None
             else self._make_error_render_function(error_component_selector),
@@ -157,7 +160,7 @@ def hx(
 
     def page(
         self,
-        component_selector: HTMYComponentSelector[T],
+        component_selector: HTMYComponentSelector[T] | None = None,
         *,
         error_component_selector: HTMYComponentSelector[Exception] | None = None,
     ) -> Callable[[MaybeAsyncFunc[P, T]], Callable[P, Coroutine[None, None, T | Response]]]:
@@ -167,11 +170,14 @@ def page(
         This decorator triggers HTML rendering regardless of whether the request was HTMX or not.
 
         Arguments:
-            component_selector: The component selector to use.
+            component_selector: An optional component selector to use. If not provided, it is
+                assumed the route returns a component that should be rendered as is.
             error_component_selector: The component selector to use for route error rendering.
         """
         return page(
-            self._make_render_function(component_selector),
+            self._make_render_function(
+                _default_component_selector if component_selector is None else component_selector
+            ),
             render_error=None
             if error_component_selector is None
             else self._make_error_render_function(error_component_selector),
@@ -255,3 +261,13 @@ def _make_render_context(self, request: Request, route_params: dict[str, Any]) -
             result.update(cp(request))
 
         return result
+
+
+def _default_component_selector(route_result: Any) -> Any:
+    """
+    Default component selector that returns the route result as is.
+
+    It is assumed (and not validated) that the route result is a `htmy.Component` when
+    this component selector is used. Otherwise rendering will fail.
+    """
+    return route_result

tests/test_htmy.py

@@ -76,6 +76,16 @@ def htmx_or_data_by_id(id: int) -> User:
     def header_with_no_default() -> User:
         return billy
 
+    @app.get("/hx-no-selector", response_model=None)
+    @htmy.hx()  # HelloWorld is a component, render it as is.
+    def hx_no_selector() -> HelloWorld:
+        return HelloWorld()
+
+    @app.get("/page-no-selector", response_model=None)
+    @htmy.page()  # HelloWorld is a component, render it as is.
+    def page_no_selector() -> HelloWorld:
+        return HelloWorld()
+
     @app.get("/error")
     @app.get("/error/{kind}")
     @htmy.hx(  # type: ignore[arg-type]
@@ -184,6 +194,8 @@ def htmy_client(htmy_app: FastAPI) -> TestClient:
             {},
         ),
         ("/header-with-no-default", {"HX-Request": "true"}, 500, "", {}),
+        ("/hx-no-selector", {"HX-Request": "true"}, 200, "Hello World!", {}),
+        ("/page-no-selector", {"HX-Request": "true"}, 200, "Hello World!", {}),
         # htmy.hx(no_data=True) - raises exception for non-HTMX requests.
         ("/htmx-only", {"HX-Request": "true"}, 200, user_list_html, {}),
         ("/htmx-only", None, 400, "", {}),