httk.web.renderers¶

Submodules¶

Attributes¶

RENDERERS_BY_SUFFIX

Classes¶

`Renderer`	Base class for protocol classes.
`RenderResult`
`HtmlRenderer`
`HttkwebCompatRenderer`	Minimal compatibility renderer for legacy .httkweb files.
`MarkdownRenderer`
`RstRenderer`

Package Contents¶

class httk.web.renderers.Renderer[source]¶

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

render(source_path: pathlib.Path) → RenderResult[source]¶

class httk.web.renderers.RenderResult[source]¶

html: str¶

metadata: dict[str, object]¶

class httk.web.renderers.HtmlRenderer[source]¶

render(source_path: pathlib.Path) → httk.web.renderers.base.RenderResult[source]¶

class httk.web.renderers.HttkwebCompatRenderer[source]¶

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: pathlib.Path) → httk.web.renderers.base.RenderResult[source]¶

class httk.web.renderers.MarkdownRenderer[source]¶

render(source_path: pathlib.Path) → httk.web.renderers.base.RenderResult[source]¶

class httk.web.renderers.RstRenderer[source]¶

render(source_path: pathlib.Path) → httk.web.renderers.base.RenderResult[source]¶

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