1 reporting.export

reporting.export

Deterministic staged export of already materialized report snapshots.

The exporter never accepts a report config and never owns evidence adapters. It serializes the exact quantities, tables, and canonical Plotly JSON present in a ReportSnapshot, renders static assets, validates digests, then atomically promotes the complete directory for Typst consumption.

1.1 Classes

Name Description
ReportWriteReceipt Identity of one atomically published report directory.

1.1.1 ReportWriteReceipt

reporting.export.ReportWriteReceipt(
    destination,
    manifest_sha256,
    snapshot_sha256,
    assets,
)

Identity of one atomically published report directory.

1.1.1.1 Attributes

Name Description
destination Absolute promoted report directory.
manifest_sha256 Digest of the exact exported manifest bytes.
snapshot_sha256 Digest of the immutable input snapshot.
assets Sorted relative asset path and SHA-256 pairs.

1.2 Functions

Name Description
write_report_snapshot Atomically export the exact supplied snapshot without source access.

1.2.1 write_report_snapshot

reporting.export.write_report_snapshot(
    snapshot,
    destination,
    *,
    width=1400,
    height=900,
    scale=2.0,
    two_dimensional_format='svg',
    webgl_format='png',
    transparent_background=False,
    renderer=None,
)

Atomically export the exact supplied snapshot without source access.

Ordinary 2D figures use SVG by default. WebGL/3D figures use high- resolution PNG because vector containers rasterize their WebGL layers. transparent_background applies a renderer-only transparent canvas to PNG assets while preserving the canonical Plotly specification verbatim. A render or validation failure removes only the staging directory and keeps the previously published destination intact. An existing corrupt bundle raises its admission error and remains untouched; it is never a cache miss.

Back to top