navigate.config.configuration_schema.CollectionSpec

class navigate.config.configuration_schema.CollectionSpec(item_schema: Mapping[str, SettingSpec], storage: str = 'mapping', key_field: str = 'name', value_field: str = 'value', storage_fields: Optional[Tuple[str, ...]] = None, label: Optional[str] = None, help_text: Optional[str] = None, dynamic_source: Optional[str] = None, minimum_items: int = 0, none_option_label: Optional[str] = None)

Bases: object

Description of a repeatable group of persisted configuration values.

storage='mapping' stores rows as a YAML mapping, using key_field as the mapping key and value_field as its value. storage='parallel_mappings' stores selected row fields as separate YAML mappings keyed by key_field. storage='nested_mapping' stores calibration rows as solvent -> axis -> zoom -> position. storage='single_mapping' stores one fixed mapping using the item schema keys as fields. dynamic_source identifies collection fields that should be resolved at render time.

__init__(item_schema: Mapping[str, SettingSpec], storage: str = 'mapping', key_field: str = 'name', value_field: str = 'value', storage_fields: Optional[Tuple[str, ...]] = None, label: Optional[str] = None, help_text: Optional[str] = None, dynamic_source: Optional[str] = None, minimum_items: int = 0, none_option_label: Optional[str] = None) → None

Methods

__init__(item_schema[, storage, key_field, ...])

Attributes

dynamic_source
help_text
key_field
label
minimum_items
none_option_label
storage
storage_fields
value_field
item_schema