bayesline.api.equity.resolve

Contents

bayesline.api.equity.resolve#

bayesline.api.equity.resolve(column_or_name: str | AnyReportColumnSettings, *, menu: ReportColumnSettingsMenu) → AnyReportColumnSettings[Never]#

Resolve a column: every choice set.

A bare string is the metric of that name with every default. A choice set on the column is kept; a None choice takes the first value found in menu.defaults[metric], then menu.defaults[kind], then the variant’s own default. Whether the metric and the choices are ones the report offers is validation against the menu, not resolution.

Parameters#

column_or_namestr | AnyReportColumnSettings

A column, or the name of a metric the menu lists.

menuReportColumnSettingsMenu

The menu of the report the column is asked of.

Returns#

AnyReportColumnSettings[Resolved]

The same variant, parametrized over the same metrics, resolved.

Raises#

ValueError

If a bare name is not a metric the menu lists.