Skip to content

quality_config

Classes#

QualityConfig #

Bases: YamlModel

Contains quality configuration parameters for tsdat pipelines.

This class will ultimately be converted into a tsdat.qc.base.QualityManagement class for use in downstream tsdat pipeline code.

Provides methods to support yaml parsing and validation, including the generation of json schema for immediate validation.

Parameters:

Name Type Description Default
managers List[ManagerConfig]

A list of quality checks and controls that should be applied.

 required

Attributes#

managers class-attribute instance-attribute #
managers: List[ManagerConfig] = Field(
    description="Register a list of QualityManager(s) that should be used to detect and handle data quality issues. Each QualityManager configuration block must consists of a label, a QualityChecker, at least one QualityHandler, and a list of variables that the manager should be applied to."
)

Functions#

validate_manager_names_are_unique #
validate_manager_names_are_unique(
    v: List[ManagerConfig],
) -> List[ManagerConfig]
Source code in tsdat/config/quality/quality_config.py 
31
32
33
34
35
36
37
@validator("managers")
def validate_manager_names_are_unique(
    cls, v: List[ManagerConfig]
) -> List[ManagerConfig]:
    if duplicates := find_duplicates(v):
        raise ValueError(f"Duplicate quality manager names found: {duplicates}")
    return v

Modules#