bayesline.api.equity.ConcreteReportSettingsMenu

pydantic model bayesline.api.equity.ConcreteReportSettingsMenu

Show JSON schema

{
   "title": "ConcreteReportSettingsMenu",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

measure_types: ClassVar[list[Type[Union[PassThroughFactor2DMeasureSettings, HoldingsMeasureSettings, ExposureMeasureSettings, XSigmaRhoMeasureSettings, TimeSeriesXSigmaRhoMeasureSettings, TimeSeriesBetaMeasureSettings, HVaRMeasureSettings, AVaRMeasureSettings, TimeSeriesVolatilityMeasureSettings, CumsumMeasureSettings, DrawdownMeasureSettings, MovingAverageMeasureSettings, FactorMovingAverageMeasureSettings, MovingAverageRSquaredMeasureSettings, VolForecastMeasureSettings, FactorVolForecastMeasureSettings, FactorCovarianceMeasureSettings, IdiosyncraticReturnMeasureSettings, IdiosyncraticVolatilityMeasureSettings, FactorIdioMeasureSettings, ForecastBacktestMeasureSettings, BrinsonAttributionMeasureSettings, FactorAttributionMeasureSettings, PortfolioStressTestMeasureSettings, AssetStressTestMeasureSettings, AssetHoldingsMeasureSettings]]]] = []

validate_settings(settings: ReportSettings) → None

Validates if the given settings are valid for this settings menu.

Parameters

settingsSettingsType

The settings to validate.

Raises

ValidationError if a pydantic error occurs or ValueError if passed settings values are invalid.

describe(settings: ReportSettings | None = None) → str

Parameters

settingsSettingsType | None

The settings to describe. If None, then the description is not evaluated against any settings.

Returns

A human readable description of the settings menu, optionally evaluated against the given settings.