def suite_list(directory):
"""Lists available Expectation Suites."""
context = load_data_context_with_error_handling(directory)
try:
suite_names = [
" - <cyan>{}</cyan>".format(suite_name)
for suite_name in context.list_expectation_suite_names()
]
if len(suite_names) == 0:
cli_message("No Expectation Suites found")
send_usage_message(
data_context=context, event="cli.suite.list", success=True
)
return
elif len(suite_names) == 1:
list_intro_string = "1 Expectation Suite found:"
else:
list_intro_string = "{} Expectation Suites found:".format(len(suite_names))
cli_message_list(suite_names, list_intro_string)
send_usage_message(data_context=context, event="cli.suite.list", success=True)
except Exception as e:
send_usage_message(data_context=context, event="cli.suite.list", success=False)
raise e
def checkpoint_list(directory):
"""List configured checkpoints. (Experimental)"""
context = toolkit.load_data_context_with_error_handling(directory)
checkpoints = context.list_checkpoints()
if not checkpoints:
cli_message(
"No checkpoints found.\n"
" - Use the command `great_expectations checkpoint new` to create one."
)
send_usage_message(context, event="cli.checkpoint.list", success=True)
sys.exit(0)
number_found = len(checkpoints)
plural = "s" if number_found > 1 else ""
message = f"Found {number_found} checkpoint{plural}."
pretty_list = [f" - <cyan>{cp}</cyan>" for cp in checkpoints]
cli_message_list(pretty_list, list_intro_string=message)
send_usage_message(context, event="cli.checkpoint.list", success=True)
def docs_list(directory):
"""List known Data Docs Sites."""
context = load_data_context_with_error_handling(directory)
docs_sites_url_dicts = context.get_docs_sites_urls()
docs_sites_strings = [
" - <cyan>{}</cyan>: {}".format(docs_site_dict["site_name"], docs_site_dict["site_url"])\
for docs_site_dict in docs_sites_url_dicts
]
if len(docs_sites_strings) == 0:
cli_message("No Data Docs sites found")
else:
list_intro_string = _build_intro_string(docs_sites_strings)
cli_message_list(docs_sites_strings, list_intro_string)
send_usage_message(data_context=context,
event="cli.docs.list",
success=True)
def suite_list(directory):
"""Lists available Expectation Suites."""
try:
context = DataContext(directory)
except ge_exceptions.ConfigNotFoundError as err:
cli_message("<red>{}</red>".format(err.message))
return
try:
suite_names = [
" - <cyan>{}</cyan>".format(suite_name)
for suite_name in context.list_expectation_suite_names()
]
if len(suite_names) == 0:
cli_message("No Expectation Suites found")
send_usage_message(
data_context=context,
event="cli.suite.list",
success=True
)
return
if len(suite_names) == 1:
list_intro_string = "1 Expectation Suite found:"
if len(suite_names) > 1:
list_intro_string = "{} Expectation Suites found:".format(len(suite_names))
cli_message_list(suite_names, list_intro_string)
send_usage_message(
data_context=context,
event="cli.suite.list",
success=True
)
except Exception as e:
send_usage_message(
data_context=context,
event="cli.suite.list",
success=False
)
raise e
def docs_list(directory):
"""List known Data Docs Sites."""
context = toolkit.load_data_context_with_error_handling(directory)
docs_sites_url_dicts = context.get_docs_sites_urls()
docs_sites_strings = [
" - <cyan>{}</cyan>: {}".format(
docs_site_dict["site_name"],
docs_site_dict.get("site_url")
or f"site configured but does not exist. Run the following command to build site: great_expectations "
f'docs build --site-name {docs_site_dict["site_name"]}',
)
for docs_site_dict in docs_sites_url_dicts
]
if len(docs_sites_strings) == 0:
cli_message("No Data Docs sites found")
else:
list_intro_string = _build_intro_string(docs_sites_strings)
cli_message_list(docs_sites_strings, list_intro_string)
send_usage_message(data_context=context, event="cli.docs.list", success=True)
def docs_list(directory):
"""List known Data Docs Sites."""
context = None
try:
failed = True
context = DataContext(directory)
docs_sites_url_dicts = context.get_docs_sites_urls()
docs_sites_strings = [
" - <cyan>{}</cyan>: {}".format(docs_site_dict["site_name"], docs_site_dict["site_url"])\
for docs_site_dict in docs_sites_url_dicts
]
if len(docs_sites_strings) == 0:
cli_message("No Data Docs sites found")
failed = False
send_usage_message(data_context=context,
event="cli.docs.list",
success=True)
return
if len(docs_sites_strings) == 1:
list_intro_string = "1 Data Docs site found:"
if len(docs_sites_strings) > 1:
list_intro_string = "{} Data Docs sites found:".format(
len(docs_sites_strings))
cli_message_list(docs_sites_strings, list_intro_string)
failed = False
send_usage_message(data_context=context,
event="cli.docs.list",
success=True)
except ge_exceptions.ConfigNotFoundError as err:
cli_message("<red>{}</red>".format(err.message))
finally:
if failed and context is not None:
send_usage_message(data_context=context,
event="cli.docs.list",
success=False)
