bayesline.api.equity.ReportAccessorApi

class bayesline.api.equity.ReportAccessorApi

Bases: BaseReportAccessorApi

Methods

__init__()
get_data(path, *[, expand, pivot_cols, ...])
get_level_values([levels, include_totals, ...])
is_path_valid(path_levels, *[, expand])
persist(name)	Persists the given report for the given name.
validate_path(path_levels[, expand])

Attributes

axes
axis_lookup
metric_cols
pivot_cols

abstract get_level_values(levels: tuple[str, ...] = (), include_totals: bool = False, filters: list[tuple[str, str, Any] | Sequence[tuple[str, str, Any]]] | None = None) → DataFrame

abstract get_data(path: list[tuple[str, str]], *, expand: tuple[str, ...] = (), pivot_cols: tuple[str, ...] = (), value_cols: tuple[str, ...] = (), filters: list[tuple[str, str, Any] | Sequence[tuple[str, str, Any]]] | None = None, pivot_total: bool = False) → DataFrame

abstract persist(name: str) → int

Persists the given report for the given name.

Parameters

namestr

The name to persist the report under. Will throw if the name already exists.

Returns

int

A globally unique identifier of the persisted report.