HTMLRenderer

Sync or async HTML renderer type.

SyncHTMLRenderer

Bases: Protocol[Tcontra]

Sync HTML renderer definition.

Source code in fasthx/typing.py

class SyncHTMLRenderer(Protocol[Tcontra]):
    """Sync HTML renderer definition."""

    def __call__(self, result: Tcontra, *, context: dict[str, Any], request: Request) -> str | Response:
        """
        Arguments:
            result: The result of the route the renderer is used on.
            context: Every keyword argument the route received.
            request: The request being served.

        Returns:
            HTML string (it will be automatically converted to `HTMLResponse`) or a `Response` object.
        """
        ...

__call__(result, *, context, request)

Parameters:

Name	Type	Description	Default
result	Tcontra	The result of the route the renderer is used on.	required
context	dict[str, Any]	Every keyword argument the route received.	required
request	Request	The request being served.	required

Returns:

Type	Description
str | Response	HTML string (it will be automatically converted to HTMLResponse) or a Response object.

Source code in fasthx/typing.py

def __call__(self, result: Tcontra, *, context: dict[str, Any], request: Request) -> str | Response:
    """
    Arguments:
        result: The result of the route the renderer is used on.
        context: Every keyword argument the route received.
        request: The request being served.

    Returns:
        HTML string (it will be automatically converted to `HTMLResponse`) or a `Response` object.
    """
    ...

AsyncHTMLRenderer

Bases: Protocol[Tcontra]

Async HTML renderer definition.

Source code in fasthx/typing.py

class AsyncHTMLRenderer(Protocol[Tcontra]):
    """Async HTML renderer definition."""

    async def __call__(
        self, result: Tcontra, *, context: dict[str, Any], request: Request
    ) -> str | Response:
        """
        Arguments:
            result: The result of the route the renderer is used on.
            context: Every keyword argument the route received.
            request: The request being served.

        Returns:
            HTML string (it will be automatically converted to `HTMLResponse`) or a `Response` object.
        """
        ...

__call__(result, *, context, request) async

Parameters:

Name	Type	Description	Default
result	Tcontra	The result of the route the renderer is used on.	required
context	dict[str, Any]	Every keyword argument the route received.	required
request	Request	The request being served.	required

Returns:

Type	Description
str | Response	HTML string (it will be automatically converted to HTMLResponse) or a Response object.

Source code in fasthx/typing.py

async def __call__(
    self, result: Tcontra, *, context: dict[str, Any], request: Request
) -> str | Response:
    """
    Arguments:
        result: The result of the route the renderer is used on.
        context: Every keyword argument the route received.
        request: The request being served.

    Returns:
        HTML string (it will be automatically converted to `HTMLResponse`) or a `Response` object.
    """
    ...