bayesline.api.Registry#
- class bayesline.api.Registry#
Abstract base class for writable registries.
- __init__()#
Methods
__init__()delete(name)Delete an item from the registry.
get(name)Get an item by name or ID.
get_all()Get all valid available settings.
get_all_metadata()Get all available settings metadata.
get_all_with_metadata()Get all valid available settings with metadata.
get_metadata(name)Get metadata for an item by name or ID.
get_raw(name_or_id)Get raw settings by names or IDs.
ids([mode])Get mapping of IDs to names.
names([mode])Get mapping of names to IDs.
save(name, settings)Save an item to the registry.
update(name, settings)Update an existing item in the registry.
- abstract save(name: str, settings: T) int#
Save an item to the registry.
Parameters#
- namestr
The unique name of the item to save. The name cannot be all numbers.
- settingsT
The item to save.
Raises#
- ValueError
If the item name already exists or is all numbers.
Returns#
- int
A unique identifier for the saved item.
- abstract update(name: str | int, settings: T) RawSettings#
Update an existing item in the registry.
Parameters#
- namestr | int
The unique name or int identifier of the item to update.
- settingsT
The item to update.
Raises#
- KeyError
If the item does not exist.
Returns#
- RawSettings
The previous raw settings item for the given name.