htmy.renderer.default

Renderer

The default renderer.

It resolves component trees by converting them to a linked list of resolved component parts before combining them to the final string.

Source code in htmy/renderer/default.py

class Renderer:
    """
    The default renderer.

    It resolves component trees by converting them to a linked list of resolved component parts
    before combining them to the final string.
    """

    __slots__ = ("_default_context", "_string_formatter")

    def __init__(
        self,
        default_context: Context | None = None,
        *,
        string_formatter: Callable[[str], str] = xml_format_string,
    ) -> None:
        """
        Initialization.

        Arguments:
            default_context: The default context to use for rendering if `render()` doesn't
                receive a context.
            string_formatter: Callable that should be used to format plain strings. By default
                an XML-safe string formatter will be used.
        """
        self._default_context: Context = {} if default_context is None else default_context
        self._string_formatter = string_formatter

    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.
        """
        # Type ignore: ChainMap expects mutable mappings, but context mutation is not allowed so don't care.
        context = (
            self._default_context if context is None else ChainMap(context, self._default_context)  # type: ignore[arg-type]
        )
        return await _render_component(component, context=context, string_formatter=self._string_formatter)

__init__(default_context=None, *, string_formatter=xml_format_string)

Initialization.

Parameters:

Name	Type	Description	Default
default_context	Context | None	The default context to use for rendering if render() doesn't receive a context.	None
string_formatter	Callable[[str], str]	Callable that should be used to format plain strings. By default an XML-safe string formatter will be used.	xml_format_string

Source code in htmy/renderer/default.py

def __init__(
    self,
    default_context: Context | None = None,
    *,
    string_formatter: Callable[[str], str] = xml_format_string,
) -> None:
    """
    Initialization.

    Arguments:
        default_context: The default context to use for rendering if `render()` doesn't
            receive a context.
        string_formatter: Callable that should be used to format plain strings. By default
            an XML-safe string formatter will be used.
    """
    self._default_context: Context = {} if default_context is None else default_context
    self._string_formatter = string_formatter

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/default.py

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.
    """
    # Type ignore: ChainMap expects mutable mappings, but context mutation is not allowed so don't care.
    context = (
        self._default_context if context is None else ChainMap(context, self._default_context)  # type: ignore[arg-type]
    )
    return await _render_component(component, context=context, string_formatter=self._string_formatter)