Merge pull request #85 from volfpeter/feat/allow-Response-in-route-type-hints

Allow Response in route type hints

Author: volfpeter

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ on:
       - synchronize
 
 jobs:
-  Linters:
+  Tests:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository

fasthx/core_decorators.py

@@ -16,7 +16,7 @@ def hx(
     *,
     no_data: bool = False,
     render_error: RenderFunction[Exception] | None = None,
-) -> Callable[[MaybeAsyncFunc[P, T]], Callable[P, Coroutine[None, None, T | Response]]]:
+) -> Callable[[MaybeAsyncFunc[P, T | Response]], Callable[P, Coroutine[None, None, T | Response]]]:
     """
     Decorator that converts a FastAPI route's return value into HTML if the request was
     an HTMX one.
@@ -31,7 +31,9 @@ def hx(
         The rendered HTML for HTMX requests, otherwise the route's unchanged return value.
     """
 
-    def decorator(func: MaybeAsyncFunc[P, T]) -> Callable[P, Coroutine[None, None, T | Response]]:
+    def decorator(
+        func: MaybeAsyncFunc[P, T | Response],
+    ) -> Callable[P, Coroutine[None, None, T | Response]]:
         @wraps(func)
         async def wrapper(
             __hx_request: DependsHXRequest, *args: P.args, **kwargs: P.kwargs
@@ -84,7 +86,7 @@ def page(
     render: RenderFunction[T],
     *,
     render_error: RenderFunction[Exception] | None = None,
-) -> Callable[[MaybeAsyncFunc[P, T]], Callable[P, Coroutine[None, None, Response]]]:
+) -> Callable[[MaybeAsyncFunc[P, T | Response]], Callable[P, Coroutine[None, None, Response]]]:
     """
     Decorator that converts a FastAPI route's return value into HTML.
 
@@ -94,7 +96,7 @@ def page(
             If not `None`, it is expected to raise an error if the exception can not be rendered.
     """
 
-    def decorator(func: MaybeAsyncFunc[P, T]) -> Callable[P, Coroutine[None, None, Response]]:
+    def decorator(func: MaybeAsyncFunc[P, T | Response]) -> Callable[P, Coroutine[None, None, Response]]:
         @wraps(func)
         async def wrapper(
             __page_request: DependsPageRequest, *args: P.args, **kwargs: P.kwargs

fasthx/htmy.py

@@ -138,7 +138,7 @@ def hx(
         *,
         error_component_selector: HTMYComponentSelector[Exception] | None = None,
         no_data: bool = False,
-    ) -> Callable[[MaybeAsyncFunc[P, T]], Callable[P, Coroutine[None, None, T | Response]]]:
+    ) -> Callable[[MaybeAsyncFunc[P, T | Response]], Callable[P, Coroutine[None, None, T | Response]]]:
         """
         Decorator for rendering the route's result if the request was an HTMX one.
 
@@ -163,7 +163,7 @@ def page(
         component_selector: HTMYComponentSelector[T] | None = None,
         *,
         error_component_selector: HTMYComponentSelector[Exception] | None = None,
-    ) -> Callable[[MaybeAsyncFunc[P, T]], Callable[P, Coroutine[None, None, T | Response]]]:
+    ) -> Callable[[MaybeAsyncFunc[P, T | Response]], Callable[P, Coroutine[None, None, T | Response]]]:
         """
         Decorator for rendering a route's result.
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fasthx"
-version = "3.0.0"
+version = "3.0.1"
 description = "FastAPI server-side rendering with built-in HTMX support."
 authors = ["Peter Volf <[email protected]>"]
 readme = "README.md"

tests/test_htmy.py

@@ -38,7 +38,9 @@ def index() -> list[User]:
 
     @app.get("/htmx-or-data")
     @htmy.hx(UserList)
-    def htmx_or_data(response: Response) -> list[User]:
+    def htmx_or_data(
+        response: Response,
+    ) -> list[User]:
         response.headers["test-header"] = "exists"
         return users