bayesline.api.equity.ReportLoaderApi

class bayesline.api.equity.ReportLoaderApi

API for loading portfolio reports.

This class provides functionality for loading portfolio reports using registry-based API patterns.

__init__()

Methods

__init__()
delete_persisted(name_or_id)	Delete persisted reports by name or ID.
load(ref_or_settings, *[, ...])	Load a report using the specified reference or settings.
load_as_task(ref_or_settings, *[, ...])
load_persisted(name_or_id)	Load a persisted report by name or ID.

Attributes

persisted_report_settings	Get the persisted report settings registry.
settings	Get the settings registry.

abstract load(ref_or_settings: str | int | ReportSettings, *, hierarchy_ref_or_settings: str | int | PortfolioHierarchySettings | None = None) → ReportApi

Load a report using the specified reference or settings.

Parameters

ref_or_settingsstr | int | ReportSettings

The reference or settings to load the report with.

hierarchy_ref_or_settingsstr | int | PortfolioHierarchySettings | None, default=None

Optional hierarchy reference or settings.

Returns

ReportApi

The loaded report API.

abstract load_as_task(ref_or_settings: str | int | ReportSettings, *, hierarchy_ref_or_settings: str | int | PortfolioHierarchySettings | None = None) → Task[ReportApi]

abstract property persisted_report_settings: ReadOnlyRegistry[ReportAccessorSettings]

Get the persisted report settings registry.

Returns

ReadOnlyRegistry[ReportAccessorSettings]

A read-only registry of persisted report settings.

abstract load_persisted(name_or_id: str | int) → ReportAccessorApi

Load a persisted report by name or ID.

Parameters

name_or_idstr | int

The name or ID of the persisted report.

Returns

ReportAccessorApi

The loaded report accessor API.

abstract delete_persisted(name_or_id: list[str | int]) → None

Delete persisted reports by name or ID.

Parameters

name_or_idlist[str | int]

The names or IDs of the persisted reports to delete.