lir.config.aggregation module

lir.config.aggregation.parse_aggregation(config: ContextAwareDict | str, output_dir: Path, context: list[str] | None = None) → Aggregation[source]

Parse a configuration section for output aggregation.

If config is a dictionary, the method property is the aggregation method that is looked up in the registry. Other properties are passed as parameters. If config is a str, then its value is the aggregation method, and it has no parameters.

Parameters:

  • config (ContextAwareDict | str) – The configuration as a dictionary or string.

  • output_dir (Path) – Output directory where derived artefacts are written.

  • context (list[str] | None, optional) – Context for error reporting when config is provided as a string.

Returns:

Parsed aggregation instance.

Return type:

Aggregation

lir.config.aggregation.parse_aggregations(config: ContextAwareList | ContextAwareDict | str, output_dir: Path, context: list[str] | None = None) → list[Aggregation][source]

Parse a list of configurations for aggregation.

Parameters:

  • config (ContextAwareList | ContextAwareDict | str) – Configuration for a single aggregation or a list of aggregation configurations.

  • output_dir (Path) – Output directory for the aggregation instances.

  • context (list[str] | None, optional) – Context for error reporting when config is provided as a string.

Returns:

Parsed aggregation instances.

Return type:

list[Aggregation]