atef.config.ConfigurationGroup

class atef.config.ConfigurationGroup(name: str | None = None, description: str | None = None, tags: ~typing.List[str] | None = None, configs: ~typing.List[~atef.config.Configuration] = <factory>, values: ~typing.Dict[str, ~typing.Any] = <factory>, mode: ~atef.enums.GroupResultMode = GroupResultMode.all_)[source]

Configuration group.

Attributes:

description
name
tags

Methods

`children`()	Return children of this group, as a tree view might expect
`replace_comparison`(old_comp, new_comp[, ...])	Replace `old_comp` with `new_comp` in this dataclass, wherever it is.

move_comparison
walk_configs

Methods

__init__(name: str | None = None, description: str | None = None, tags: ~typing.List[str] | None = None, configs: ~typing.List[~atef.config.Configuration] = <factory>, values: ~typing.Dict[str, ~typing.Any] = <factory>, mode: ~atef.enums.GroupResultMode = GroupResultMode.all_) → None

children() → List[Configuration][source]: Return children of this group, as a tree view might expect

move_comparison(comp: Comparison, new_attr: str, comp_attrs: List[str]) → None

replace_comparison(old_comp: Comparison, new_comp: Comparison, comp_attrs: List[str] | None = None) → None

Replace old_comp with new_comp in this dataclass, wherever it is. Looks through shared, then any of the attributes in comp_attrs

Parameters:

old_compComparison: Comparison to be replaced
new_compComparison: Comparison to replace old_comp with
comp_attrsOptional[List[str]], optional: Attribute names in the dataclass to check, by default None

walk_configs() → Generator[PVConfiguration | DeviceConfiguration | ToolConfiguration | ConfigurationGroup | TemplateConfiguration, None, None][source]

Attributes

description: str | None = None: Description tied to this configuration.

mode: GroupResultMode = 'all': Result mode.

name: str | None = None: Name tied to this configuration.

tags: List[str] | None = None: Tags tied to this configuration.

configs: List[Configuration]: Configurations underneath this group.

values: Dict[str, Any]: Values that can be reused in comparisons underneath this group.