bayesline.api.equity.AsyncUniverseCountReportApi

Contents

bayesline.api.equity.AsyncUniverseCountReportApi#

class bayesline.api.equity.AsyncUniverseCountReportApi#

API for a universe count report.

__init__()#

Methods

`__init__`()
`calculate`(start_date, end_date, **kwargs)	Calculate the universe count report.
`calculate_as_task`(start_date, end_date, **kwargs)	Calculate the universe count report as a task.
`get_maybe_cached`(start_date, end_date, **kwargs)	Get the cached universe count 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 async get_maybe_cached(start_date: str | date | datetime | None, end_date: str | date | datetime | None, **kwargs: Any) → AsyncUniverseCountReportAccessor | None#

Get the cached universe count report accessor API if it is available.

Parameters#

start_dateDateLike | None: The start date of the report.
end_dateDateLike | None: The end date of the report.
**kwargs: Any: Additional keyword arguments.

Returns#

AsyncUniverseCountReportAccessor | None: The cached universe count report accessor API, or None if the report is not cached.

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

Calculate the universe count report.

Parameters#

start_dateDateLike | None: The start date of the report.
end_dateDateLike | None: The end date of the report.
**kwargs: Any: Additional keyword arguments.

Returns#

AsyncUniverseCountReportAccessor: The universe count report accessor.

abstract async calculate_as_task(start_date: str | date | datetime | None, end_date: str | date | datetime | None, **kwargs: Any) → AsyncTask[AsyncUniverseCountReportAccessor]#

Calculate the universe count report as a task.

Parameters#

start_dateDateLike | None: The start date of the report.
end_dateDateLike | None: The end date of the report.
**kwargs: Any: Additional keyword arguments.

Returns#

AsyncTask[UniverseCountReportAccessor]: The task for the universe count report.