bayesline.api.equity.ReturnAttributionReportApi

class bayesline.api.equity.ReturnAttributionReportApi

API for a return attribution report.

__init__()

Methods

__init__()
calculate(start_date, end_date, **kwargs)	Calculate the return attribution report.
calculate_as_task(start_date, end_date, **kwargs)	Calculate the return attribution report as a task.
get_maybe_cached(start_date, end_date, **kwargs)	Get the cached return attribution report accessor API if it is available.
to_mermaid()	Get a Mermaid diagram of the report execution graph.

Attributes

settings

The settings used to create this report.

abstract get_maybe_cached(start_date: str | date | datetime | None, end_date: str | date | datetime | None, **kwargs: Any) → ReturnAttributionReportAccessor | None

Get the cached return attribution report accessor API if it is available.

Parameters

start_date: DateLike | None

The start date of the report.

end_date: DateLike | None

The end date of the report.

**kwargs: Any

Additional keyword arguments.

Returns

ReturnAttributionReportAccessor | None

The cached return attribution report accessor API, or None if the report is not cached.

abstract calculate(start_date: str | date | datetime | None, end_date: str | date | datetime | None, **kwargs: Any) → ReturnAttributionReportAccessor

Calculate the return attribution report.

Parameters

start_date: DateLike | None

The start date of the report.

end_date: DateLike | None

The end date of the report.

**kwargs: Any

Additional keyword arguments.

Returns

ReturnAttributionReportAccessor

The return attribution report accessor.

abstract calculate_as_task(start_date: str | date | datetime | None, end_date: str | date | datetime | None, **kwargs: Any) → Task[ReturnAttributionReportAccessor]

Calculate the return attribution report as a task.

Parameters

start_date: DateLike | None

The start date of the report.

end_date: DateLike | None

The end date of the report.

**kwargs: Any

Additional keyword arguments.

Returns

Task[ReturnAttributionReportAccessor]

The task for the return attribution report accessor.