great_expectations.cli.suite

Module Contents

Functions

suite(ctx)

Expectation Suite operations

suite_new(ctx, expectation_suite, interactive_flag, manual_flag, profile, batch_request, no_jupyter)

Create a new empty Expectation Suite.

_process_suite_new_flags_and_prompt(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, profile: bool, batch_request: Optional[str] = None)

Process various optional suite new flags and prompt if there is not enough information from the flags.

_suite_new_workflow(context: DataContext, expectation_suite_name: str, interactive: bool, profile: bool, no_jupyter: bool, usage_event: str, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None)

suite_edit(ctx, expectation_suite, interactive_flag, manual_flag, datasource_name, batch_request, no_jupyter)

Generate a Jupyter notebook for editing an existing Expectation Suite.

_process_suite_edit_flags_and_prompt(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, datasource_name: Optional[str] = None, batch_request: Optional[str] = None)

Process various optional suite edit flags and prompt if there is not enough information from the flags.

_suite_edit_workflow(context: DataContext, expectation_suite_name: str, profile: bool, usage_event: str, interactive: bool, no_jupyter: bool, create_if_not_exist: Optional[bool] = False, datasource_name: Optional[str] = None, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None, additional_batch_request_args: Optional[Dict[str, Union[str, int, Dict[str, Any]]]] = None, suppress_usage_message: Optional[bool] = False, assume_yes: Optional[bool] = False)

suite_demo(ctx)

This command is not supported in the v3 (Batch Request) API.

suite_delete(ctx, suite)

Delete an expectation suite from the expectation store.

suite_list(ctx)

Lists available Expectation Suites.

_get_notebook_path(context, notebook_name)

great_expectations.cli.suite.SQLAlchemyError
great_expectations.cli.suite.suite(ctx)

Expectation Suite operations

great_expectations.cli.suite.suite_new(ctx, expectation_suite, interactive_flag, manual_flag, profile, batch_request, no_jupyter)

Create a new empty Expectation Suite. Edit in jupyter notebooks, or skip with the –no-jupyter flag.

great_expectations.cli.suite._process_suite_new_flags_and_prompt(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, profile: bool, batch_request: Optional[str] = None) → Dict[str, Optional[bool]]

Process various optional suite new flags and prompt if there is not enough information from the flags. :param context: Data Context for use in sending error messages if any :param usage_event_end: event name for ending usage stats message :param interactive_flag: –interactive from the suite new CLI command :param manual_flag: –manual from the suite new CLI command :param profile: –profile from the suite new CLI command :param batch_request: –batch-request from the suite new CLI command

Returns

Dictionary with keys of processed parameters and boolean values e.g. {“interactive”: True, “profile”: False}

great_expectations.cli.suite._suite_new_workflow(context: DataContext, expectation_suite_name: str, interactive: bool, profile: bool, no_jupyter: bool, usage_event: str, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None)
great_expectations.cli.suite.suite_edit(ctx, expectation_suite, interactive_flag, manual_flag, datasource_name, batch_request, no_jupyter)

Generate a Jupyter notebook for editing an existing Expectation Suite.

The SUITE argument is required. This is the name you gave to the suite when you created it.

The edit command will help you specify a batch interactively. Or you can specify them manually by providing –batch-request in valid JSON format.

Read more about specifying batches of data in the documentation: https://docs.greatexpectations.io/

great_expectations.cli.suite._process_suite_edit_flags_and_prompt(context: DataContext, usage_event_end: str, interactive_flag: bool, manual_flag: bool, datasource_name: Optional[str] = None, batch_request: Optional[str] = None) → bool

Process various optional suite edit flags and prompt if there is not enough information from the flags. :param context: Data Context for use in sending error messages if any :param usage_event_end: event name for ending usage stats message :param interactive_flag: –interactive from the suite new CLI command :param manual_flag: –manual from the suite new CLI command :param datasource_name: –datasource-name from the suite new CLI command :param batch_request: –batch-request from the suite new CLI command

Returns

boolean of whether to enter interactive mode

great_expectations.cli.suite._suite_edit_workflow(context: DataContext, expectation_suite_name: str, profile: bool, usage_event: str, interactive: bool, no_jupyter: bool, create_if_not_exist: Optional[bool] = False, datasource_name: Optional[str] = None, batch_request: Optional[Union[str, Dict[str, Union[str, int, Dict[str, Any]]]]] = None, additional_batch_request_args: Optional[Dict[str, Union[str, int, Dict[str, Any]]]] = None, suppress_usage_message: Optional[bool] = False, assume_yes: Optional[bool] = False)
great_expectations.cli.suite.suite_demo(ctx)

This command is not supported in the v3 (Batch Request) API.

great_expectations.cli.suite.suite_delete(ctx, suite)

Delete an expectation suite from the expectation store.

great_expectations.cli.suite.suite_list(ctx)

Lists available Expectation Suites.

great_expectations.cli.suite._get_notebook_path(context, notebook_name)