quality

Classes

CheckerConfig

Bases: ParameterizedConfigClass

HandlerConfig

Bases: ParameterizedConfigClass

ManagerConfig

Bases: BaseModel

Attributes

apply_to class-attribute instance-attribute

apply_to: List[str] = Field(
    min_items=1,
    description='The variables this quality manager should be applied to. Can be "COORDS", "DATA_VARS", or any number of individual variable names.',
)

checker class-attribute instance-attribute

checker: CheckerConfig = Field(
    description="Register a class to be used to detect and flag quality issues for the quality handler(s) registered below to handle."
)

exclude class-attribute instance-attribute

exclude: List[str] = []

handlers class-attribute instance-attribute

handlers: List[HandlerConfig] = Field(
    min_items=1,
    description="Register one or more handlers to take some action given the results of the registered checker. Each handler in this list is defined by a classname (e.g., the python import path to a QualityHandler class), and (optionally) by a parameters dictionary.",
)

name class-attribute instance-attribute

name: str = Field(
    description="A human-readable label that is used to identify this quality manager."
)

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 classmethod

validate_manager_names_are_unique(
    v: List[ManagerConfig],
) -> List[ManagerConfig]

Source code in tsdat/config/quality.py

@validator("managers")
@classmethod
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

Functions