hooqu.verification_suite¶

class hooqu.verification_suite.VerificationResult(status: hooqu.checks.CheckStatus, check_results: Mapping[hooqu.checks.Check, hooqu.checks.CheckResult], metrics: Mapping[hooqu.analyzers.analyzer.Analyzer, hooqu.metrics.Metric])[source]¶

check_results: Mapping[hooqu.checks.Check, hooqu.checks.CheckResult]¶

metrics: Mapping[hooqu.analyzers.analyzer.Analyzer, hooqu.metrics.Metric]¶

status: hooqu.checks.CheckStatus¶

class hooqu.verification_suite.VerificationRunBuilder(data)[source]¶

add_check(check)[source]¶

Add a single check to the run.

Parameters: check (Check) – A check object to be executed during the run
Return type: VerificationRunBuilder

add_checks(checks)[source]¶

Add multiple checks to the run.

Parameters: checks (Sequence[Check]) – A sequence of check objects to be executed during the run
Return type: VerificationRunBuilder

run()[source]¶

Return type: VerificationResult

class hooqu.verification_suite.VerificationSuite[source]¶

add_check(check)[source]¶

Add a single check to the run.

Parameters: check (Check) – A check object to be executed during the run
Return type: VerificationSuite

add_checks(checks)[source]¶

Add multiple checks to the run.

Parameters: checks (Sequence[Check]) – A sequence of check objects to be executed during the run
Return type: VerificationSuite

do_verification_run(data, checks, required_analyzers=None, aggregate_with=None, save_states_with=None, metric_repository_options=None, file_output_options=None)[source]¶

Runs all check groups and returns the verification result. Verification result includes all the metrics computed during the run.

Parameters

data – tabular data on which the checks should be verified
checks (Sequence[Check]) – A sequence of check objects to be executed
required_analyzers (Optional[Tuple[Analyzer, …]]) – Can be used to enforce the calculation of some some metrics regardless of if there are constraints on them (optional)
aggregate_with (not implemented) – loader from which we retrieve initial states to aggregate (optional)
save_states_with (not implemented) – persist resulting states for the configured analyzers (optional)
metrics_repository_options – Options related to the MetricsRepository

Return type

VerificationResult

Returns

returns Result for every check including the overall status, detailed status
for each constraints and all metrics produced

evaluate(checks, analysis_context)[source]¶

Return type: VerificationResult

on_data(data)[source]¶

run(data)[source]¶

Runs all check groups and returns the verification result. Verification result includes all the metrics computed during the run.

Parameters: data (DataFrameLike) – tabular data on which the checks should be verified
Return type: VerificationResult