Skip to content

htmy.renderer.typing

RendererType

Bases: Protocol

Protocol definition for renderers.

Source code in htmy/renderer/typing.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
class RendererType(Protocol):
    """Protocol definition for renderers."""

    async def render(self, component: Component, context: Context | None = None) -> str:
        """
        Renders the given component.

        Arguments:
            component: The component to render.
            context: An optional rendering context.

        Returns:
            The rendered string.
        """
        ...

render(component, context=None) async

Renders the given component.

Parameters:

Name Type Description Default
component Component

The component to render.

 required
context Context | None

An optional rendering context.

 None

Returns:

Type Description
str

The rendered string.
Source code in htmy/renderer/typing.py 
15
16
17
18
19
20
21
22
23
24
25
26
async def render(self, component: Component, context: Context | None = None) -> str:
    """
    Renders the given component.

    Arguments:
        component: The component to render.
        context: An optional rendering context.

    Returns:
        The rendered string.
    """
    ...

StreamingRendererType

Bases: RendererType, Protocol

Protocol definition for streaming renderers.

Source code in htmy/renderer/typing.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class StreamingRendererType(RendererType, Protocol):
    """Protocol definition for streaming renderers."""

    def stream(self, component: Component, context: Context | None = None) -> AsyncIterator[str]:
        """
        Async iterator that renders the given component.

        Arguments:
            component: The component to render.
            context: An optional rendering context.

        Yields:
            The rendered strings.
        """
        ...

stream(component, context=None)

Async iterator that renders the given component.

Parameters:

Name Type Description Default
component Component

The component to render.

 required
context Context | None

An optional rendering context.

 None

Yields:

Type Description
AsyncIterator[str]

The rendered strings.
Source code in htmy/renderer/typing.py 
39
40
41
42
43
44
45
46
47
48
49
50
def stream(self, component: Component, context: Context | None = None) -> AsyncIterator[str]:
    """
    Async iterator that renders the given component.

    Arguments:
        component: The component to render.
        context: An optional rendering context.

    Yields:
        The rendered strings.
    """
    ...

is_renderer(obj)

Type guard that checks if the given object is a renderer.

Source code in htmy/renderer/typing.py 
29
30
31
32
33
def is_renderer(obj: Any | None) -> TypeGuard[RendererType]:
    """Type guard that checks if the given object is a renderer."""
    # Just a basic check, don't waste time here.
    render: Any = getattr(obj, "render", None)
    return render is not None

is_streaming_renderer(obj)

Type guard that checks if the given object is a streaming renderer.

Source code in htmy/renderer/typing.py 
53
54
55
56
57
58
59
60
def is_streaming_renderer(obj: Any | None) -> TypeGuard[StreamingRendererType]:
    """Type guard that checks if the given object is a streaming renderer."""
    if not is_renderer(obj):
        return False

    # Just a basic check, don't waste time here.
    stream: Any = getattr(obj, "stream", None)
    return stream is not None