great_expectations.checkpoint.checkpoint

Module Contents

Classes

BaseCheckpoint(checkpoint_config: CheckpointConfig, data_context: DataContext)

BaseCheckpoint class is initialized from CheckpointConfig typed object and contains all functionality

Checkpoint(name: str, data_context: DataContext, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, expectation_suite_ge_cloud_id: Optional[UUID] = None)

LegacyCheckpoint(name: str, data_context, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None)

SimpleCheckpoint(name: str, data_context, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, site_names: Union[str, List[str]] = ‘all’, slack_webhook: Optional[str] = None, notify_on: str = ‘all’, notify_with: Union[str, List[str]] = ‘all’, expectation_suite_ge_cloud_id: Optional[str] = None, **kwargs)

great_expectations.checkpoint.checkpoint.logger
class great_expectations.checkpoint.checkpoint.BaseCheckpoint(checkpoint_config: CheckpointConfig, data_context: DataContext)

Bases: great_expectations.core.config_peer.ConfigPeer

BaseCheckpoint class is initialized from CheckpointConfig typed object and contains all functionality in the form of interface methods (which can be overwritten by subclasses) and their reference implementation.

run(self, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, run_id: Optional[Union[str, RunIdentifier]] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[Union[str, dict]] = None, expectation_suite_ge_cloud_id: Optional[str] = None)
get_substituted_config(self, runtime_kwargs: Optional[dict] = None)
_get_substituted_template(self, source_config: dict)
_get_substituted_runtime_kwargs(self, source_config: dict, runtime_kwargs: Optional[dict] = None)
_substitute_config_variables(self, config: dict)
_run_validation(self, substituted_runtime_config: dict, async_validation_operator_results: List[AsyncResult], async_executor: AsyncExecutor, result_format: Optional[dict], run_id: Optional[Union[str, RunIdentifier]], idx: Optional[int] = 0, validation_dict: Optional[dict] = None)
self_check(self, pretty_print=True)
property config(self)
property name(self)
property config_version(self)
property action_list(self)
property validations(self)
property ge_cloud_id(self)
property data_context(self)
__repr__(self)

Return repr(self).

class great_expectations.checkpoint.checkpoint.Checkpoint(name: str, data_context: DataContext, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, expectation_suite_ge_cloud_id: Optional[UUID] = None)

Bases: great_expectations.checkpoint.checkpoint.BaseCheckpoint

class great_expectations.checkpoint.checkpoint.LegacyCheckpoint(name: str, data_context, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None)

Bases: great_expectations.checkpoint.checkpoint.Checkpoint

Feature Maturity

icon-bfa99f0e99cf11ecaf600242ac110002 LegacyCheckpoint - Notebook - How-to Guide
Run a configured Checkpoint from a notebook.
Maturity: Experimental (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Complete
Unit Test Coverage: Partial (“golden path”-focused tests; error checking tests need to be improved)
Integration Infrastructure/Test Coverage: N/A
Documentation Completeness: Complete
Bug Risk: Low
icon-bfa9a1c099cf11ecaf600242ac110002 LegacyCheckpoint - Command Line - How-to Guide
Run a configured checkpoint from a command line in a Terminal shell.
Maturity: Experimental (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Complete
Unit Test Coverage: Complete
Integration Infrastructure/Test Coverage: N/A
Documentation Completeness: Complete
Bug Risk: Low
icon-bfa9a33299cf11ecaf600242ac110002 LegacyCheckpoint - Cron - How-to Guide
Use the Unix crontab command to edit the cron file and add a line that will run Checkpoint as a scheduled task.
Maturity: Experimental (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Complete
Unit Test Coverage: Complete
Integration Infrastructure/Test Coverage: N/A
Documentation Completeness: Complete
Bug Risk: Low
icon-bfa9a47299cf11ecaf600242ac110002 LegacyCheckpoint - Airflow DAG - How-to Guide
Running a configured Checkpoint in Apache Airflow enables the triggering of data validation using an Expectation Suite directly within an Airflow DAG.
Maturity: Beta (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Partial (no operator, but probably don’t need one)
Unit Test Coverage: N/A
Integration Infrastructure/Test Coverage: Minimal
Documentation Completeness: Complete (pending how-to)
Bug Risk: Low
icon-bfa9a5b299cf11ecaf600242ac110002 LegacyCheckpoint - Kedro - How-to Guide
TODO: LegacyCheckpoint - Kedro Description
Maturity: Experimental (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Unknown
Unit Test Coverage: Unknown
Integration Infrastructure/Test Coverage: Unknown
Documentation Completeness: Minimal (none)
Bug Risk: Unknown
icon-bfa9a6fc99cf11ecaf600242ac110002 LegacyCheckpoint - Prefect - How-to Guide
TODO: LegacyCheckpoint - Prefect Description
Maturity: Experimental (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Unknown
Unit Test Coverage: Unknown
Integration Infrastructure/Test Coverage: Unknown
Documentation Completeness: Minimal (none)
Bug Risk: Unknown
icon-bfa9a85a99cf11ecaf600242ac110002 LegacyCheckpoint - DBT - How-to Guide
TODO: LegacyCheckpoint - DBT Description
Maturity: Beta (to-be-deprecated in favor of Checkpoint)
Details:
API Stability: to-be-deprecated in favor of Checkpoint
Implementation Completeness: Minimal
Unit Test Coverage: Minimal (none)
Integration Infrastructure/Test Coverage: Minimal (none)
Documentation Completeness: Minimal (none)
Bug Risk: Low
property validation_operator_name(self)
property batches(self)
_run_default_validation_operator(self, assets_to_validate: List, run_id: Optional[Union[str, RunIdentifier]] = None, evaluation_parameters: Optional[dict] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[Union[str, dict]] = None)
run(self, run_id=None, evaluation_parameters=None, run_name=None, run_time=None, result_format=None, **kwargs)
_get_batches_to_validate(self, batches)
class great_expectations.checkpoint.checkpoint.SimpleCheckpoint(name: str, data_context, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, site_names: Union[str, List[str]] = 'all', slack_webhook: Optional[str] = None, notify_on: str = 'all', notify_with: Union[str, List[str]] = 'all', expectation_suite_ge_cloud_id: Optional[str] = None, **kwargs)

Bases: great_expectations.checkpoint.checkpoint.Checkpoint

_configurator_class
run(self, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, run_id: Optional[Union[str, RunIdentifier]] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[str] = None, site_names: Union[str, List[str]] = 'all', slack_webhook: Optional[str] = None, notify_on: str = 'all', notify_with: Union[str, List[str]] = 'all', expectation_suite_ge_cloud_id: Optional[str] = None)