bayesline.api.equity.XSRReportApi

class bayesline.api.equity.XSRReportApi

API for an XSR report.

__init__()

Methods

__init__()
calculate(start_date, end_date, **kwargs)	Calculate the XSR report.
calculate_as_task(start_date, end_date, **kwargs)	Calculate the XSR report as a task.
get_maybe_cached(start_date, end_date, **kwargs)	Get the cached XSR 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) → XSRReportAccessor | None

Get the cached XSR 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

XSRReportAccessor | None

The XSR report accessor if cached, otherwise None.

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

Calculate the XSR 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

XSRReportAccessor

The XSR report accessor.

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

Calculate the XSR 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[XSRReportAccessor]

The task for the XSR report accessor.