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) -> NoneFields and properties declared here; inherited members belong to the bases above.
assets
assets: list[FigureAsset] = []document
document: Document | None = Nonefrontmatter
frontmatter: dict[str, Any] = {}target
target: Target = Target.INTERACTIVEtheme
theme: Theme | None = themetoc
toc: list[TocEntry] = []build_figure
def build_figure(figure: Figure) -> Anyfigure_assets
def figure_assets(fig: Any, fmt: PlotFormat, uploader: Any = None) -> FigureAssetfinalize
def finalize(document: Document, body: str) -> RenderResultWrap the rendered body in the target page shell. Overridden per target.
render
def render(document: Document) -> RenderResultWalk the tree ONCE and produce a :class:RenderResult.
slug
@staticmethoddef slug(text: str) -> strvisit_button
def visit_button(node: Button) -> strvisit_callout
def visit_callout(node: Callout) -> strvisit_cell
def visit_cell(node: Cell) -> strvisit_columns
def visit_columns(node: Columns) -> strvisit_divider
def visit_divider(node: Divider) -> strvisit_figure
def visit_figure(node: Figure) -> strvisit_frontmatter
def visit_frontmatter(node: Frontmatter) -> strvisit_grid
def visit_grid(node: Grid) -> strvisit_heading
def visit_heading(node: Heading) -> strvisit_image
def visit_image(node: Image) -> strvisit_kpis
def visit_kpis(node: Kpis) -> strvisit_row
def visit_row(node: Row) -> strvisit_section
def visit_section(node: Section) -> strvisit_spacer
def visit_spacer(node: Spacer) -> strvisit_status
def visit_status(node: Status) -> strvisit_table
def visit_table(node: Table) -> strvisit_text
def visit_text(node: Text) -> strTarget
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'