1 reporting.bundle

reporting.bundle

Cold verification and reconstruction of published scientific report bundles.

The reader accepts the explicit config-v1/snapshot-v1/report-bundle-v2 and config-v2/snapshot-v2/report-bundle-v3 variants under manifest-v1. It performs no source acquisition or rendering: every returned value comes from manifest-declared, digest-verified local files.

1.1 Classes

Name	Description
VerifiedReportBundle	A cold-verified snapshot and exact bundle bytes for static consumers.

1.1.1 VerifiedReportBundle

reporting.bundle.VerifiedReportBundle(snapshot, manifest_sha256, file_bytes)

A cold-verified snapshot and exact bundle bytes for static consumers.

The file set is captured in the same read transaction that validates the manifest, paths, asset digests, and snapshot. Consumers can publish HTML and static fallbacks without reopening the source bundle or raw evidence.

1.1.1.1 Attributes

Name	Description
snapshot	Typed snapshot reconstructed from the validated bundle bytes.
manifest_sha256	SHA-256 of the exact `manifest.json` bytes in `file_bytes`.
file_bytes	Sorted bundle-relative POSIX paths and captured bytes for every file.

1.2 Functions

Name	Description
read_report_bundle	Verify a current report bundle and reconstruct its sealed snapshot.
read_report_bundle_with_assets	Read a verified report with its exact files for source-free publishing.

1.2.1 read_report_bundle

reporting.bundle.read_report_bundle(path)

Verify a current report bundle and reconstruct its sealed snapshot.

Verification rejects unknown schema versions, non-canonical JSON, unsafe or duplicate paths, symlinks and special files, undeclared or missing files, digest mismatches, and malformed report values. The reconstructed ReportSnapshot then verifies the report’s snapshot_sha256 against the exact recipe, quantities, tables, sources, and Plotly bytes.

1.2.1.1 Parameters

Name	Type	Description	Default
path	Path \| str	Directory produced by `write_report_snapshot`.	required

1.2.1.2 Returns

Name	Type	Description
	ReportSnapshot	The immutable snapshot represented by the verified bundle.

1.2.1.3 Raises

Name	Type	Description
	ScientificReportError	If the path is not a complete current bundle.

1.2.2 read_report_bundle_with_assets

reporting.bundle.read_report_bundle_with_assets(path)

Read a verified report with its exact files for source-free publishing.

# reporting.bundle { #aria_nbv.reporting.bundle } `reporting.bundle` Cold verification and reconstruction of published scientific report bundles. The reader accepts the explicit config-v1/snapshot-v1/report-bundle-v2 and config-v2/snapshot-v2/report-bundle-v3 variants under manifest-v1. It performs no source acquisition or rendering: every returned value comes from manifest-declared, digest-verified local files. ## Classes | Name | Description | | --- | --- | | [VerifiedReportBundle](#aria_nbv.reporting.bundle.VerifiedReportBundle) | A cold-verified snapshot and exact bundle bytes for static consumers. | ### VerifiedReportBundle { #aria_nbv.reporting.bundle.VerifiedReportBundle } ```python reporting.bundle.VerifiedReportBundle(snapshot, manifest_sha256, file_bytes) ``` A cold-verified snapshot and exact bundle bytes for static consumers. The file set is captured in the same read transaction that validates the manifest, paths, asset digests, and snapshot. Consumers can publish HTML and static fallbacks without reopening the source bundle or raw evidence. #### Attributes | Name | Description | | --- | --- | | [snapshot](#aria_nbv.reporting.bundle.VerifiedReportBundle.snapshot) | Typed snapshot reconstructed from the validated bundle bytes. | | [manifest_sha256](#aria_nbv.reporting.bundle.VerifiedReportBundle.manifest_sha256) | SHA-256 of the exact ``manifest.json`` bytes in ``file_bytes``. | | [file_bytes](#aria_nbv.reporting.bundle.VerifiedReportBundle.file_bytes) | Sorted bundle-relative POSIX paths and captured bytes for every file. | ## Functions | Name | Description | | --- | --- | | [read_report_bundle](#aria_nbv.reporting.bundle.read_report_bundle) | Verify a current report bundle and reconstruct its sealed snapshot. | | [read_report_bundle_with_assets](#aria_nbv.reporting.bundle.read_report_bundle_with_assets) | Read a verified report with its exact files for source-free publishing. | ### read_report_bundle { #aria_nbv.reporting.bundle.read_report_bundle } ```python reporting.bundle.read_report_bundle(path) ``` Verify a current report bundle and reconstruct its sealed snapshot. Verification rejects unknown schema versions, non-canonical JSON, unsafe or duplicate paths, symlinks and special files, undeclared or missing files, digest mismatches, and malformed report values. The reconstructed :class:`ReportSnapshot` then verifies the report's ``snapshot_sha256`` against the exact recipe, quantities, tables, sources, and Plotly bytes. #### Parameters {.doc-section .doc-section-parameters} | Name | Type | Description | Default | |--------|----------------------------------------|------------------------------------------------------|------------| | path | [Path](`pathlib.Path`) \| [str](`str`) | Directory produced by :func:`write_report_snapshot`. | _required_ | #### Returns {.doc-section .doc-section-returns} | Name | Type | Description | |--------|---------------------------------------------------------------|------------------------------------------------------------| | | [ReportSnapshot](`aria_nbv.reporting.results.ReportSnapshot`) | The immutable snapshot represented by the verified bundle. | #### Raises {.doc-section .doc-section-raises} | Name | Type | Description | |--------|----------------------------------------------------------------------------|-----------------------------------------------| | | [ScientificReportError](`aria_nbv.reporting.errors.ScientificReportError`) | If the path is not a complete current bundle. | ### read_report_bundle_with_assets { #aria_nbv.reporting.bundle.read_report_bundle_with_assets } ```python reporting.bundle.read_report_bundle_with_assets(path) ``` Read a verified report with its exact files for source-free publishing.