httk.serve.web.renderers

Provide content renderers and suffix dispatch for web pages.

Submodules

• httk.serve.web.renderers.base
• httk.serve.web.renderers.html
• httk.serve.web.renderers.httkweb_compat
• httk.serve.web.renderers.markdown
• httk.serve.web.renderers.rst

Attributes

RENDERERS_BY_SUFFIX

Classes

Renderer	Define the source-renderer protocol.
RenderResult	Carry rendered HTML, metadata, and widget placements.
HtmlRenderer	Render HTML source files.
HttkwebCompatRenderer	Minimal compatibility renderer for legacy .httkweb files.
MarkdownRenderer	Render Markdown source files.
RstRenderer	Render reStructuredText source files.

Package Contents

class httk.serve.web.renderers.Renderer

Bases: Protocol

Define the source-renderer protocol.

render(source_path)

Render a source file into HTML and metadata.

class httk.serve.web.renderers.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.HtmlRenderer

Render HTML source files.

render(source_path)

Render one HTML source file.

Parameters:

source_path (pathlib.Path) – HTML source file to render.

Returns:

Rendered HTML, metadata, and widget placements.

Return type:

httk.serve.web.renderers.base.RenderResult

class httk.serve.web.renderers.HttkwebCompatRenderer

Minimal compatibility renderer for legacy .httkweb files.

Old .httkweb pages typically have YAML-like front matter bounded by dashes, followed by text that is close to reStructuredText.

render(source_path)

Render one legacy .httkweb source file.

Parameters:

source_path (pathlib.Path) – Legacy source file to render.

Returns:

Rendered HTML, metadata, and widget placements.

Return type:

httk.serve.web.renderers.base.RenderResult

class httk.serve.web.renderers.MarkdownRenderer

Render Markdown source files.

render(source_path)

Render one Markdown source file.

Parameters:

source_path (pathlib.Path) – Markdown source file to render.

Returns:

Rendered HTML, metadata, and widget placements.

Return type:

httk.serve.web.renderers.base.RenderResult

class httk.serve.web.renderers.RstRenderer

Render reStructuredText source files.

render(source_path)

Render one reStructuredText source file.

Parameters:

source_path (pathlib.Path) – reStructuredText source file to render.

Returns:

Rendered HTML, metadata, and widget placements.

Return type:

httk.serve.web.renderers.base.RenderResult

httk.serve.web.renderers.RENDERERS_BY_SUFFIX: dict[str, base.Renderer]