httk.serve.web.renderers.base

Define renderer inputs and outputs shared by content renderers.

Classes

WidgetPlacement	Describe a widget invocation replaced by a stable placeholder.
RenderResult	Carry rendered HTML, metadata, and widget placements.
Renderer	Define the source-renderer protocol.

Module Contents

class httk.serve.web.renderers.base.WidgetPlacement

Describe a widget invocation replaced by a stable placeholder.

Parameters:

• placeholder – Placeholder text inserted into rendered content.

• name – Requested widget name.

• props – Literal widget properties.

• source_path – Source file containing the invocation.

• line – One-based source line.

• column – One-based source column.

• snippet – Original invocation text.

placeholder: str

name: str

props: collections.abc.Mapping[str, object]

source_path: pathlib.Path

line: int

column: int

snippet: str

class httk.serve.web.renderers.base.RenderResult

Carry rendered HTML, metadata, and widget placements.

Parameters:

• html – Rendered HTML before templates are applied.

• metadata – Source metadata.

• widgets – Widget placements found in the source.

html: str

metadata: dict[str, object]

widgets: tuple[WidgetPlacement, Ellipsis] = ()

class httk.serve.web.renderers.base.Renderer

Bases: Protocol

Define the source-renderer protocol.

render(source_path)

Render a source file into HTML and metadata.