fasthx 2.2.0__tar.gz → 2.3.0__tar.gz

{fasthx-2.2.0 → fasthx-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fasthx
-Version: 2.2.0
+Version: 2.3.0
 Summary: FastAPI server-side rendering with built-in HTMX support.
 License: MIT
 Author: Peter Volf
@@ -32,7 +32,7 @@ Description-Content-Type: text/markdown
 
 FastAPI server-side rendering with built-in HTMX support.
 
-Key features:
+## Key features
 
 - **Decorator syntax** that works with FastAPI as one would expect, no need for unused or magic dependencies in routes.
 - Built for **HTMX**, but can be used without it.
@@ -237,7 +237,7 @@ We welcome contributions from the community to help improve the project! Whether
 - **Discuss**: Join our [Discussion Board](https://github.com/volfpeter/fasthx/discussions) to ask questions, share ideas, provide feedback, and engage with the community.
 - **Document**: Help improve the documentation by fixing typos, adding examples, and updating guides to make it easier for others to use the project.
 - **Develop**: Prototype requested features or pick up issues from the issue tracker.
-- **Share**: Share you own project by adding it to the external examples list, helping others discover and benefit from your work.
+- **Share**: Share your own project by adding it to the external examples list, helping others discover and benefit from your work.
 - **Test**: Write tests to improve coverage and enhance reliability.
 
 ## License - MIT

{fasthx-2.2.0 → fasthx-2.3.0}/README.md

@@ -11,7 +11,7 @@
 
 FastAPI server-side rendering with built-in HTMX support.
 
-Key features:
+## Key features
 
 - **Decorator syntax** that works with FastAPI as one would expect, no need for unused or magic dependencies in routes.
 - Built for **HTMX**, but can be used without it.
@@ -216,7 +216,7 @@ We welcome contributions from the community to help improve the project! Whether
 - **Discuss**: Join our [Discussion Board](https://github.com/volfpeter/fasthx/discussions) to ask questions, share ideas, provide feedback, and engage with the community.
 - **Document**: Help improve the documentation by fixing typos, adding examples, and updating guides to make it easier for others to use the project.
 - **Develop**: Prototype requested features or pick up issues from the issue tracker.
-- **Share**: Share you own project by adding it to the external examples list, helping others discover and benefit from your work.
+- **Share**: Share your own project by adding it to the external examples list, helping others discover and benefit from your work.
 - **Test**: Write tests to improve coverage and enhance reliability.
 
 ## License - MIT

fasthx-2.3.0/fasthx/dependencies.py

@@ -0,0 +1,47 @@
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Annotated, Any, TypeAlias
+
+from fastapi import Depends, Header
+from fastapi import Request as FARequest
+
+if TYPE_CHECKING:
+    Request: TypeAlias = FARequest
+else:
+    Request: TypeAlias = Mapping[str, Any]
+    """
+    Alias for `Request` arguments.
+
+    Workaround for this FastAPI bug: https://github.com/fastapi/fastapi/discussions/12403.
+    And here's a FastAPI bugfix: https://github.com/fastapi/fastapi/pull/12406.
+
+    This workaround should be removed when FastAPI had several new releases with the fix.
+    """
+
+
+def get_hx_request(
+    request: FARequest, hx_request: Annotated[str | None, Header()] = None
+) -> Request | None:
+    """
+    FastAPI dependency that returns the current request if it is an HTMX one,
+    i.e. it contains an `"HX-Request: true"` header.
+    """
+    return request if hx_request == "true" else None
+
+
+def get_page_request(request: FARequest) -> Request:
+    """
+    Replacement dependency for `Request` to work around this FastAPI bug:
+    https://github.com/fastapi/fastapi/discussions/12403.
+    """
+    return request
+
+
+DependsHXRequest = Annotated[Request | None, Depends(get_hx_request)]
+"""Annotated type (dependency) for `get_hx_request()` for FastAPI."""
+
+DependsPageRequest = Annotated[Request, Depends(get_page_request)]
+"""
+Annotated `Request` dependency alias.
+
+Workaround for this FastAPI bug: https://github.com/fastapi/fastapi/discussions/12403
+"""

{fasthx-2.2.0 → fasthx-2.3.0}/fasthx/htmy.py

@@ -177,8 +177,30 @@ class HTMY:
             else self._make_error_render_function(error_component_selector),
         )
 
+    async def render_component(self, component: h.Component, request: Request) -> str:
+        """
+        Renders the given component.
+
+        This method is useful for rendering components directly, outside of the context of a route
+        (meaning no access to route parameters), for example in exception handlers.
+
+        The method adds all the usual data to the `htmy` rendering context, including the result of
+        all request processors. There is no access to route parameters though, so while `RouteParams`
+        will be in the context, it will be empty.
+
+        Arguments:
+            component: The component to render.
+            request: The current request.
+
+        Returns:
+            The rendered component.
+        """
+        return await self.htmy.render(component, self._make_render_context(request, {}))
+
     def _make_render_function(self, component_selector: HTMYComponentSelector[T]) -> HTMLRenderer[T]:
-        """Creates a render function that uses the given component selector."""
+        """
+        Creates a render function that uses the given component selector.
+        """
 
         async def render(result: T, *, context: dict[str, Any], request: Request) -> str:
             component = (
@@ -193,7 +215,9 @@ class HTMY:
     def _make_error_render_function(
         self, component_selector: HTMYComponentSelector[Exception]
     ) -> HTMLRenderer[Exception]:
-        """Creates an error renderer function that uses the given component selector."""
+        """
+        Creates an error renderer function that uses the given component selector.
+        """
 
         async def render(result: Exception, *, context: dict[str, Any], request: Request) -> str:
             component = (
@@ -206,7 +230,16 @@ class HTMY:
         return render
 
     def _make_render_context(self, request: Request, route_params: dict[str, Any]) -> h.Context:
-        """Creates the HTMY rendering context."""
+        """
+        Creates the `htmy` rendering context for the given request and route parameters.
+
+        Arguments:
+            request: The current request.
+            route_params: The route parameters.
+
+        Returns:
+            The `htmy` rendering context.
+        """
         # Add the current request to the context.
         result = CurrentRequest.to_context(request)
 

{fasthx-2.2.0 → fasthx-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fasthx"
-version = "2.2.0"
+version = "2.3.0"
 description = "FastAPI server-side rendering with built-in HTMX support."
 authors = ["Peter Volf <do.volfp@gmail.com>"]
 readme = "README.md"

fasthx-2.2.0/fasthx/dependencies.py

@@ -1,47 +0,0 @@
-from collections.abc import Mapping
-from typing import TYPE_CHECKING, Annotated, Any, TypeAlias
-
-from fastapi import Depends, Header, Request
-
-RequestAlias: TypeAlias = Mapping[str, Any]
-"""
-Alias for `Request` arguments.
-
-Workaround for this FastAPI bug: https://github.com/fastapi/fastapi/discussions/12403.
-And here's a FastAPI bugfix: https://github.com/fastapi/fastapi/pull/12406.
-
-This workaround should be removed when FastAPI had several new releases with the fix.
-"""
-
-
-def get_hx_request(
-    request: Request, hx_request: Annotated[str | None, Header()] = None
-) -> RequestAlias | None:
-    """
-    FastAPI dependency that returns the current request if it is an HTMX one,
-    i.e. it contains an `"HX-Request: true"` header.
-    """
-    return request if hx_request == "true" else None
-
-
-def get_page_request(request: Request) -> RequestAlias:
-    """
-    Replacement dependency for `Request` to work around this FastAPI bug:
-    https://github.com/fastapi/fastapi/discussions/12403.
-    """
-    return request
-
-
-if TYPE_CHECKING:
-    DependsHXRequest: TypeAlias = Request | None
-    DependsPageRequest: TypeAlias = Request
-else:
-    DependsHXRequest = Annotated[RequestAlias | Request | None, Depends(get_hx_request)]
-    """Annotated type (dependency) for `get_hx_request()` for FastAPI."""
-
-    DependsPageRequest = Annotated[RequestAlias | Request, Depends(get_page_request)]
-    """
-    Annotated `Request` dependency alias.
-
-    Workaround for this FastAPI bug: https://github.com/fastapi/fastapi/discussions/12403
-    """