feat: add progress bar for to_arrow method #352
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,106 @@ | ||||||||
| # Copyright 2019 Google LLC | ||||||||
| # | ||||||||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||||||||
| # you may not use this file except in compliance with the License. | ||||||||
| # You may obtain a copy of the License at | ||||||||
| # | ||||||||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||||||||
| # | ||||||||
| # Unless required by applicable law or agreed to in writing, software | ||||||||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||||||||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||||
| # See the License for the specific language governing permissions and | ||||||||
| # limitations under the License. | ||||||||
|
|
||||||||
| """Shared helper functions for tqdm progress bar.""" | ||||||||
|
|
||||||||
| import concurrent.futures | ||||||||
| import time | ||||||||
| import warnings | ||||||||
|
|
||||||||
| try: | ||||||||
| import tqdm | ||||||||
| except ImportError: # pragma: NO COVER | ||||||||
| tqdm = None | ||||||||
|
|
||||||||
| _NO_TQDM_ERROR = ( | ||||||||
| "A progress bar was requested, but there was an error loading the tqdm " | ||||||||
| "library. Please install tqdm to use the progress bar functionality." | ||||||||
| ) | ||||||||
|
|
||||||||
| _PROGRESS_BAR_UPDATE_INTERVAL = 0.5 | ||||||||
|
|
||||||||
|
|
||||||||
| def _get_progress_bar(progress_bar_type, description, total, unit): | ||||||||
| """Construct a tqdm progress bar object, if tqdm is installed.""" | ||||||||
| if tqdm is None: | ||||||||
| if progress_bar_type is not None: | ||||||||
| warnings.warn(_NO_TQDM_ERROR, UserWarning, stacklevel=3) | ||||||||
| return None | ||||||||
|
|
||||||||
| try: | ||||||||
| if progress_bar_type == "tqdm": | ||||||||
| return tqdm.tqdm(desc=description, total=total, unit=unit) | ||||||||
| elif progress_bar_type == "tqdm_notebook": | ||||||||
| return tqdm.tqdm_notebook(desc=description, total=total, unit=unit) | ||||||||
| elif progress_bar_type == "tqdm_gui": | ||||||||
| return tqdm.tqdm_gui(desc=description, total=total, unit=unit) | ||||||||
| except (KeyError, TypeError): | ||||||||
| # Protect ourselves from any tqdm errors. In case of | ||||||||
| # unexpected tqdm behavior, just fall back to showing | ||||||||
| # no progress bar. | ||||||||
| warnings.warn(_NO_TQDM_ERROR, UserWarning, stacklevel=3) | ||||||||
| return None | ||||||||
|
|
||||||||
|
|
||||||||
| def _query_job_result_helper(query_job, progress_bar_type=None): | ||||||||
|
There was a problem hiding this comment. Let's use active verbs in this helper name.
Suggested change
|
||||||||
| """Return query result and display a progress bar while the query running, if tqdm is installed.""" | ||||||||
| if progress_bar_type: | ||||||||
|
There was a problem hiding this comment. We can reduce the level of indentation if we exit early. Also, I think we'll want to pass through some keyword arguments to
Suggested change
Aside (not relevant for this PR): we'll eventually want to pass additional arguments to |
||||||||
| start_time = time.time() | ||||||||
| progress_bar = _get_progress_bar( | ||||||||
| progress_bar_type, "Query is running", 1, "query" | ||||||||
| ) | ||||||||
| if query_job.query_plan: | ||||||||
|
There was a problem hiding this comment. This should be one level deeper. I'd like to see the |
||||||||
| i = 0 | ||||||||
| while True: | ||||||||
| total = len(query_job.query_plan) | ||||||||
| query_job.reload() # Refreshes the state via a GET request. | ||||||||
|
There was a problem hiding this comment. Wouldn't we only want to call Also, why would we only call |
||||||||
| current_stage = query_job.query_plan[i] | ||||||||
| progress_bar.total = len(query_job.query_plan) | ||||||||
| progress_bar.set_description( | ||||||||
| "Query executing stage {} and status {} : {:0.2f}s".format( | ||||||||
| current_stage.name, | ||||||||
| current_stage.status, | ||||||||
| time.time() - start_time, | ||||||||
| ), | ||||||||
| ) | ||||||||
|
|
||||||||
| try: | ||||||||
| query_result = query_job.result( | ||||||||
| timeout=_PROGRESS_BAR_UPDATE_INTERVAL | ||||||||
| ) | ||||||||
| progress_bar.update(total) | ||||||||
| progress_bar.set_description( | ||||||||
| "Query complete after {:0.2f}s".format( | ||||||||
| time.time() - start_time | ||||||||
| ), | ||||||||
| ) | ||||||||
| break | ||||||||
| except concurrent.futures.TimeoutError: | ||||||||
| if current_stage.status == "COMPLETE": | ||||||||
| if i < total - 1: | ||||||||
| progress_bar.update(i + 1) | ||||||||
| i += 1 | ||||||||
| continue | ||||||||
|
|
||||||||
| else: | ||||||||
| query_result = query_job.result() | ||||||||
| progress_bar.set_description( | ||||||||
| "Query complete after {:0.2f}s".format(time.time() - start_time), | ||||||||
| ) | ||||||||
| progress_bar.update(1) | ||||||||
| progress_bar.close() | ||||||||
| else: | ||||||||
| query_result = query_job.result() | ||||||||
|
|
||||||||
| return query_result | ||||||||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want to use these helpers from other modules, let's remove the (redundant because of private module) leading
_.