[ENHANCEMENT] CLI init command implemented for v3 api
#2626
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # docs/changelog.rst
Aylr
suggested changes
Mar 30, 2021
Comment on lines
-44
to
-49
| @click.option( | ||
| # Note this --no-view option is mostly here for tests | ||
| "--view/--no-view", | ||
| help="By default open in browser unless you specify the --no-view flag.", | ||
| default=True, | ||
| ) |
Comment on lines
-115
to
-202
| # Skip the rest of setup if --assume-yes flag is passed | ||
| if ctx.obj.assume_yes: | ||
| cli_message(SECTION_SEPARATOR) | ||
| cli_message(SETUP_SUCCESS) | ||
| sys.exit(0) | ||
|
|
||
| try: | ||
| # if expectations exist, offer to build docs | ||
| context = DataContext(ge_dir) | ||
| if context.list_expectation_suites(): | ||
| if click.confirm(BUILD_DOCS_PROMPT, default=True): | ||
| build_docs(context, view=view) | ||
|
|
||
| else: | ||
| datasources = context.list_datasources() | ||
| if len(datasources) == 0: | ||
| cli_message(SECTION_SEPARATOR) | ||
| if not click.confirm( | ||
| "Would you like to configure a Datasource?", default=True | ||
| ): | ||
| cli_message("Okay, bye!") | ||
| sys.exit(1) | ||
| datasource_name, data_source_type = add_datasource_impl( | ||
| context, choose_one_data_asset=False | ||
| ) | ||
| if not datasource_name: # no datasource was created | ||
| sys.exit(1) | ||
|
|
||
| datasources = context.list_datasources() | ||
| if len(datasources) == 1: | ||
| datasource_name = datasources[0]["name"] | ||
|
|
||
| cli_message(SECTION_SEPARATOR) | ||
| if not click.confirm( | ||
| "Would you like to profile new Expectations for a single data asset within your new Datasource?", | ||
| default=True, | ||
| ): | ||
| cli_message( | ||
| "Okay, exiting now. To learn more about Profilers, run great_expectations profile --help or visit docs.greatexpectations.io!" | ||
| ) | ||
| sys.exit(1) | ||
|
|
||
| ( | ||
| success, | ||
| suite_name, | ||
| profiling_results, | ||
| ) = toolkit.create_expectation_suite( | ||
| context, | ||
| datasource_name=datasource_name, | ||
| additional_batch_kwargs={"limit": 1000}, | ||
| flag_build_docs=False, | ||
| open_docs=False, | ||
| ) | ||
|
|
||
| cli_message(SECTION_SEPARATOR) | ||
| if not click.confirm( | ||
| "Would you like to build Data Docs?", default=True | ||
| ): | ||
| cli_message( | ||
| "Okay, exiting now. To learn more about Data Docs, run great_expectations docs --help or visit docs.greatexpectations.io!" | ||
| ) | ||
| sys.exit(1) | ||
|
|
||
| build_docs(context, view=False) | ||
|
|
||
| if not click.confirm( | ||
| "\nWould you like to view your new Expectations in Data Docs? This will open a new browser window.", | ||
| default=True, | ||
| ): | ||
| cli_message( | ||
| "Okay, exiting now. You can view the site that has been created in a browser, or visit docs.greatexpectations.io for more information!" | ||
| ) | ||
| sys.exit(1) | ||
| toolkit.attempt_to_open_validation_results_in_data_docs( | ||
| context, profiling_results | ||
| ) | ||
|
|
||
| cli_message(SECTION_SEPARATOR) | ||
| cli_message(SETUP_SUCCESS) | ||
| sys.exit(0) | ||
| except ( | ||
| DataContextError, | ||
| ge_exceptions.ProfilerError, | ||
| OSError, | ||
| SQLAlchemyError, | ||
| ) as e: | ||
| cli_message("<red>{}</red>".format(e)) | ||
| sys.exit(1) |
| ), | ||
| ] | ||
|
|
||
| # Assertions to make sure we didn't regress to v2 API |
tests/cli/test_init.py
Outdated
| [ | ||
| ("--v3-api init", "Y\n"), | ||
| ("--v3-api --assume-yes init", ""), | ||
| ], | ||
| ) | ||
| @mock.patch("webbrowser.open", return_value=True, side_effect=None) |
There was a problem hiding this comment.
Nitpick: Since init is so much simpler now we can remove the mock webbrowser and all it's assertions for maintainability in this an other init tests.
There was a problem hiding this comment.
I was leaving this in as a check on regression - but I think it's pretty safe to remove them and will probably speed up the tests so 👍
tests/cli/test_init.py
Outdated
Comment on lines
122
to
329
| not yet have an uncommitted directory. | ||
| """ | ||
| root_dir: str = str(tmp_path_factory.mktemp("hiya")) | ||
| root_dir_path = tmp_path / "hiya" | ||
| root_dir_path.mkdir() | ||
| root_dir = str(root_dir_path) | ||
| data_folder_path = os.path.join(root_dir, "data") | ||
| os.makedirs(os.path.join(root_dir, "data")) | ||
| data_folder_path: str = os.path.join(root_dir, "data") | ||
| data_path: str = os.path.join(root_dir, "data", "Titanic.csv") | ||
| data_path: str = os.path.join(data_folder_path, "Titanic.csv") | ||
| fixture_path: str = file_relative_path( | ||
| __file__, os.path.join("..", "test_sets", "Titanic.csv") | ||
| ) |
There was a problem hiding this comment.
Nitpick: we don't need data fixtures for all init tests. Let's remove them for simplicity.
Aylr
approved these changes
Mar 31, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request:
great_expectations initcommand for v3 (Batch Request) APIinitCLI but instead creates the project configuration folder structure and example files, eliminating the interactivity.--viewoption