ExpectationSuite

Signature

class great_expectations.ExpectationSuite(
 name: Optional[str] = None,
 expectations: Optional[Sequence[Union[dict,
 ExpectationConfiguration,
 Expectation]]] = None,
 suite_parameters: Optional[dict] = None,
 meta: Optional[dict] = None,
 notes: str | list[str] | None = None,
 id: Optional[str] = None
)

Set-like collection of Expectations.

Parameters

Name	Description
name	Name of the Expectation Suite
expectations	Expectation Configurations to associate with this Expectation Suite.
suite_parameters	Suite parameters to be substituted when evaluating Expectations.
meta	Metadata related to the suite.
id	Great Expectations Cloud id for this Expectation Suite.

Methods

add_expectation

Signature

add_expectation(
 expectation: _TExpectation
) → _TExpectation

Add an Expectation to the collection.

delete_expectation

Signature

delete_expectation(
 expectation: Expectation
) → Expectation

Delete an Expectation from the collection.

Example

>>> suite.delete_expectation(suite.expectations[0])

Raises

Type	Description
KeyError	Expectation not found in suite.

save

Signature

save() → None

Save this ExpectationSuite.

to_json_dict

Signature

to_json_dict() → Dict[str,
 JSONValues]

Returns a JSON-serializable dict representation of this ExpectationSuite.

Returns

Type	Description
Dict[str, JSONValues]	A JSON-serializable dict representation of this ExpectationSuite.