Skip to content

common_reports.builders.renderers.base

Renderer base — the one-pass visitor that walks a Document tree.

Concrete renderers (Interactive / Email / Ghost) override the head/CSS, figure embedding and layout flattening; the tree walk is shared here. The value engines live beside it: builders/formatting.py (numbers, colour) and builders/plots.py (the optional Plotly families + figure_to_assets); both stay importable from this module for compatibility.

Renderers import contracts + schemas only, and NEVER mutate components.

Classes

Renderer

Base renderer: one visit_<type> per component + a single-pass render.

Concrete renderers (Interactive / Email / Ghost) override the head/CSS/figure embedding and layout flattening; the tree walk and the shared engines are inherited. Renderers NEVER mutate components.

__init__

def __init__(*, theme: Theme | None = None, **_: Any) -> None

Fields and properties declared here; inherited members belong to the bases above.

assets

assets: list[FigureAsset] = []

document

document: Document | None = None

frontmatter

frontmatter: dict[str, Any] = {}

target

target: Target = Target.INTERACTIVE

theme

theme: Theme | None = theme

toc

toc: list[TocEntry] = []

build_figure

def build_figure(figure: Figure) -> Any

figure_assets

def figure_assets(fig: Any, fmt: PlotFormat, uploader: Any = None) -> FigureAsset

finalize

def finalize(document: Document, body: str) -> RenderResult

Wrap the rendered body in the target page shell. Overridden per target.

render

def render(document: Document) -> RenderResult

Walk the tree ONCE and produce a :class:RenderResult.

slug

@staticmethod
def slug(text: str) -> str

visit_button

def visit_button(node: Button) -> str

visit_callout

def visit_callout(node: Callout) -> str

visit_cell

def visit_cell(node: Cell) -> str

visit_columns

def visit_columns(node: Columns) -> str

visit_divider

def visit_divider(node: Divider) -> str

visit_figure

def visit_figure(node: Figure) -> str

visit_frontmatter

def visit_frontmatter(node: Frontmatter) -> str

visit_grid

def visit_grid(node: Grid) -> str

visit_heading

def visit_heading(node: Heading) -> str

visit_image

def visit_image(node: Image) -> str

visit_kpis

def visit_kpis(node: Kpis) -> str

visit_row

def visit_row(node: Row) -> str

visit_section

def visit_section(node: Section) -> str

visit_spacer

def visit_spacer(node: Spacer) -> str

visit_status

def visit_status(node: Status) -> str

visit_table

def visit_table(node: Table) -> str

visit_text

def visit_text(node: Text) -> str

Target

Bases: Enum

Which view a renderer produces. The tree is identical; only head/CSS, figure embedding and layout-flattening differ (see §4.D).

Fields and properties declared here; inherited members belong to the bases above.

EMAIL

EMAIL = 'email'

GHOST

GHOST = 'ghost'

INTERACTIVE

INTERACTIVE = 'interactive'