atef.config.Configuration

class atef.config.Configuration(name: str | None = None, description: str | None = None, tags: List[str] | None = None)[source]

Configuration base class for shared settings between all configurations.

Subclasses of Comparison will be serialized as a tagged union. This means that the subclass name will be used as an identifier for the generated serialized dictionary (and JSON object).

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

Methods

__init__(name: str | None = None, description: str | None = None, tags: List[str] | None = None) → None

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

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

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

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

Attributes

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

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

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