bayesline.api.equity.AsyncReportLoaderApi

class bayesline.api.equity.AsyncReportLoaderApi

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 async load(settings: DatasetAwareSettings[S]) → AsyncReportApi[..., AsyncTypedReportAccessorApi, S]

Load a report using the specified settings.

Parameters

settingsDatasetAwareSettings[S]

The settings to use to load the report.

Returns

AsyncReportApi[…, TypedReportAccessorApi, S]

The loaded report API.

abstract async load_accessor(identifier: str) → AsyncTypedReportAccessorApi

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

identifierstr

The short-lived ephemeral identifier to load the report accessor from.

Returns

AsyncTypedReportAccessorApi

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.