bayesline.api.SettingsMenu

pydantic model bayesline.api.SettingsMenu

Abstract base class for settings menus.

Show JSON schema

{
   "title": "SettingsMenu",
   "description": "Abstract base class for settings menus.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

abstract describe() → str

Describe the settings menu.

Returns

str

A human readable description of the settings menu.

map_references(fn: Callable[[str | int], str | int]) → Self

Return a copy with every reference-list entry rewritten by fn.

The menu-side counterpart of Settings.map_references(). A menu enumerates the settings/datasets/sources a user may reference; this applies fn to those enumerated references (leaving plain system-data fields untouched) so a caller can translate a menu between reference namespaces. The base implementation has no reference fields and returns self unchanged; menus that carry reference lists override it.

Parameters

fnCallable[[str | int], str | int]

Applied to each enumerated reference. Must preserve a reference’s kind (a name stays a name, an id stays an id).

Returns

Self

A copy with reference-list entries rewritten.