httk.serve.web.renderers.base

Classes

WidgetPlacement

A widget invocation replaced by a stable renderer placeholder.

RenderResult

Renderer

Base class for protocol classes.

Module Contents

class httk.serve.web.renderers.base.WidgetPlacement[source]

A widget invocation replaced by a stable renderer placeholder.

placeholder: str[source]
name: str[source]
props: collections.abc.Mapping[str, object][source]
source_path: pathlib.Path[source]
line: int[source]
column: int[source]
snippet: str[source]
class httk.serve.web.renderers.base.RenderResult[source]
html: str[source]
metadata: dict[str, object][source]
widgets: tuple[WidgetPlacement, Ellipsis] = ()[source]
class httk.serve.web.renderers.base.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]