bayesline.api.equity.CalendarSettingsMenu

pydantic model bayesline.api.equity.CalendarSettingsMenu

Contains the available settings that can be used for the calendar settings.

Show JSON schema

{
   "title": "CalendarSettingsMenu",
   "description": "Contains the available settings that can be used for the calendar settings.",
   "type": "object",
   "properties": {
      "exchanges": {
         "description": "\n        A list of mic codes of all exchanges. Must be sorted and unique.\n        ",
         "items": {
            "type": "string"
         },
         "title": "Exchanges",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "exchanges"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• exchanges (list[str])

field exchanges: Annotated[list[str]] [Required]

A list of mic codes of all exchanges. Must be sorted and unique.

Constraints:

• func = <function require_sorted_unique at 0x7ff51ab19800>

describe(settings: CalendarSettings | 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.

validate_settings(settings: CalendarSettings) → None

Validates the given calendar settings against the available settings.

Will raise an ValueError if settings are invalid.

Parameters

settings: CalendarSettings

the calendar settings to validate against.