bayesline.api.equity.ReportLoaderApi#
- class bayesline.api.equity.ReportLoaderApi#
The main interface for loading different types of reports.
- __init__()#
Methods
__init__()load(settings)Load a report using the specified settings.
load_accessor(identifier)Load a report accessor from an identifier.
- abstract load(settings: DatasetAwareSettings[S]) ReportApi[..., TypedReportAccessorApi, S]#
Load a report using the specified settings.
Parameters#
- settings: DatasetAwareSettings[S]
The settings to use to load the report.
Returns#
- ReportApi[…, TypedReportAccessorApi, S]
The loaded report API.
- abstract load_accessor(identifier: str) TypedReportAccessorApi#
Load a report accessor from an identifier.
This accessor is obtained from an existing accessor after a report has been calculated. The identifier is ephemeral, and should only be used for short- lived sessions, and not persisted over time.
Parameters#
- identifier: str
The short-lived ephemeral identifier to load the report accessor from.
Returns#
- TypedReportAccessorApi
The loaded report accessor.
Raises#
- KeyError
If the identifier is not found. This can happen if the identifier has expired, belongs to a different session, or was never created.