ExpectationSuiteValidationResult

Signature

class great_expectations.core.ExpectationSuiteValidationResult(
 success: bool,
 results: list[great_expectations.core.expectation_validation_result.ExpectationValidationResult],
 suite_name: str,
 suite_parameters: Optional[dict] = None,
 statistics: Optional[dict] = None,
 meta: Optional[Union[great_expectations.core.expectation_validation_result.ExpectationSuiteValidationResultMeta,
 dict]] = None,
 batch_id: Optional[str] = None,
 result_url: Optional[str] = None,
 id: Optional[str] = None
)

The result of a batch of data validated against an Expectation Suite.

When a Checkpoint is run, it produces an instance of this class. The primary property of this class is results, which contains the individual ExpectationValidationResult instances which were produced by the Checkpoint run.

ExpectationSuiteValidationResult.success will be True if all Expectations passed, otherwise it will be False.

ExpectationSuiteValidationResult.statistics contains information about the Checkpoint run.:

{
  "evaluated_expectations": 14,
  "success_percent": 71.42857142857143,
  "successful_expectations": 10,
  "unsuccessful_expectations": 4
}

The meta property is an instance of ExpectationSuiteValidationResultMeta, and contains information identifying the resources used during the Checkpoint run.:

{
  "active_batch_definition": {
    "batch_identifiers": {},
    "data_asset_name": "taxi_data_1.csv",
    "data_connector_name": "default_inferred_data_connector_name",
    "datasource_name": "pandas"
  },
  "batch_markers": {
    "ge_load_time": "20220727T154327.630107Z",
    "pandas_data_fingerprint": "c4f929e6d4fab001fedc9e075bf4b612"
  },
  "batch_spec": {
    "path": "/Users/username/work/gx_example_projects/great_expectations/../data/taxi_data_1.csv"
  },
  "checkpoint_name": "single_validation_checkpoint",
  "expectation_suite_name": "taxi_suite_1",
  "great_expectations_version": "0.15.15",
  "run_id": {
    "run_name": "20220727-114327-my-run-name-template",
    "run_time": "2022-07-27T11:43:27.625252+00:00"
  },
  "validation_time": "20220727T154327.701100Z"
}

Parameters

Name	Description
success	Boolean indicating the success or failure of this collection of results, or None.
results	List of ExpectationValidationResults, or None.
suite_parameters	Dict of Suite Parameters used to produce these results, or None.
statistics	Dict of values describing the results.
meta	Instance of ExpectationSuiteValidationResult, a Dict of meta values, or None.
batch_id	A unique identifier for the batch of data that was validated.
result_url	A URL where the results are stored.

Methods

describe

Signature

describe() → str

JSON string description of this ExpectationSuiteValidationResult

get_max_severity_failure

Signature

get_max_severity_failure() → FailureSeverity | None

Get the maximum severity failure for Expectations in the validation result.

Returns the maximum severity level among failed expectations. The severity levels are ordered as: CRITICAL > WARNING > INFO. If no failures exist, returns None.

Returns

Type	Description
FailureSeverity | None	The maximum severity failure level, or None if no failures exist.

to_json_dict

Signature

to_json_dict()

Returns a JSON-serializable dict representation of this ExpectationSuiteValidationResult.

Returns

A JSON-serializable dict representation of this ExpectationSuiteValidationResult.