bayesline.api.equity.UniverseSettingsMenu#

model UniverseSettingsMenu#

Contain the available settings that can be used for the universe settings.

Fields#
Field	Type	Required
`calendar_settings_menu`	`CalendarSettingsMenu`	Yes
`categorical_hierarchies`	`Mapping`[`str`, `Hierarchy`]	Yes
`categorical_hierarchies_labels`	`Mapping`[`str`, `Mapping`[`str`, `str`]]	Yes
`id_types`	`list`[`str`]	Yes

Validators#
Validator	Mode	Fields
`check_all_codes_have_labels`	after	model
`check_no_empty_branches`	after	`categorical_hierarchies`
`check_unique_hierarchy`	after	`categorical_hierarchies`

field calendar_settings_menu: CalendarSettingsMenu [Required]#

The calendar settings menu to use for the universe.

Validated by:: check_all_codes_have_labels

field categorical_hierarchies: Mapping[str, Hierarchy] [Required]#

A dictionary where the key is the name of the categorical hierarchy (e.g. ‘trbc’) and the value is a N-level nested dictionary structure of the categorical hierarchy codes.

Validated by:: check_all_codes_have_labels check_no_empty_branches check_unique_hierarchy

field categorical_hierarchies_labels: Mapping[str, Mapping[str, str]] [Required]#

A dictionary where the key is the name of the categorical hierarchy and the value is a mapping from unique categorical code to a human readable name.

Validated by:: check_all_codes_have_labels

field id_types: list[str] [Required]#

A list of all the id types that are supported for the universe.

Validated by:: check_all_codes_have_labels

validator check_all_codes_have_labels(mode=after)#

Validates:: entire model

validator check_no_empty_branches(mode=after)#

Validates:: categorical_hierarchies

validator check_unique_hierarchy(mode=after)#

Validates:: categorical_hierarchies